API Reference

This is the documentation for the GoCardless API.

To get started with the API, check out our getting started guide, with copy and paste code samples in many popular languages guiding you through your integration from start to finish.

Live: https://api.gocardless.com/
Sandbox: https://api-sandbox.gocardless.com/
Authentication: Bearer token in the Authorization header.

Billing

Billing Request

Billing Request Flow

Billing Request Template

Billing Request With Action

Core

Creditor Bank Account

Customer Bank Account

Customer Notification

Bank Account Detail

Bank Details Lookup

Verification Detail

Payments

Instalment Schedule

Mandates

Mandate Import Entry

Transferred Mandate

Bank Redirect Authorisation

Bank Authorisation

Payouts & Accounts

Payment Account

Payment Account Transaction

Outbound Payment

Outbound Payment Import

Outbound Payment Import Entry

Bank Account Holder Verification

Funds Availability

Negative Balance Limit

Currency Exchange Rate

Configuration

Payer Authorisation

Scheme Identifier

Testing

Scenario Simulator