Start authorization flow

Start the authorization flow for a payment.

This API can be called:

  • using the resource_token associated with the payment you are trying to fetch;
  • using a backend bearer token.


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.