List Refunds
GET {{url}}/refunds
Returns a cursor-paginated list of your refunds.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
after | null | Cursor pointing to the start of the desired set. | |
before | null | Cursor pointing to the end of the desired set. | |
created_at[gt] | null | Limit to records created after the specified date-time. | |
created_at[gte] | null | Limit to records created on or after the specified date-time. | |
created_at[lt] | null | Limit to records created before the specified date-time. | |
created_at[lte] | null | Limit to records created on or before the specified date-time. | |
limit | null | Number of records to return. | |
mandate | null | Unique identifier, beginning with “MD”. Note that this prefix may not apply to mandates created before 2016. | |
payment | null | Unique identifier, beginning with “PM”. | |
refund_type | null | Whether a refund was issued against a mandate or a payment. One of: | |
| payment: default returns refunds created against payments only |
mandate: returns refunds created against mandates only |
RESPONSES
status: OK
{"refunds":[{"id":"RF00006WH7E0ZW","amount":99570,"created_at":"2024-02-29T16:15:50.817Z","reference":"all","metadata":{},"currency":"GBP","status":"paid","fx":{"fx_currency":null,"fx_amount":null,"exchange_rate":null,"estimated_exchange_rate":null},"links":{"payment":"PM009DBTMPXV6N","mandate":"MD000Z4AQ9G168"}},{"id":"RF00006M66RKXF","amount":10000,"created_at":"2023-12-01T11:10:39.111Z","reference":"Test","metadata":{},"currency":"GBP","status":"paid","fx":{"fx_currency":null,"fx_amount":null,"exchange_rate":null,"estimated_exchange_rate":null},"links":{"payment":"PM008QMJS3MQYW","mandate":"MD000T26GECNGF"}},{"id":"RF00005WNNNV9P","amount":9856,"created_at":"2023-05-05T09:03:07.751Z","reference":"Test","metadata":{},"currency":"GBP","status":"paid","fx":{"fx_currency":null,"fx_amount":null,"exchange_rate":null,"estimated_exchange_rate":null},"links":{"payment":"PM00780CPN9J90","mandate":"MD000R3V6899RP"}}],"meta":{"cursors":{"before":null,"after":null},"limit":50}}