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
Query parameters
pageintegerOptional
A page number within the paginated result set.
Responses
200Success
application/json
get
GET /v1/transaction/refund/ HTTP/1.1
Host:
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": "2025-07-18T20:59:40.081Z"
}
]
}
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
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /v1/transaction/refund/{id}/ HTTP/1.1
Host:
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": "2025-07-18T20:59:40.081Z"
}
Last updated