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

Query parameters

pageintegeroptional

A page number within the paginated result set.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/transaction/refund/' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "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",
      "payment_intent": "text",
      "gateway_id": "text",
      "created": "2025-04-03T09:46:10.210Z"
    }
  ]
}

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

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/transaction/refund/{id}/' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "amount": "text",
  "currency": "text",
  "payment": "123e4567-e89b-12d3-a456-426614174000",
  "payment_intent": "text",
  "gateway_id": "text",
  "created": "2025-04-03T09:46:10.210Z"
}