Start authorization flow

📘

Endpoint path changes

All Payments API v3 endpoints now start with /v3/. The old endpoints still work, but you must use the new path for all new integrations.

Alternative method to start authorisation flow

For single payments (which have a payment_method.type of bank_transfer), you can start the authorisation flow without this endpoint.

To do so, include the authorization_flow parameter when you create a payment through the /v3/payments endpoint. You should include each object within the parameter if your authorisation UI is capable of rendering it and you want the user to be able to complete the action.


Path Params
string
required
Body Params
provider_selection
object
scheme_selection
object
redirect
object
form
object
consent
object
user_account_selection
object
Headers
string
string
string
string
string
enum
Defaults to application/json; charset=UTF-8
Allowed:
Responses

Language
Credentials
URL
Response
Choose an example:
application/json; charset=UTF-8
application/problem+json; charset=UTF-8