Get Settlement List
1 min
API that returns a list of settlements for the client. This API requires access token that can be generated using Access TokenAccess Token API.
A Settlement represents the final amount transferred to the client’s bank account for one or more completed crypto orders. Each settlement object includes the following fields :-
- settlementId: Unique ID of the Settlement.
- clientId : Client ID
- minOrderCreateTs: This is the created timestamp of the oldest order part of this settlement
- maxOrderCreateTs: This is the created timestamp of the most recent order part of this settlement
- 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.
- 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/list?settlementId={}&requestId={}>e=2024-07-15<e=2024-07-15
curl --location 'https://your-hostname.pay3.app/v1/client/exchange-settlement/list?settlementId={}&requestId={}&fromDate=2024-07-15&toDate=2024-07-15' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'client-id: zyx' \
--header 'access-token: ACCESS-TOKEN-IN-JWT'