Variable Recurring Payments

Billing Request Actions

Whenever you create a Billing Request, it will have a list of actions that require completion before it’s possible to fulfil the request.

The possible actions are:

• choose_currency: have the payer choose from a list of supported currencies

• collect_customer_details: collect customer details required for the schemes

• select_institution: collect customer bank institution

• collect_bank_account: create the bank account for the mandate/payment

• bank_authorisation: have the payer authorise the billing request via their bank if required

• confirm_payer_details: confirm customer and bank account details provided by the payer

Once all required actions have been completed, the Billing Request will become ready_to_fulfil, and an integrator can use the fulfil action to create all associated resources.

Which actions should I implement?

Even if integrators complete a selection of actions themselves, Billing Request Flows can be used to complete the remaining actions.

Our recommendations for whether integrators should implement each action are:

• choose_currency: implement this if you want to allow the payer to have the ability to choose a different currency, and you support more than 1 currency.

• collect_customer_details: implement this if you want a white label flow to collect customer details or have already collected the details (pre-filling, etc)

• select_institution: implement this to allow the payer to select their bank institution, this is required before a bank authorisation can be created.

• collect_bank_account: as with customer details, but be aware that Billing Request Flows can avoid this step for certain schemes which can improve conversion by reducing the number of details a payer has to manually input.

• confirm_payer_details: as part of scheme compliance, it is a requirement to allow the payer to crosscheck the details entered by them and confirm them.

• bank_authorisation: can be handled via the Billing Request Flow, but if the custom payment pages - bank authorisation upgrade is enabled on your account, the bank_authorisation endpoint can be used.

The actions presented on a Billing Request are unordered, but each action may have dependencies, or have other actions depending on it.

These are specified in the fields completes_actions and requires_actions.

Taking a bank_authorisation as an example:

Action status is either pending or completed.

requires_actions: Actions can only be executed if the actions listed in requires_action have been completed- in this example, we can’t complete the bank authorisation until we’ve collected the bank.

completes_actions: Actions can complete other actions, which can help streamline checkout flows. The example shows how a bank authorisation might collect customer details, completing that action as a side effect.

For most integrators, we suggest building flows that process actions in the order of:

1. choose_currency, optional first step as a change in scheme can dictate what customer contact details we collect

2. collect_customer_details, so customer contact details are prioritised

3. collect_bank_account, if it is required and another action won’t complete it

4. select_institution, if it is required and another action won’t complete it

5. bank_authorisation, as the penultimate step before completing the checkout flow

6. confirm_payer_details, only applicable if it is a mandate_request

Action: collect_customer_details 

Billing Requests aim to create billing resources against a customer, either a mandate (Direct Debit, PayTo or VRPs), an Instant Bank Payment, or both.

Payment schemes vary in what customer details you are required to collect. The collect_customer_details action is about collecting all the details required by either the mandate or the payment scheme, to ensure we meet regulatory needs.

As an example, we can create a Billing Request for a GBP mandate:

This returns a Billing Request that looks like this:

Note that:

• There is a collect_customer_details action, which is pending

• A new customer has been created for us, as the Billing Request wasn’t attached to an existing customer

• The customer and customer_billing_detail resources are presented back to us, and they have no filled fields

The collect_customer_details action is designed to help us collect the required information from our customers.

Taking a closer look at the action:

The collect_customer_details.incomplete_fields object tells us what fields we need to collect, for both resources. Which fields are required changes depending on the schemes of the mandate (or payment).

We can complete this action by POST’ing to the Collect customer details for the billing request endpoint:

As with all action endpoints, the response is the Billing Request. What we get back is:

Note that:

• The collect_customer_details action is now completed, meaning we can move on to other actions

• As a result of us collecting the details, our customer and customer_billing_detail has been populated with the details we collected

Most integrators will collect these details via web forms, filled by their payers. Integrators are expected to build forms that can collect all possible customer and customer_billing_detail fields (see the Collect customer details schema) but only display the inputs required, as per incomplete_fields.

