API Documentation

Get Order Details

1min

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

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

  1. orderId
  2. orderStatus : For list of possible status please refer : Fiat Order Status
  3. userAddress : User's email address
  4. updatedTs : Last Order updated timestamp in epoch milliseconds
  5. partner : Downstream partner ID
  6. orderType : Type of Order. Can be CHECKOUT/PAYOUT
  7. requestId : Unique ID passed during Order creation
  8. clientId : Client ID
  9. exchangeCurId : Name of the currency supported
  10. exchangeAmount : Currency Amount
  11. paymentMethod : Payment Method specified for Order
  12. 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 26 Jul 2024
Doc contributor
Did this page help you?
PREVIOUS
Get CryptoOrder Details
NEXT
Create Payout Order
Docs powered by Archbee