Get the details of your outbound payments#

To retrieve the details of a specific outbound payment, use the following API call.

GET https://api.gocardless.com/outbound_payments/{outbound_payment_id} HTTP/1.1
 
HTTP/1.1 200
Content-Type: application/json
{
    "outbound_payments": {
        "id": "OUT01JR7P5PKW3K7Q34CJAWC03E82",
        "created_at": "2024-11-28T22:51:46.129Z",
        "status": "pending",
        "reference": "GC-w2GJBgZkXU9opeB",
        "description": "My first payment",
        "scheme": "faster_payments",
        "amount": 100,
        "is_withdrawal": false,
        "execution_date": "2024-11-28",
        "metadata": null,
        "links": {
            "recipient_bank_account": "BA000123",
            "creditor": "CR0000123"
        },
        "verifications": {
            "recipient_bank_account_holder_verification": {
                "type": "confirmation_of_payee",
                "result": "full_match",
                "actual_account_name": null
            }
        }
    }
}

The next example demonstrates how to fetch a paginated list of outbound payments. Providing a time window (created_from – created_to) is mandatory and must not exceed one month.

GET https://api.gocardless.com/outbound_payments?created_from=2024-11-01&created_to=2024-11-30 HTTP/1.1
 
HTTP/1.1 200 OK
Content-Type: application/json
{
    "outbound_payments": [
        {
            "id": "OUT01JR7P5PKW3K7Q34CJAWC03E82",
            "created_at": "2024-11-28T22:51:46.129Z",
            "status": "pending",
            "reference": "GC-w2GJBgZkXU9opeB",
            "description": "My first payment",
            "scheme": "faster_payments",
            "amount": 100,
            "is_withdrawal": false,
            "execution_date": "2024-11-28",
            "metadata": null,
            "links": {
                "recipient_bank_account": "BA000123",
                "creditor": "CR0000123"
            },
            "verifications": {
                "recipient_bank_account_holder_verification": {
                    "type": "confirmation_of_payee",
                    "result": "full_match",
                    "actual_account_name": null
                }
            }
        }
    ],
    "meta": {
        "cursors": {
            "before": null,
            "after": null
        },
        "limit": 50
    }
}

Outbound payment status#

To track the processing stage of your outbound payment, refer to its status, which indicates the current step in the payment lifecycle.

Status	Description
`verifying`	Initial state. The payment has been created and verification is in progress. No action is required at this stage.
`pending_approval`	The payment is awaiting approval and cannot be scheduled without it.
`scheduled`	Verification and approval are complete, but processing has not yet begun. Future-dated payments remain here until their execution date arrives.
`executing`	The execution date has arrived and the payment has been queued for processing. Payments in this state can no longer be cancelled.
`executed`	The payment has been accepted by the scheme and is on its way to the recipient.
`failed`	The payment failed, usually due to an error while executing. In rare cases, a payment can fail after being executed if rejected by the recipient bank.
`cancelled`	The payment was cancelled — either via the cancel API, or because the merchant failed to approve or cancel it in time. Cancelled payments can no longer be approved or scheduled.

Staying up to date with events#

We generate events for every status change related to your outbound payments, except for the verifying and scheduled statuses. Events enable you to track the progress of your payments efficiently. You can learn more about events in the API Reference.

Each event also triggers a webhook, allowing you to receive real-time notifications whenever there's an update to your outbound payment. For more information on setting up webhooks, check out this guide.

What's next?#

Bank Account Holder Verification

Understand how Confirmation of Payee checks work and how to interpret verification results.

Learn more

Strong Customer Authentication

Learn how SCA works and which payments qualify for an exemption.

Learn more