API Documentation
English
English
  • Authorization
  • Request signing
  • List of error codes
  • Webhooks
  • IFrame order
  • Payment acceptance widget
  • Telegram MiniApp
  • API Reference
    • Base actions
      • Check x-api-signature
      • Fetch available currencies
      • Current price request
      • Search for operations by TX hash
      • Check address format
      • Get transaction history
    • Advanced account
      • Get advanced balances of user
      • Get advanced balance by id
      • Get payment address for advanced balance top-up
    • Blockchain addresses
      • Search by id
      • Transactions tracking
      • Search by address
      • Meta-data
      • Address Transactions
      • Last transaction of the address
      • Getting a list of PayIn addresses
      • Getting a list of business addresses
      • Get recurrent addresses
      • Getting a list of PayOut addresses
      • Creating a new business wallet address
      • Creating a new PayOut wallet address
    • Personal addresses
      • User creation
      • Getting an address
      • Getting a list of addresses
      • Get user
      • Adding a trusted address
      • Getting a list of trusted addresses
      • Deleting a trusted address
    • Orders
      • Creating an order
      • Getting information about an order
      • Getting a list of orders
    • Withdraws
      • Getting a commission for making a withdrawal
      • Sync withdraw
      • Async withdrawal
      • Receiving withdrawal information
    • Invoices
      • Create an invoice for payment
      • Invoice information request
      • Getting a list of invoices
    • Auto swaps
      • Create auto-swap
      • Find auto-swap by ID
    • Withdrawals 2.0
      • Create auto-withdrawal
      • Find auto-withdrawal by ID
      • Additional confirmation of the withdrawal
    • Bridge
      • Getting limits for cross-chain transfer
      • Getting information about cross-chain transfer
      • Commission token formation
      • Creating a cross-chain translation
    • Swaps
      • Getting limits for cross-chain exchange
      • Getting information about cross-chain exchange
      • Commission token formation
      • Creation of a cross-chain exchange
    • Recurring payments
      • Creating a payment link
      • Get a payment link
      • Get payment links by user
      • Disabling the payment link
      • Create a subscription
      • Getting a subscription
      • Cancel Subscription
      • Creating a payment
    • KYT
      • Check transaction risks
      • Check withdrawal risks
      • Check withdrawal risks for provided address
    • Partners API
      • Create user
      • Get user
      • Get all users
      • Creating an organization
      • Getting a list of organizations
      • Getting the user's advance balances
      • Replenishment of the user's advance balance
      • Get general tariffs
      • Create/update individual tariff
      • Get individual tariffs
      • Create API key
      • Get API keys
      • Delete API key
    • Webhooks
      • Get webhook
      • Get webhook (extended)
    • Orphan transactions
      • Get a transaction
      • Get a list of transactions
      • Get a commission token
      • Withdrawal
    • Address book
      • Add an address
      • Delete an address
      • Update the address
      • Get a list of addresses
Powered by GitBook
On this page
  • Possible statuses
  • Order lifetime
  • Lost transactions
  1. API Reference

Orders

This section describes methods for creating orders and obtaining order information

Orders functionality allows you to accept payments in a specified coin and network

Possible statuses

Status
Description

init

Order created

error

Error during creation or execution

processed

Successful order payment

pending

Upon receipt of the first payment

expired

Order lifetime expired

partial

The warrant expired, but was partially paid

overpaid

The order was paid in excess of the specified amount

When the status changes or a new transaction arrives, you will be sent a webhook to the URL specified when creating the order.

More information about webhooks can be found in the Webhooks section

Attention

Please note that the statuses processed, expired, partial, overpaid ** are not final**

When processing a webhook, you should separately process the array of received transactions to correctly process the payment amount

Order lifetime

When creating an order, selects an address from the pool of PAY_IN addresses of the organization. This address will not be available for other transactions during the entire life of the order.

Depending on the payment network, the minimum and maximum lifetime of an order may vary.

Minimum and maximum values for networks:

Network
Minimum value
Maximum value

ton

1800

43200

bitcoin

7200

43200

bitcoincash

7200

43200

bsc

1800

43200

tron

1800

43200

ethereum

1800

43200

fantom

1800

43200

litecoin

3600

43200

Lost transactions

In some cases, the payer may send to a coin address on another network or coin. Such transactions will be displayed in a separate orphanDeposits field when receiving a webhook or receiving order information via API.

You can see these transactions in your personal account in the Payments -> Orphan Transactions section. In this section, withdrawal of these coins to a third-party address will be available.

PreviousDeleting a trusted addressNextCreating an order

Last updated 7 months ago