Get Settlement Details
1 min
API that returns settlement details for a client’s crypto orders.This API requires access token that can be generated using Access TokenAccess Token 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.
- settlementId: Unique ID of the Settlement.
- clientId : Client ID
- status : Status of the settlement. Possible values are CREATED, PROCESSING, COMPLETED, FAILED, REJECTED.
- fiatCurrencyId : Currency in which the settlement was transferred to the client’s bank account. Example: aed_ae.
- grossAmount: Total settlement amount
- transferFee: Bank transfer fee deducted from the settlement amount. This will be 0 if no bank fee was applied.
- netReceivedAmount : Final amount received in the client’s bank account after applicable bank transfer fees.
- transferReferenceId: Bank transfer reference ID for the settlement.
- transferTriggeredTs:Timestamp at which the settlement bank transfer was initiated.
- destinationBankDetails: This object contains details of client's bank account to which transfer was made.
- orderList: List of crypto orders included in the settlement.
- errorReason : Contains errorCode and errorDesc. Will be received only in case if status is FAILED. List of possible SDK Errors
Get Settlement Details
Get order details by client's request-id
GET
https://your-hostname.pay3.app/v1/client/exchange-settlement/{settlementId}
curl --location 'https://your-hostname.pay3.app/v1/client/exchange-settlement/{settlementId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'client-id: abc' \
--header 'access-token: ACCESS-TOKEN-IN-JWT'