Get the details of your outbound payments
To retrieve the details of a specific outbound payment, you can use the following API call.
1GET https://api.gocardless.com/outbound_payments/{outbound_paiment_id} HTTP/1.1
2
3HTTP/1.1 200
4Content-Type: application/json
5{
6 "outbound_payments": {
7 "id": "OUT01JR7P5PKW3K7Q34CJAWC03E82",
8 "created_at": "2024-11-28T22:51:46.129Z",
9 "status": "pending",
10 "reference": "GC-w2GJBgZkXU9opeB",
11 "description": "My first payment",
12 "scheme": "faster_payments",
13 "amount": 100,
14 "is_withdrawal": false,
15 "execution_date": "2024-11-28",
16 "metadata": null,
17 "links": {
18 "recipient_bank_account": "BA000123",
19 "creditor": "CR0000123"
20 },
21 "verifications": {
22 "recipient_bank_account_holder_verification": {
23 "type": "confirmation_of_payee",
24 "result": "full_match",
25 "actual_account_name": null
26 },
27 }
28 }
29}The next example demonstrates how to fetch a paginated list of your outbound payments. Please note that providing a time window (created_from - created_to) is mandatory and should not exceed one month.
1GET https://api.gocardless.com/outbound_payments/created_from=2024-11-01&created_to=2024-11-30 HTTP/1.1
2
3HTTP/1.1 200 OK
4Content-Type: application/json
5{
6 "outbound_payments": [
7 {
8 "id": "OUT01JR7P5PKW3K7Q34CJAWC03E82",
9 "created_at": "2024-11-28T22:51:46.129Z",
10 "status": "pending",
11 "reference": "GC-w2GJBgZkXU9opeB",
12 "description": "My first payment",
13 "scheme": "faster_payments",
14 "amount": 100,
15 "is_withdrawal": false,
16 "execution_date": "2024-11-28",
17 "metadata": null,
18 "links": {
19 "recipient_bank_account": "BA000123",
20 "creditor": "CR0000123"
21 },
22 "verifications": {
23 "recipient_bank_account_holder_verification": {
24 "type": "confirmation_of_payee",
25 "result": "full_match",
26 "actual_account_name": null
27 },
28 }
29 }
30 ],
31 "meta": {
32 "cursors": {
33 "before": null,
34 "after": null
35 },
36 "limit": 50
37 }
38}Outbound Payment Status
To track the processing stage of your outbound payment, you can refer to its status, which indicates the current step in the payment lifecycle. The status is included in the responses of the API when retrieving details for a single outbound payment or when listing multiple outbound payments. Understanding the status helps you monitor progress and identify any potential issues with your outbound payment.
Status | Description |
|---|---|
verifying | This is the initial state of newly created outbound payments. It indicates that the payment has been created and the verification process has begun. No action is required at this stage. |
pending_approval | The outbound payment is awaiting approval. The outbound payment cannot be scheduled without an approval. |
scheduled | The outbound payment has been created and passed verification & approval, but processing has not yet begun. Future-dated outbound payments will remain in this state until their execution date arrives. |
executing | A provisional status indicating that the execution date has arrived, and the outbound payment has been placed in the queue for processing. Executing outbound payments can no longer be cancelled. |
executed | The outbound payment has been accepted by the schemes and is now on its way to the recipient. |
failed | This state indicates that the outbound payment , usually due to an error while “executing”. In rare cases, a payment can fail some time after it is “executed”, due to it being rejected by the recipient bank. |
cancelled | The outbound payment has been cancelled, typically triggered by the "Cancel an outbound payment" API call, or if the merchant failed to approve or cancel the outbound payment in time. Cancelled outbound payments can no longer be approved nor scheduled for execution. |
Stay tuned
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 here.
Additionally, each event triggers a webhook, allowing you to receive real-time notifications from us whenever there’s an update to your outbound payment. This enables you to take automated actions in response. For more information on setting up webhooks, check out this guide.
The failed even webhooks include a "cause" to help identify the reason for failure. More detailed descriptions for these are available in the API Reference.