Get refunds

Refunds Endpoint

get

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

/refund

Retrieve the details of all your Refunds 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 code.

paymentMethodstring · max: 2Optional

Payment Method code.

statusstring · enumOptional

Transaction status.

Possible values:

Responses

200

A paginated list of refunds.

application/json

412

Precondition Failed - Date period must be smaller than 60 days.

application/json

get

/refund

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "amount": 200,
      "beneficiary": "Iliana De Ghana Test",
      "cpf": "10131292323",
      "bankName": "AGRICULTURAL DEVELOPMENT BANK",
      "branchNumber": "12345",
      "refundCurrency": "GHS",
      "bankAccount": "123456789012",
      "accountType": "CHECKING",
      "comments": "test test test",
      "id": 1004190,
      "idBoleto": 301363698,
      "idMerchant": 4,
      "date": "2024-05-21T19:44:34Z",
      "lastChangeDate": "2024-05-21T19:44:34Z",
      "country": "GH",
      "paymentMethod": "MMY",
      "status": "PENDING",
      "amountType": "TOTAL",
      "merchantName": "Merchant Test prueba TEST 2",
      "bankCode": "2",
      "type": "DEPOSIT",
      "apiVersion": "API_V3",
      "documentType": "ID",
      "allowPixApiRefund": false
    },
    {
      "amount": 41,
      "refundCurrency": "BRL",
      "comments": "Payment not found",
      "id": 1004189,
      "idBoleto": 301360916,
      "idMerchant": 4,
      "date": "2024-05-21T19:42:08Z",
      "lastChangeDate": "2024-05-21T19:42:08Z",
      "country": "BR",
      "paymentMethod": "MC",
      "status": "REJECTED",
      "amountType": "TOTAL",
      "merchantName": "Merchant Test prueba TEST 2",
      "type": "DEPOSIT",
      "apiVersion": "API_V3",
      "allowPixApiRefund": false
    }
  ],
  "page": 0,
  "rows": 2,
  "maxRows": 50
}