Refunds

Refund objects represent your customer's refunded transactions. You can use them in conjunction with Payments to reconcile transactions and handle specific logic.

Get all refunds

This method retrieves a list of all refunded transactions.

get

Authorizations

tokenAuthjwtAuth

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

pageintegerOptional

A page number within the paginated result set.

Responses

200Success

application/json

countintegerRequiredExample: 123

nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?page=2

get/v1/transaction/refund/

HTTPcURLJavaScriptPython

GET /v1/transaction/refund/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": "text",
      "currency": "text",
      "payment": "123e4567-e89b-12d3-a456-426614174000",
      "gateway_id": "text",
      "created": "2026-07-20T14:18:59.829Z"
    }
  ]
}

Get refund

This method fetches detailed information about a specific refunded transaction using its unique identifier, allowing you to retrieve the amount, and other relevant details for that refund.

get

Authorizations

tokenAuthjwtAuth

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idstringRequired

Responses

200Success

application/json

idstring · uuidRead-onlyRequired

amountstring · decimalRequiredPattern: ^-?\d{0,6}(?:\.\d{0,2})?$

currencystringRead-onlyRequired

paymentstring · uuidRequired

gateway_idstring · max: 255Required

createdstring · date-timeRead-onlyRequired

get/v1/transaction/refund/{id}/

HTTPcURLJavaScriptPython

GET /v1/transaction/refund/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "amount": "text",
  "currency": "text",
  "payment": "123e4567-e89b-12d3-a456-426614174000",
  "gateway_id": "text",
  "created": "2026-07-20T14:18:59.829Z"
}