Get settlements

Settlements Endpoint

get

https://merchants-api.onekeypayments.com/v1https://merchants-api-stg.onekeypayments.com/v1

/settlements

Retrieve the details of all your Settlements in a given time.

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

fromintegerOptional

Transaction creation date interval in UnixTimeStamp format.

tointegerOptional

Transaction creation date interval in Unix TimeStamp format, max difference with 'from' value 60 days.

pageintegerOptional

The page number.

Default: 0

statusstring · enumOptional

Transaction status.

Possible values:

Responses

200

A paginated list of settlements.

application/json

get

/settlements

HTTPcURLJavaScriptPython

GET /v1/settlements HTTP/1.1
Host: merchants-api.onekeypayments.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

A paginated list of settlements.

{
  "data": [
    {
      "id": 3329,
      "creationDate": "2020-01-06T00:00:00Z",
      "type": "MANUAL",
      "currency": "USD",
      "requestedAmount": 50000,
      "fee": 250,
      "amountToTransfer": 49750,
      "status": "PENDING",
      "idMerchant": 4,
      "merchantName": "Merchant Test"
    },
    {
      "id": 3328,
      "creationDate": "2019-12-13T00:00:00Z",
      "type": "MANUAL",
      "currency": "USD",
      "requestedAmount": 1000000,
      "fee": 0,
      "amountToTransfer": 1000000,
      "status": "PENDING",
      "idMerchant": 4,
      "merchantName": "Merchant Test"
    }
  ],
  "page": 0,
  "rows": 2,
  "maxRows": 50
}