Sign in

v1

latestOpenAPI 3.0.12026-08-063289122.7 KB
Payments

Creating an authorization request for initiating payment.

post/v1/payments/{paymentId}/authorize

Path parameters

paymentIdstring required

Payment Request identifier

Headers

sessionIdstring uuid

The session identifier from authorization response

authorizationIdstring uuid

The Authorization identifier from authorization response.

Request body

qrCodeRequiredboolean

Set only when selected SCA method is decoupled and if want to generate QR code from the authorization response.

redirectUristring nullable

Mandatory if chosen PSU_REDIRECT authorization method. Customer will be redirected to this url after payment authorization is completed. Supports only HTTPS.

selectedScaMethod'PSU_DECOUPLED' | 'PSU_REDIRECT' required

Strong customer authentication methods.

Response

The request has been fulfilled and a payment is initiated.

idstring required

Payment identifier.

status'CREATED' | 'RECEIVED' | 'CANCELED' | 'FAILED' | 'REJECTED' | 'RECIPIENT_AUTHORIZATION_REQUIRED' | 'AUTHORIZATION_REQUIRED' | 'IN_PROGRESS_CODE' | 'IN_PROGRESS' | 'RECIPIENT_AUTHORIZED' | 'AUTHORIZED' | 'COMPLETED' | 'DELETED' required

Available payment statuses.

psuMessagestring nullable

Message for the PSU, included if an action needs to be taken by the user during a pending signing.

tppMessagesstring[] nullable

Message for the TPP, e.g. if an action needs to be taken by the user during a pending signing or an error message.