Get deposits

Deposits Endpoint

get

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

/deposits

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

Authorizations

bearerAuthcookieAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

fromintegerOptional

Transaction creation date interval in Unix TimeStamp 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.

paymentMethodstring · max: 2Optional

Payment Method code.

statusstring · enumOptional

Transaction's status.

Possible values:

clientDocumentstringOptional

The customer's document.

Responses

200

A paginated list of deposits.

application/json

get

/deposits

HTTPcURLJavaScriptPython

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

200

A paginated list of deposits.

{
  "page": 0,
  "rows": 2,
  "maxRows": 50,
  "data": [
    {
      "idDeposit": 301164223,
      "externalId": "MP_689da0bb343f4bd9ac1da111db351e9b",
      "creationDate": "2024-01-10T13:41:57Z",
      "countryName": "Brazil",
      "country": "BR",
      "paymentMethodName": "Pix",
      "paymentMethodCode": "IX",
      "requestedPaymentMethod": "IX",
      "requestedPaymentMethodName": "Pix",
      "clientDocument": "123456789",
      "amount": 10,
      "currency": "USD",
      "requestedAmount": 10,
      "requestedCurrency": "USD",
      "localAmount": 51.45,
      "localCurrency": "BRL",
      "fee": 0,
      "feeCurrency": "USD",
      "lastChangeDate": "2024-01-10T13:41:58Z",
      "status": "PENDING",
      "idUser": "50097755",
      "flags": [],
      "idMerchant": 12345,
      "merchantName": "Merchant Name",
      "refundAttempted": false
    }
  ]
}