API Developers

Getting Started

• Introduction to the GoCardless API
• Making your first request
• Adding your first customer
• Taking your first payment
• What's next?
• Our client libraries

See all 11 articles

Adding Customers

• Importing mandates from another provider
• Custom payment pages
• Adding metadata to a customer created via the Redirect Flow
• Process for mandates requiring dual signatures
• Supporting multiple Direct Debit schemes through the API

Subscriptions

• Guide to using subscriptions through the API
• Creating a subscription
• Updating a subscription amount
• Will cancelling a subscription also cancel any created payments?

Payments

• How to handle late failures
• How to handle chargebacks
• Payment references
• VAT on fees

Webhooks / Events

• Guide to using events / webhooks
• Webhook retries / failures
• Metadata in webhooks

Developer Tools

• Scenario simulators
• Test webhooks
• Test bank details

Error Messages

• Handling error messages
• PHP client library: "One of your parameters was incorrectly typed”
• Error 403: Access Denied/Forbidden

FAQs

• Can I reset my sandbox account?
• Do I need to use HTTPS/SSL?
• Where do I find the request ID?
• Why can't I use plans in the API?

Partner resources

• Updated guide to building a Partner integration
• Pre-filling the GoCardless hosted payment pages
• Partners hosting their own custom payment pages
• Dynamically redirecting merchants after OAuth exchange
• Dynamic partner webhook URIs
• Enabling merchants to collect payments across multiple currencies

See all 7 articles

Upgrading your legacy integration

• Benefits of upgrading
• Overview of changes
• Guide to upgrading
• Mapping legacy webhooks in the new API