GOgocardless
Payment

List payments

Returns a cursor-paginated list of your payments.

get/payments

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.

currency'AUD' | 'CAD' | 'DKK' | 'EUR' | 'GBP' | 'NZD' | 'SEK' | 'USD'

ISO 4217 currency code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.

Example:EUR
gtstring date

Limit to records where the payment was or will be collected from the customer's bank account after the specified date.

ltstring date

Limit to records where the payment was or will be collected from the customer's bank account before the specified date.

gtestring date

Limit to records where the payment was or will be collected from the customer's bank account on or after the specified date.

ltestring date

Limit to records where the payment was or will be collected from the customer's bank account on or before the specified date.

customerstring

ID of a customer to filter payments by. If you pass this parameter, you cannot also pass creditor.

Example:CU123
sort_field'charge_date' | 'amount'

Field by which to sort records. One of:

  • charge_date
  • amount
sort_direction'asc' | 'desc'

The direction to sort in. One of:

  • asc
  • desc
creditorstring

ID of a creditor to filter payments by. If you pass this parameter, you cannot also pass customer.

Example:CR123
subscriptionstring

Unique identifier, beginning with "SB".

Example:SB123
mandatestring

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

Example:MD123
status'pending_customer_approval' | 'pending_submission' | 'submitted' | 'confirmed' | 'paid_out' | 'cancelled' | 'customer_approval_denied' | 'failed' | 'charged_back'

One of:

  • pending_customer_approval: we're waiting for the customer to approve this payment
  • pending_submission: the payment has been created, but not yet submitted to the banks
  • submitted: the payment has been submitted to the banks
  • confirmed: the payment has been confirmed as collected
  • paid_out: the payment has been included in a payout
  • cancelled: the payment has been cancelled
  • customer_approval_denied: the customer has denied approval for the payment. You should contact the customer directly
  • failed: the payment failed to be processed. Note that payments can fail after being confirmed if the failure message is sent late by the banks.
  • charged_back: the payment has been charged back
Example:submitted
schemestring nullable

A bank payment scheme. Currently "ach", "autogiro", "bacs", "becs", "becs_nz", "betalingsservice", "faster_payments", "pad", "pay_to", "sepa_core", "sepa_credit_transfer" and "sepa_instant_credit_transfer" are supported.

Example:bacs
includestring

Includes linked resources in the response. Use customer to embed customer details, or mandate to embed mandate details.

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "payments": [
    {
      "id": "PM123",
      "created_at": "2014-01-01T12:00:00.000Z",
      "amount": 1000,
      "amount_refunded": 150,
      "currency": "EUR",
      "description": "One-off upgrade fee",
      "charge_date": "2014-05-21",
      "reference": "WINEBOX001",
      "status": "submitted",
      "app_fee": 100,
      "links": {
        "mandate": "MD123",
        "creditor": "CR123",
        "payout": "PO123",
        "subscription": "SU123",
        "instalment_schedule": "IS123"
      },
      "fx": {
        "exchange_rate": "1.1234567890",
        "estimated_exchange_rate": "1.1234567890",
        "fx_currency": "EUR"
      },
      "scheme": "bacs"
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

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