GOgocardless
Payout

List payouts

Returns a cursor-paginated list of your payouts.

get/payouts

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.

creditorstring

Unique identifier, beginning with "CR".

Example:CR123
creditor_bank_accountstring

Unique identifier, beginning with "BA".

Example:BA123
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
status'pending' | 'paid' | 'bounced'

One of:

  • pending: the payout has been created, but not yet sent to your bank or it is in the process of being exchanged through our FX provider.
  • paid: the payout has been sent to the your bank. FX payouts will become paid after we emit the fx_rate_confirmed webhook.
  • bounced: the payout bounced when sent, the payout can be retried.
Example:pending
referencestring

Reference which appears on the creditor's bank statement.

Example:ref-1
payout_type'merchant' | 'partner'

Whether a payout contains merchant revenue or partner fees.

Example:merchant
metadataPayoutMetadata

Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters. Note: This should not be used for storing PII data.

{
  "salesforce_id": "ABCD1234"
}

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "payouts": [
    {
      "id": "PO123",
      "created_at": "2014-01-01T12:00:00.000Z",
      "amount": 1000,
      "deducted_fees": 20,
      "currency": "EUR",
      "reference": "ref-1",
      "status": "pending",
      "payout_type": "merchant",
      "arrival_date": "2014-01-01",
      "links": {
        "creditor": "CR123",
        "creditor_bank_account": "BA123"
      },
      "fx": {
        "exchange_rate": "1.1234567890",
        "estimated_exchange_rate": "1.1234567890",
        "fx_currency": "EUR"
      },
      "tax_currency": "EUR",
      "metadata": {
        "salesforce_id": "ABCD1234"
      }
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

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