This article assumes that you currently have an integration with our Legacy API.
If you don't have an existing integration or if you're using our current API then this article won't apply to you - you can view our current API documentation here.
Authorisations > Mandates
Authorisations are now mandates. Mandates are far more flexible - you can create one off payments or subscriptions against the same mandate, and mandates can have multiple subscriptions against them. There is no need for the customer to re-authorise any new payments or subscriptions on a mandate.
Bills > Payments
Our Legacy API offered the ability to create one-off bills, or a series of one-off bills, on a pre-authorisation. Bills are now called payments, and a payment can either be created as a one-off or as part of a subscription.
Previously, you'd need to build an authorisation link for either a one-off payment, pre-authorisation or subscription.
Now there's just the one Redirect Flow. Using the Redirect Flow will allow you to send your customers to the GoCardless payment pages, and then back to your website to complete the flow. In return you'll receive a customer ID, customer bank account ID, and mandate ID. You'll then just need the mandate ID to create a payment or subscription for the customer.
Events and Webhooks
Our Legacy API sent webhooks about the status of a bill, pre-authorisation or subscription. Our new API creates events for a number of actions on all resources - whether they were created through the API or the Dashboard. These Events can be queried via the Events endpoint or sent as a webhook to your integration.
Our new API still allows you to query the payouts you receive from GoCardless. In addition, we've added some steps to help you reconcile payouts with Events, meaning you'll be able to get a list of payments in a specific payout through the API.
Making requests to the API
The endpoints for our new API are different and making requests has changed slightly, but don't worry these are fully explained in our developer documentation.