GOgocardless
Outbound Payment

List outbound payments

Returns a cursor-paginated list of outbound payments.

get/outbound_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.

created_fromstring
Example:2024-01-01

The beginning of query period

created_tostring
Example:2024-01-01

The end of query period

status'verifying' | 'pending_approval' | 'scheduled' | 'executing' | 'executed' | 'cancelled' | 'failed'

One of:

  • verifying: The payment has been created and the verification process has begun.
  • pending_approval: The payment is awaiting approval.
  • scheduled: The payment has passed verification & approval, but processing has not yet begun.
  • executing: The execution date has arrived and the payment has been placed in queue for processing.
  • executed: The payment has been accepted by the scheme and is now on its way to the recipient.
  • cancelled: The payment has been cancelled or was not approved on time.
  • failed: The payment was not sent, usually due to an error while or after executing.
Example:cancelled

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "outbound_payments": [
    {
      "id": "OUT123",
      "created_at": "2024-01-01T12:00:00.001Z",
      "status": "cancelled",
      "amount": 1000,
      "scheme": "faster_payments",
      "currency": "GBP",
      "execution_date": "2024-08-31",
      "description": "Reward Payment (August 2024)",
      "reference": "GC-QC2FI7GBEW7VCXL",
      "is_withdrawal": true,
      "links": {
        "creditor": "CR123",
        "customer": "CU123",
        "recipient_bank_account": "BA123",
        "outbound_payment_import": "IM123"
      },
      "verifications": {
        "recipient_bank_account_holder_verification": {
          "type": "confirmation_of_payee",
          "result": "partial_match",
          "actual_account_name": "Jo Doe"
        }
      }
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

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