Skip to main content

Start payment authorisation

POST 
/v1/payment-service/payment-product/paymentId/authorisations

Description​

Initiate the authorisation process for a payment transaction.

tip

Trigger the authorisation flow, receive authentication methods and select a preferred authentication method before completing the transaction.

Request​

Path Parameters

    payment-service stringrequired

    The payment service that is used to initiate the payment.
    Available options: payments.

    payment-product stringrequired

    The addressed payment product endpoint, e.g., for SEPA Credit Transfers (SCT).
    Available options: internal-transfers, sepa-credit-transfers.

    paymentId stringrequired

    The unique ID of the payment to be authorised.

Header Parameters

    X-Request-ID uuidrequired

    ID of the request sent to the server, unique to the call, as determined by the initiating party.

    Certificate stringrequired

    The certificate used for signature verification.

    ClientId stringrequired

    The client ID associated with the request.

    Ocp-Apim-Subscription-Key stringrequired

    A unique identifier related to the registered merchant in the corresponding API environment, available within the application's details.

Responses​

Created
Schema
    scaStatus stringThe status of the Strong Customer Authentication (SCA) process.
    authorisationId stringThe ID of the authorisation process.
    scaMethods object[]The list of SCA methods.
  • Array [
    • authenticationType int32

    The authentication type of the SCA method.
    Possible values: 0 = "SMSOTP", 1 = "CHIPOTP", 2 = "PHOTOOTP", 3 = "PUSHOTP".

    authenticationVersion stringThe authentication version of the SCA method.
    authenticationMethodId stringThe authentication method ID of the SCA method.
    name stringThe name of the SCA method.
    explanation stringThe description of the SCA method.
  • ]
    • chosenScaMethod objectThe chosen SCA method.
    authenticationType int32

    The authentication type of the chosen SCA method.
    Possible values: 0 = "SMSOTP", 1 = "CHIPOTP", 2 = "PHOTOOTP", 3 = "PUSHOTP".

    authenticationVersion stringThe authentication version of the chosen SCA method.
    authenticationMethodId stringThe authentication method ID of the chosen SCA method.
    name stringThe name of the chosen SCA method.
    explanation stringThe description of the chosen SCA method.
    challengeData objectData related to the challenge for authorisation.
    image byteThe image of the challenge.
    data string[]The data of the challenge.
    imageLink stringThe link of the challenge.
    otpMaxLength int32The maximum length of the challenge.
    otpFormat int32

    The format of the challenge.
    Available options: 0 = "CHARACTERS", 1 = "INTEGER".

    additionalInformation stringAny additional information regarding the challenge.
    links objectAny links or references associated with the authorisation.
    psuMessage stringThe message for the PSU.
Loading...