Skip to main content
GET
/
consumers
/
{consumer_id}
/
payment
/
refunds
Retrieve all refunds
curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/payment/refunds \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "source_ref": {
        "id": "<string>",
        "model": "<string>"
      },
      "status": "pending",
      "description": "<string>",
      "amount": 123,
      "currency": "<string>",
      "refund_date": "2023-11-07T05:31:56Z",
      "payment_id": "<string>"
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2
}

Authorizations

​
Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

​
consumer_id
string<uuid>
required

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100
​
payment_id
string | null

Optional payment ID, to retrieve all refunds associated with that payment.

​
date_from
string<date> | null
​
date_to
string<date> | null

Response

Successful Response

​
items
RefundItemOut · object[]
required
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
size
integer
required
Required range: x >= 1