Some customers may not be able to authorise the open banking transaction through the Billing Request Flow. This may happen if they are unable to use their mobile, they aren’t set up with online banking or the bank’s open banking API may be down.

To retain these customers and let them pay another way, you may pass an Exit URI which will send them wherever you choose in order to complete the transaction. It’s as simple as providing the address you’d like us to return the customer to.

Provide an Exit URI when creating the Billing Request Flow

You may pass an exit_uri when creating the Billing Request Flow, the same way you pass the redirect_uri.

Note: We recommend that you return customers to your checkout page, at the point of choosing payment method.

POST /billing_request_flows
{
  "billing_request_flows": {
    "redirect_uri": "https://my-company.com/completed",
    "exit_uri": "https://my-company.com/exited",
    "links": {
      "billing_request": "BRQ123"
    }
  }
}

This returns a new flow which includes the exit_uri being passed:

{
  "billing_request_flows": {
    "authorisation_url": "https://pay.gocardless.com/flow/static/billing_request?id=<br_id>",
    "lock_customer_details": false,
    "lock_bank_account": false,
    "auto_fulfil": true,
    "created_at": "2022-01-05T16:23:10.679Z",
    "expires_at": "2022-01-12T16:23:10.679Z",
    "redirect_uri": "https://my-company.com/completed",
    "exit_uri": "https://my-company.com/exited",
    "links": {
      "billing_request": "BRQ123"
    }
  }
}

Customers will be sent to this address, when they click on the Exit URL in the Billing Request Flow.

Customer uses the Exit URL to return to your checkout

The Exit URI is used in two places:

  1. Instant Bank Pay for British customers
  2. Instant Bank Pay for German customers

Instant Bank Pay in the UK

The Exit URL is shown if a customer is unable to find their bank, when searching the institution selector.

Exit URI in IBP in UK

Instant Bank Pay in Germany

The Exit URL is shown if a customer provides an IBAN which isn’t supported.

Exit URI in IBP in Germany