Skip to main content
GET
/
v1
/
refunds
ListRefunds
curl --request GET \
  --url https://api.toffeepay.com/v1/refunds \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "payment_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "reason": "<string>",
    "succeeded_at": "2023-11-07T05:31:56Z",
    "failed_at": "2023-11-07T05:31:56Z",
    "cancelled_at": "2023-11-07T05:31:56Z",
    "error": {
      "code": "<string>",
      "message": "<string>"
    }
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
payment_id
string
​
status
enum<string>
Available options:
pending,
succeeded,
failed,
cancelled
​
limit
integer<int32>

default: 100

Required range: x <= 250
​
offset
integer<int32>
Required range: x >= 0

Response

200 - application/json

Success

​
id
string
required
​
payment_id
string
required
​
status
enum<string>
required
Available options:
pending,
succeeded,
failed,
cancelled
​
created_at
string<date-time>
required
​
reason
string | null
​
succeeded_at
string<date-time> | null
​
failed_at
string<date-time> | null
​
cancelled_at
string<date-time> | null
​
error
Error · object

Error handling