GOgocardless
Bank Authorisation

Create a Bank Authorisation

Create a Bank Authorisation.

<p class="restricted-notice"><strong>Restricted</strong>: this endpoint is restricted as the authorisation must be used within a checkout flow that meets regulatory requirements for each payment scheme. Integrators should use a Billing Request Flow to do this.<br /><br /> If you would like to enable bank authorisations, you will need to go through a separate compliance process. For more details please <a href="mailto:help@gocardless.com">get in touch</a>.</p>
post/bank_authorisations

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Headers

GoCardless-Versionstring required

Request body

Example request

{
  "bank_authorisations": {
    "redirect_uri": "https://my-website.com/abc/callback",
    "links": {
      "billing_request": "BRQ123"
    }
  }
}

Response

Resource created successfully

Example response

{
  "bank_authorisations": {
    "id": "BAU123",
    "redirect_uri": "https://my-website.com/abc/callback",
    "url": "https://pay.gocardless.com/obauth/BAU123",
    "qr_code_url": "https://pay.gocardless.com/obauth/BAU123/qr_code",
    "last_visited_at": "2020-01-01T12:00:00.000Z",
    "authorised_at": "2020-01-01T12:00:00.000Z",
    "links": {
      "billing_request": "BRQ123",
      "institution": "monzo"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.