Check transaction status
GET /order/v1/order/{id}
You can check the transaction status at any time.
NOTE: Please, to authenticate use the scope: “api://app-order-prd”
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Responses
Section titled “ Responses ”The resource was returned successfully
object
The id of the order of which to retrieve the details.
Example
de05f0db-e6a3-462e-8f1c-8dc8dd07c278The idempotency key of the order.
Example
de05f0db-e6a3-462e-8f1c-8dc8dd07c278Order id in your system.
Example
order_id_in_your_systemOrder status.
Example
PAIDThe customer info.
object
The name of the customer, e.g.: [John Doe] or [Acme Corporation].
Example
John DoeThe e-mail address of the Customer.
Example
John.doe@acme.comThe type of the Customer.
Example
INDIVIDUALThe document of the Customer.
object
Type of document, used when providing an ID number.
----------------------------
Brasil
----------------------------
CPF
CNPJ
OTHERS
----------------------------
Mexico
----------------------------
CURP,
RFC
Example
CPFThe number in the document.
Example
81985010020Amount of the order
object
Currency
Example
BRLThe amount of the transaction, in minor units. Minor Units Format ------------------ All amount values must be formatted in that currency’s smallest unit. Two-decimal currency (for example Real): R$ 10,95 BRL, amount will be “10.95”. Two-decimal currency (for example US Dollars): $10.95 USD, amount will be “10.95”. Zero-decimal currency (for example Japanese Yen): ¥1095 JPY, amount will be “1095”. Click here to download the latest official ISO 4217 Currency Table, with Minor Units (number of decimal places) per currency
Example
10.95Amount of the order
object
Currency
Example
BRLThe amount of the transaction, in minor units. Minor Units Format ------------------ All amount values must be formatted in that currency’s smallest unit. Two-decimal currency (for example Real): R$ 10,95 BRL, amount will be “10.95”. Two-decimal currency (for example US Dollars): $10.95 USD, amount will be “10.95”. Zero-decimal currency (for example Japanese Yen): ¥1095 JPY, amount will be “1095”. Click here to download the latest official ISO 4217 Currency Table, with Minor Units (number of decimal places) per currency
Example
10.95The date the order was created.
Example
2022-12-17T11:35:01.045ZThe date the order was paid.
Example
2022-12-17T11:35:51.923ZThe date the order was refunded.
Example
2022-12-18T112:33:00.287ZThe date the order was expired.
Example
2022-12-18T112:33:00.287ZThe date the order was compensated.
Example
2022-12-18T112:33:00.287ZThe date the order was settled.
Example
2022-12-18T112:33:00.287ZPayment method.
Example
BINANCE_PAYThe payment info.
object
The id of the order of which to retrieve the details.
Example
f103c839-6a95-42cb-a889-371bbe540d3fLink image qrCode.
Example
https://public.bnbstatic.com/static/payment/20221217/cf16107e-cb98-4dca-9dcb-1ce2aa814057.jpgData of qrcode.
Example
https://dependable-viability.infoBase64 of image qrCode.
Example
/9j/4AAQ8DaxNqel3eoyzy27W7LdSIy7SytkbUU5yg7+td9QAUUUUAFFFFABRRRQAooooAKKKKACiiigD/2Q==Deeplink to open binance app to payment.
Example
bnc://app.binance.com/payment/secpay?tempToken=R1iUiVRLcMXPboLsiU8KkLytFgUI40MA&returnLink=https://pay.binance.com/en/checkout/bcba8fa221cf4aea9f2822a8865ed1ceUniversal url to finish the payment.
Example
https://app.binance.com/payment/secpay?linkToken=a0f04c0786464e818d13c3c16efec196&_dp=Ym5jOi8vYXBwLmJpbmFuY2UuY29tL3BheW1lbnQvc2VjcGF5P3RlbXBUb2tlbj1GR3FNRE10bDJaNGFkMzlsN0J1VjU5Zm9qYTNHalMxNyZyZXR1cm5MaW5rPWh0dHBzOi8vcGF5LmJpbmFuY2UuY29tL2VuL2NoZWNrb3V0L2EwZjA0YzA3ODY0NjRlODE4ZDEzYzNjMTZlZmVjMTk2The URL for order return after payment Done
Example
http://www.yourwebsite.com/payment_doneThe barcode of Boleto
QrCode expiration DateTime
The digitable line of Boleto
Payment token used by the payment provider.
Aditional fee
Example
2022-12-17T11:35:01.045ZFixed fee
Example
2022-12-17T11:35:01.045ZVariable fee
Example
2022-12-17T11:35:01.045ZAmount with tax
The financial Partner of the order.
The date the order was canceled
Example
2022-12-18T112:33:00.287ZThe error message of the order.
The owner information.
PS: This field is optional, not all payment methods have this information.object
The name of the owner.
Example
John DoeThe document of the owner.
Example
12345678901The bank information of owner.
object
The bank name.
Example
Financial BankThe bank ISPB code.
Example
00123876The bank code, like COMPE.
Example
123The account number.
Example
12345-2The branch account number.
Example
0001The pix.
object
The type of pix
Example
CPFThe key of pix
Example
1234567890The payer information.
PS: This field is optional, not all payment methods have this information.object
Payer name
Example
John DoePayer document
object
The type of document
Example
CPFThe number of document
Example
12345678901Payer bank data
object
Bank ISPB number
Example
12345678Bank name
Example
Bank nameBank branch account number
Example
1234Bank account number
Example
123456Bank account type
Example
CHECKING_ACCOUNTBank code (COMPE)
Example
341Bank pix data
object
The type of pix
Example
CPFThe key of pix
Example
1234567890Batch information when this order was split into a batch
object
Id of the batch
Example
5160c73e-8b9b-4f1f-8c64-0edcbb97c335Total number of child transactions in the batch
Example
3Number of child transactions already paid
Example
2Number of child transactions that failed
Example
1Number of child transactions still pending
Amount already paid across all child transactions
Example
30000.00Amount still pending across all child transactions
Example
15000.00Child transactions the batch was split into
object
Id of this child transaction
Example
a4cf980e-f66d-4321-b0f2-95c7eecca7ceIdempotency key of this child transaction - the first child reuses the batch idempotencyKey verbatim, later ones suffix it
Example
bf8b0b1f-f444-40c5-b657-d236ee03e6ba-01Ordering position of this child transaction within the batch
Example
1Amount of this child transaction
Example
15000.00Status of this child transaction
Example
PAIDEnd-to-end id of this child transaction
Example
E69467793202607101200Je8IkFT5JQSDate this child transaction was paid
Example
2026-07-10T12:01:03.000ZError message when this child transaction failed
Example
An unexpected error occurredThe request is not valid
Unauthorized Request
Resource not found
An unexpected error occurred inside the server