GoCardlessDeveloper Docs
Create a sandbox account

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
12 endpoints
Billing Request Flow
2 endpoints
Billing Request Template
4 endpoints
Billing Request With Action
1 endpoint
Core
Creditor
4 endpoints
Creditor Bank Account
4 endpoints
Customer
5 endpoints
Customer Bank Account
5 endpoints
Customer Notification
1 endpoint
Event
2 endpoints
Webhook
3 endpoints
Payments
Payment
6 endpoints
Refund
4 endpoints
Payout
3 endpoints
Payout Item
1 endpoint
Instalment Schedule
5 endpoints
Subscription
7 endpoints
Tax Rate
2 endpoints
Mandates
Mandate
6 endpoints
Mandate Import
4 endpoints
Mandate Import Entry
2 endpoints
Mandate Pdf
1 endpoint
Transferred Mandate
1 endpoint
Redirect Flow
3 endpoints
Banking
Balance
1 endpoint
Bank Account Detail
1 endpoint
Bank Account Holder Verification
2 endpoints
Bank Authorisation
2 endpoints
Bank Details Lookup
1 endpoint
Institution
2 endpoints
Verification Detail
2 endpoints
Payouts & Accounts
Payment Account
2 endpoints
Payment Account Transaction
2 endpoints
Outbound Payment
8 endpoints
Outbound Payment Import
3 endpoints
Outbound Payment Import Entry
1 endpoint
Funds Availability
1 endpoint
Negative Balance Limit
1 endpoint
Currency Exchange Rate
1 endpoint
Configuration
Block
6 endpoints
Logo
1 endpoint
Payer Authorisation
5 endpoints
Payer Theme
1 endpoint
Scheme Identifier
3 endpoints
Export
2 endpoints
Testing
Scenario Simulator
1 endpoint
SupportDashboard