v1

latestOpenAPI 3.0.32026-07-2484569553.1 KB

Payments

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.

post/v3/payments/{id}/authorization-flow

Path parameters

idstring required

Unique ID for the Payment

Example:0afd1f6a-f611-48ce-9488-321129bb3a70

ID of the payment

Headers

Idempotency-Keystring

An idempotency key to allow safe retrying without the operation being performed multiple times. The value should be unique for each operation (we strongly advise to use a UUID v4), with the same key being sent on a retry of the same request.

Tl-Signaturestring

A JWS with detached content, signed with your private key. See Request Signing.

Required with a OAuth2 token.

X-Forwarded-Forstring

Used to collect and record end-user IP address. The first IP address in the list will be used as the end-user IP address.

X-Device-User-Agentstring

Used to improve the end-user's authentication experience based on their device type. If omitted, the User-Agent header will be used instead. This header is only considered if the authorization_flow object in the request body is specified.

Response

Payment