Get cashouts

Cashouts Endpoint

get

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

/cashouts

Retrieve the details of all your Cashouts 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

countrystring · max: 2Optional

Country's code.

statusstring · enumOptional

Transaction status.

Possible values:

clientDocumentstringOptional

The customer's document.

Responses

200

A paginated list of cashouts.

application/json

get

/cashouts

HTTPcURLJavaScriptPython

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

200

A paginated list of cashouts.

{
  "page": 0,
  "rows": 1,
  "maxRows": 50,
  "data": [
    {
      "idCashout": 1770,
      "externalId": "test123",
      "creationDate": "2020-01-24T18:17:55Z",
      "country": "BR",
      "currency": "USD",
      "amount": 200,
      "creditedCurrency": "USD",
      "creditedAmount": 0,
      "merchantCurrency": "USD",
      "merchantAmount": 0,
      "feeCurrency": "USD",
      "fee": 0,
      "tax": 0,
      "lastChangeDate": "2020-01-24T18:17:55Z",
      "status": "PENDING",
      "clientDocument": "12345678901",
      "flags": [],
      "idMerchant": 4,
      "merchantName": "Merchant Test",
      "reason": "",
      "existVoucher": false
    }
  ]
}