HomeDocumentationAPI referenceSDKsGuidesPartnerships
HomeDocumentationAPI referenceSDKsGuidesPartnerships
  • API Reference
    • Introduction
  • Checkout API Reference
LogoLogo
API ReferenceRefunds

List Refunds

GET
/v1/refunds/
GET
/v1/refunds/
1curl https://api.yoco.com/v1/refunds/ \
2     -H "Authorization: Bearer <token>"
Try it
200Retrieved
1{
2  "data": [
3    {
4      "created_at": "2024-11-19T15:27:02+00:00",
5      "currency": "ZAR",
6      "display_name": "Refund receipt #491352",
7      "id": "1732188199292-2a8752ab-db45-4507-9d85-fcc6049beef3",
8      "note": "This is a note on this refund.",
9      "order_id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d",
10      "order_number": "string",
11      "original_order_id": "1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d",
12      "original_order_number": "10542623",
13      "payment_id": "1732194482873-c777dc85-035e-40de-9820-765fde5ded7b",
14      "payment_method": "card",
15      "processed_at": "2024-11-20T16:27:23+00:00",
16      "processing_fees": [
17        {
18          "amount": {
19            "amount": 27800,
20            "currency": "ZAR"
21          },
22          "type": "initial"
23        }
24      ],
25      "receipt_number": "491352",
26      "refund_type": "auth_reversal",
27      "refunded_processing_fees": [
28        {
29          "amount": {
30            "amount": 27800,
31            "currency": "ZAR"
32          },
33          "type": "initial"
34        }
35      ],
36      "status": "approved",
37      "total_amount": {
38        "amount": 4500,
39        "currency": "ZAR"
40      },
41      "updated_at": "2024-11-19T16:27:23+00:00"
42    }
43  ],
44  "next_cursor": "1323935095007282836"
45}
List refunds **Required OAuth 2.0 scope: `business/orders:read`**
Was this page helpful?
Previous

Create Web Pos Device

Next
Built with
Create Web Pos Device

Authentication

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

Query parameters

cursorstring or nullOptional>=1 character<=255 characters
A pagination cursor from where results should start being fetched.
limitintegerOptional>=1<=100Defaults to 50
The maximum number of results to return.
created_at__gtestring or nullOptionalformat: "date-time"
The min refund created date and time in ISO 8601 format.
The min refund created date and time in ISO 8601 format.
created_at__ltestring or nullOptionalformat: "date-time"
The max refund created date and time in ISO 8601 format.
updated_at__gtestring or nullOptionalformat: "date-time"
The min refund updated date and time in ISO 8601 format.
updated_at__ltestring or nullOptionalformat: "date-time"
The max refund updated date and time in ISO 8601 format.
statuslist of enums or nullOptional
A list of statuses to filter on.
Allowed values:

Response

Successful Response
datalist of objects
A list of paginated entities.
next_cursorstring or null
A pagination cursor that can be used to retrieve the next set of results.

Errors

A pagination cursor from where results should start being fetched.
The maximum number of results to return.

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

List refunds

Required OAuth 2.0 scope: business/orders:read