API Documentation

Get CryptoOrder Details

1min

API that returns clients crypto orders matching the requestId. This api requires access token that can be generated using Access Token API.

The response is a list of Crypto Orders which matches the given criteria.

  1. orderId
  2. orderStatus : For list of possible status please refer : Crypto Order Status
  3. updatedTs : Last Order updated timestamp in epoch milliseconds
  4. orderType : Type of Order. Can be CHECKOUT/PAYOUT
  5. requestId : Unique ID passed during Order creation
  6. clientId : Client ID
  7. paymentStatus : For list of possible payment status please refer: Payment Status
  8. receivedAmount : Actual amount received in supported currency
  9. payersEmail : Email of the user
  10. settlementStatus: Status of the settlement
  11. txnHash: On-Chain transaction hash
    
  12. cryptoCurId : Name of the currency supported
  13. cryptoAmount : Currency Amount
  14. errorReason : Contains errorCode and errorDesc. Will be received only in case if status is FAILED. List of possible Error Codes
Get order details by client's request-id
GET
Request
Query Parameters
requestId
required
String
Request Id is the unique id that was passed by your application while creating the order.
clientId
required
String
Client Id
Header Parameters
access-token
required
String
Access token received from Access token API. You can reuse the access token across multiple API calls till it is expired.




Updated 14 Nov 2024
Doc contributor
Did this page help you?
PREVIOUS
Access Token
NEXT
Get Order Details
Docs powered by Archbee