GOgocardless
Refund

List refunds

Returns a cursor-paginated list of your refunds.

get/refunds

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Query parameters

beforestring nullable

Cursor pointing to the end of the desired set.

afterstring nullable

Cursor pointing to the start of the desired set.

integer
OR
string

Number of records to return.

gtstring date-time

Limit to records created after the specified date-time.

ltstring date-time

Limit to records created before the specified date-time.

gtestring date-time

Limit to records created on or after the specified date-time.

ltestring date-time

Limit to records created on or before the specified date-time.

paymentstring

Unique identifier, beginning with "PM".

Example:PM123
mandatestring

Unique identifier, beginning with "MD". Note that this prefix may not apply to mandates created before 2016.

Example:MD123
refund_type'mandate' | 'payment'

Whether a refund was issued against a mandate or a payment. One of:

  • payment: <em>default</em> returns refunds created against payments only
  • mandate: returns refunds created against mandates only
Example:payment

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "refunds": [
    {
      "id": "RF123",
      "created_at": "2014-01-01T12:00:00.000Z",
      "amount": 150,
      "currency": "EUR",
      "status": "submitted",
      "reference": "WINEBOX001",
      "links": {
        "payment": "PM123",
        "mandate": "MD123"
      },
      "fx": {
        "exchange_rate": "1.1234567890",
        "estimated_exchange_rate": "1.1234567890",
        "fx_currency": "EUR"
      }
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.