GC Logo Dark
Developer Docs

Guides

Bank Payments
Overview
Setting up mandatesDirect Debit Mandates Verified Mandates PayTo Agreements and Payments Build a client to create mandates offline Supporting mandates set up outside of your product Importing Mandates Blocking mandates
One-off paymentsTaking an Instant Bank Payment Taking a one off payment
Recurring paymentsTaking Subscription payments Taking Instalment payments Variable Recurring Payments
Combining one-off and recurring paymentsTake a first Instant Payment with mandate
 set up
Responding to eventsResponding to Mandate Events Responding to Billing Requests Events
FX Payments Reconciling Payouts ACH and PAD Consent Types
Send money
Introduction to Outbound Payments Payment Account API request signing
Send an outbound paymentAdding a new recipient Initiate an outbound payment Approve an outbound payment Cancel an outbound payment
Tracking outbound payments Bank Account Holder Verification Strong Customer Authentication
Optimise and increase revenue
Prevent fraud with Protect+ Retain customers with fallbacks Reduced failed payments with Success+
Prefill customer detailsNew customer record Existing customer record Populate Billing Request Flow
Tutorials
Taking Direct Debit payments using Billing Requests and Custom Payment Pages Handling tax Handling Customer Notifications
GoCardless Embed
Introduction Creating a creditor Adding a creditor bank account OptionalSetting a scheme identifer Optional
Setting up mandates / collecting paymentsBilling Request with Actions: Setting up a Direct Debit mandate Collecting a Direct Debit payment Billing Request with Actions: Taking an Instant Bank Payment Billing Request with Actions Dual Flow: Taking an Instant Bank Payment and setting up a Direct Debit mandate
Handling webhooks
Reconciling payoutsPayout Items API Automated Payout Reporting Optional
Setting Up Branding OptionalAPI request signing OptionalBank Details Access Optional
Bank Account Data
Overview Quickstart Guide Endpoints Bank Selection UI Sandbox Statuses and Error code Output: Account Details Output: Balances Output: Transaction Details Postman Collection FAQs

GoCardless Embed

Automated Payout Reporting

Automated Payout Reporting means GoCardless will automatically generate a daily payout report for all your creditors, accessible to you in a single comprehensive report.

GoCardless will generate a csv report for each currency you receive payouts in. The report will contain all the payouts you have received the previous business day (in UTC timezone), including any refunds, chargebacks or late failures incurred. More details on this format are in the reconciling payouts section of our docs.

If you require more historical information or reports that aggregate payouts across wider time frames you can generate manual payout reconciliation reports via the dashboard using the payout reconciliation button and exporting the transactions.

Getting your automated reports

In this step of the GoCardless Embed guide, you will use GoCardless’ APIs to retrieve the payout reports and download them to be consumed in your own reconciliation flows.

Using the Exports API

GET /exports

You can retrieve the list of exports available for download by performing a GET request to the /exports endpoint. Exports are available for download for up to 3 days after they are generated, after which they will no longer be available.

1GET https://api.gocardless.com/exports HTTP/1.1 2 3HTTP/1.1 200 OK 4Content-Type: application/json 5{ 6"exports": [ 7 { 8 "id": "EX123", 9 "created_at": "2014-01-01T12:00:00.000Z", 10 "export_type": "payout_transactions_reconciliation", 11 "currency": "GBP" 12 }, 13 { 14 "id": "EX456", 15 "created_at": "2014-01-01T12:00:00.000Z", 16 "export_type": "payout_transactions_reconciliation", 17 "currency": "EUR" 18 } 19 ] 20}

GET /exports/EX123

To download an export, you can retrieve the download URL by performing a GET request to the /exports/EX123 endpoint, providing the export ID as a path parameter. Once a download_url is generated, the link is accessible for up to 1 hour before it expires.

1GET https://api.gocardless.com/exports/EX123 HTTP/1.1 2 3HTTP/1.1 200 OK 4Content-Type: application/json 5{ 6 "exports": { 7 "id": "EX123", 8 "created_at": "2014-01-01T12:00:00.000Z", 9 "export_type": "payout_transactions_reconciliation", 10 "download_url": "https://downloads.gocardless.com/EX123/example.csv", 11 "currency": "GBP" 12 } 13}

Examples of how to make these request using the GoCardless client libraries:

For more details, see the API reference docs for Exports.

Need help?
Connect as a partner