Depending on the scheme, we might need to collect bank account details before fulfilling the Billing Request. An example is a VRPs mandate, where we need to capture the payer’s bank in order to create payments against them.

As an example, we have a Billing Request which requires collect_bank_account:

Note that:

• There is a collect_bank_account action that is pending

• We have no links.customer_bank_account, confirming no bank account is attached

We can complete this action by POST’ing to the Collect bank account for the billing request endpoint:

As with all action endpoints, the response is the Billing Request. What we get back is:

Note that:

• The collect_bank_account action is now completed, meaning we can move on to other actions

• As a result of us collecting the bank account, we have created a customer_bank_account resource and you can see the links.customer_bank_account ID has been set

We advise most integrators use Billing Request Flows to complete this action, as the hosted flows will try skipping this action if it can be fulfilled by another (such as bank authorisation).

The select institution action ensures an institution resource is attached to the Billing Request. An institution is required to create a bank authorisation (next step). If GoCardless is able to guess the customer's institution from their bank account this will make this step optional.

Integrators should present a list of institutions to the payer, which they can populate from the List Institutions for Billing Request endpoint:

Which responds with the institutions that GoCardless supports for bank authorisation:

Call Select Institutions for Billing Request endpoint once the payer has selected their institution.

As with all action endpoints, the response is the Billing Request. What we get back is:

As part of scheme compliance, we need to ensure the payer was presented with a confirmation screen before fulfilling the Billing Request. All mandate requests will require this action.

As an example, we can create a Billing Request for a GBP mandate:

This returns a Billing Request that looks like this:

Note that:

• There is a confirm_payer_details action that is pending

• The action is required- all mandate requests will require this

• The action requires collect_customer_details and collect_bank_account, as we can only show the confirmation page once these actions are completed.

We can complete this action by POST’ing to the confirm payer details endpoint:

As with all action endpoints, the response is the Billing Request. What we get back is:

Note that:

• The confirm_payer_details action is now completed, and the billing request will change status to ready_to_fulfil.

• This Billing Request can now be fulfilled by POST'ing to the Fulfil a Billing Request Endpoint

We advise most integrators to use Billing Request Flows to complete this action, as information presented in the confirmation screen changes depending on the scheme.

One of the most complex actions, bank_authorisation means the payer needs to log in to their bank to authorise the Billing Request. All Open Banking schemes will require this action, while bank debit requests may offer an optional bank_authorisation (coming soon!).

If an integrator has white-labelled the other actions, they should create a Billing Request Flow to handle the bank_authorisation, as we have invested significant time to optimise the flow.

As an example, the Billing Request response will have a required action for bank_authorisation:

Note that:

• There is a bank_authorisation action which is pending

• The action is required - all requests for IBP & VRPs will require bank authorisation

• The action requires collect_bank_account and select_institution, as we can only authorise the payment after we have collected both the institution and the bank details.

Once all dependent required actions are completed, we can generate an authorisation using the Create a Bank Authorisation endpoint:

This request will contact the payers bank directly. It is worth noting that banks have varying reliability for open-banking requests, and this request may fail due to the retail bank being unavailable.

If successful, we’ll respond with:

Payers will be redirected to the url in this response, which will open the payer’s bank login screen. If opened on a mobile with the retail bank app installed, it’s possible the payer will jump straight into the app to authorise the payment.

Alternatively, you can provide the QR code image provided in the qr_code_url in your application to allow payers to go seamlessly from desktop to their mobile banking app like this: <img src="https://pay-staging.gocardless.com/obauth/BAU123/qr_code">

The bank authorisation is queryable, and will be updated once the payer authorises/denies the request. Integrators should have their checkout flows poll the Get a Bank Authorisation endpoint until the authorised_at timestamp is set.

Once the authorisation is complete, the Billing Request will update to mark the action as completed:

Preventing Breaking changes

In order to automatically receive new features and always remain scheme compliant without having to change your integration, GoCardless will need to adjust actions by adding new actions or making optional actions required. This means it will break your integration if you don’t fall back to Billing Request Flow. Therefore if you are building custom payment pages you needs to Implement the actions you are aware of and want to process.