---
title: Get Settlement Details
slug: get-settlement-details
docTags: 
createdAt: 2025-05-02T10:40:00.252Z
---

API that returns settlement details for a client’s crypto orders.This API requires access token that can be generated using [Access Token](docId\:HcCaKrQI4shqRFFPCBoiR) API.

A Settlement represents the consolidation of one or more completed crypto orders based on the agreed settlement cycle (e.g., daily, weekly, or any other agreed frequency). It includes the total order value and, once processed, the corresponding bank transfer details for the settlement.

1. `settlementId`: Unique ID of the Settlement.
2. `clientId` : Client ID
3. `status` : Status of the settlement. Possible values are `CREATED`, `PROCESSING`, `COMPLETED`, `FAILED`, `REJECTED`.
4. `fiatCurrencyId` : Currency in which the settlement was transferred to the client’s bank account. Example: `aed_ae`.
5. `grossAmount`: Total settlement amount
6. `transferFee`: Bank transfer fee deducted from the settlement amount. This will be `0` if no bank fee was applied.
7. `netReceivedAmount` : Final amount received in the client’s bank account after applicable bank transfer fees.
8. `transferReferenceId`: Bank transfer reference ID for the settlement.
9. `transferTriggeredTs`:Timestamp at which the settlement bank transfer was initiated.
10. `destinationBankDetails`: This object contains details of client's bank account to which transfer was made.
11. `orderList`: List of crypto orders included in the settlement.
12. `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 Settlement Details",
  "method": "GET",
  "url": "https://your-hostname.pay3.app/v1/client/exchange-settlement/{settlementId}",
  "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/exchange-settlement/{settlementId}' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--header 'client-id: abc' \\\n--header 'access-token: ACCESS-TOKEN-IN-JWT'",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "3LjxGJCqZzKeICMDOi23s"
  },
  "results": {
    "languages": [
      {
        "id": "GC_lbEEV7Jo_hgFNI1cHK",
        "language": "200",
        "code": "{\n    \"settlementId\": \"1724681\",\n    \"clientId\": \"abc\",\n    \"status\": \"\", // CREATED, PROCESSING, COMPLETED, FAILED, REJECTED\n    \"fiatCurrencyId\": \"aed_ae\", // fiat currency id \n    \"transferFee\": \"\", \n    \"netReceivedAmount\": \"\",\n    \"grossAmount\" : \" \",\n    \"transferReferenceId\": \"\",\n    \"transferTriggeredTs\": \"\",\n    \"destinationBankDetails\" : {\n       \"accountNumber\": \"\",\n        \"bankName\": \"\",\n        \"bankCode\": \"\"\n    },\n    \"orderList\": [\n        {\n            \"requestId\": \"nlnwevw_5e449b97\",\n            \"orderId\": \"5616750d-4829-4099-aacb-16deadf36cde\",\n            \"orderStatus\": \"COMPLETED\",\n            \"createdTs\": \"2024-09-02T10:20:31.603Z\",\n            \"orderType\": \"CryptoPayin\",\n            \"clientId\": \"abc\",\n            \"paymentStatus\": \"COMPLETED\",\n            \"receivedAmount\": \"1.36\",\n            \"userId\": \"satoshi@email.com\",\n            \"txnHash\": \"08930348ce4d928694889a\",\n            \"cryptoCurId\": \"usdc_ethereum\",\n            \"cryptoAmount\": \"1.36\",\n            \"fiatCurrencyId\": \"aed_ae\",\n            \"fiatAmount\": \"5.00\"\n        },\n        {\n            \"requestId\": \"ntfytcv_5e44945\",\n            \"orderId\": \"7862550d-4829-4099-aacb-16deadf36cde\",\n            \"orderStatus\": \"COMPLETED\",\n            \"createdTs\": \"2024-09-02T10:20:31.603Z\",\n            \"orderType\": \"CryptoPayin\",\n            \"clientId\": \"abc\",\n            \"paymentStatus\": \"COMPLETED\",\n            \"receivedAmount\": \"1.36\",\n            \"userId\": \"satoshi@email.com\",\n            \"txnHash\": \"08930348ce4d928694889a\",\n            \"cryptoCurId\": \"usdc_ethereum\",\n            \"cryptoAmount\": \"1.36\",\n            \"fiatCurrencyId\": \"aed_ae\",\n            \"fiatAmount\": \"5.00\"\n        }\n    ]\n}",
        "customLabel": ""
      },
      {
        "id": "Ybev9LI4TwGz-n2zW-919",
        "language": "401",
        "code": "{\"error\":\"Client verification failed\"}",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "GC_lbEEV7Jo_hgFNI1cHK"
  },
  "request": {
    "pathParameters": [],
    "queryParameters": [
      {
        "name": "settlementId",
        "kind": "required",
        "type": "string",
        "description": "Unique ID of the Settlement.",
        "": "Unique ID of the Settlement."
      }
    ],
    "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": []
      },
      {
        "name": "clientId",
        "kind": "required",
        "type": "string",
        "description": "Client Id",
        "": "Client Id"
      }
    ],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Header Parameter",
    "value": "headerParameters"
  },
  "hasTryItOut": false,
  "autoGeneratedAnchorSlug": "get-settlement-details",
  "legacyHash": "bC0S3Ivb8tGBpktWYLZnA"
}
```
:::

***