---
title: Get Crypto Order Details
slug: crypto/get-crypto-order-details
docTags: 
createdAt: 2025-05-02T10:40:00.252Z
---

API that returns clients crypto orders matching the *requestId*. This API requires access token that can be generated using [Access Token](docId\:HcCaKrQI4shqRFFPCBoiR) 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 : [Order Status](docId\:zrZwEJX2fU4croVOWvGWN) 
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](docId\:zrZwEJX2fU4croVOWvGWN)  
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 [SDK Errors](docId:94KYVQwbRSg1DFMLjddbS) 

:::ApiMethodV2
```json
{
  "name": "Get Order Details",
  "method": "GET",
  "url": "https://your-hostname.pay3.app/v1/client/crypto-orders?requestId=your-request-id&clientId=your-client-id",
  "description": "Get order details by client's request-id",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "3LjxGJCqZzKeICMDOi23s",
        "language": "curl",
        "code": "curl --location 'https://your-hostname.pay3.app/v1/client/crypto-orders?requestId=your-request-id&clientId=your-client-id' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--header 'access-token: ACCESS-TOKEN-IN-JWT'",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "3LjxGJCqZzKeICMDOi23s"
  },
  "results": {
    "languages": [
      {
        "id": "GC_lbEEV7Jo_hgFNI1cHK",
        "language": "200",
        "customLabel": "",
        "code": "{\n    \"data\": [\n        {\n            \"orderId\": \"5616750d-4829-4099-aacb-16deadf36cde\",\n            \"orderStatus\": \"COMPLETED\",\n            \"updatedTs\": 1725261631603,\n            \"orderType\": \"CryptoPayin\",\n            \"requestId\": \"nlnwevw_5e449b97\",\n            \"clientId\": \"5e449b97-c53b-4ed0-ac00-7b50e2f2406b\",\n            \"paymentStatus\": \"COMPLETED\",\n            \"receivedAmount\": \"0.00018900\",\n            \"payersEmail\": \"satoshi@email.com\",\n            \"settlementStatus\": \"NOT_REQUIRED\",\n            \"txnHash\": \"08930348ce4d928694889a\",\n            \"cryptoCurId\": \"btc_bitcoin\",\n            \"cryptoAmount\": \"0.000173\",\n            \"errorReason\": {\n                \"errorCode\": \"9004\",\n                \"errorDesc\": \"Error occurred while the payment was processed by the payment partner\"\n            }\n        }\n    ]\n}"
      },
      {
        "id": "Ybev9LI4TwGz-n2zW-919",
        "language": "401",
        "customLabel": "",
        "code": "{\"error\":\"Client verification failed\"}"
      }
    ],
    "selectedLanguageId": "GC_lbEEV7Jo_hgFNI1cHK"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [
      {
        "name": "requestId",
        "kind": "required",
        "type": "string",
        "description": "Request Id is the unique id that was passed by your application while creating the order.",
        "children": []
      },
      {
        "name": "clientId",
        "kind": "required",
        "type": "string",
        "description": "Client Id",
        "children": []
      }
    ],
    "headerParameters": [
      {
        "name": "access-token",
        "kind": "required",
        "type": "string",
        "description": "Access token received from Access token API. You can reuse the access token across multiple API calls till it is expired.",
        "children": []
      }
    ],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Header Parameter",
    "value": "headerParameters"
  },
  "hasTryItOut": false,
  "autoGeneratedAnchorSlug": "get-order-details",
  "legacyHash": "S47PRCosdcg6c9bw46JEG"
}
```
:::

***