Skip to main content

Authorise consent

POST 
/v2/consents/confirmation-of-funds/consentId/authorisations

Description​

Initiate the authorisation process of confirming funds related to a specific consent.

tip

Trigger the necessary steps to complete the authorization flow and obtain relevant challenge data and authentication methods.

Request​

Path Parameters

    consentId stringrequired

    The unique identifier for the consent being authorised.

Header Parameters

    X-Request-ID uuidrequired

    The ID of the request, 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.

    PSU_ID stringrequired

    The PSU's ID, as determined by the PSU. This ID is the identification of the PSU within the ASPSP and contains the username that requests the consent or initiates the payment.

    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 string

    The status of the Strong Customer Authentication (SCA) process.

    authorisationId string

    The unique ID of the authorisation.

    scaMethods object[]The available Strong Customer Authentication (SCA) methods for the consent authorisation.
  • Array [
    • authenticationType int32

    The type of authentication method to use with the SCA method.
    Available options:
    0 = "SMSOTP", 1 = "CHIPOTP", 2 = "PHOTOOTP", 3 = "PUSHOTP".

    authenticationVersion stringThe version of the authentication method to use with the SCA method.
    authenticationMethodId stringThe ID of the authentication method to use with the SCA method.
    name stringThe name of the SCA method.
    explanation stringThe description of the SCA method.
  • ]
    • chosenScaMethod objectThe selected Strong Customer Authentication (SCA) method for the consent authorisation.
    authenticationType int32

    The type of authentication method to use with the SCA method.
    Available options:
    0 = "SMSOTP", 1 = "CHIPOTP", 2 = "PHOTOOTP", 3 = "PUSHOTP".

    authenticationVersion stringThe version of the authentication method to use with the SCA method.
    authenticationMethodId stringThe ID of the authentication method to use with the SCA method.
    name stringThe name of the SCA method.
    explanation stringThe description of the SCA method.
    challengeData objectThe data related to the challenge presented during the authorisation process.
    image byteThe image associated with the consent authorisation process.
    data string[]The information related to the consent authorisation process.
    imageLink stringThe URL link to the image associated with the consent authorisation.
    otpMaxLength int32The maximum length allowed for the one-time password (OTP) during the authorisation process.
    otpFormat int32

    The One Time Password (OTP) required for authorisation, with values indicating character or integer format:
    Available options: 0 = "CHARACTERS", 1 = "INTEGER".

    additionalInformation stringAny additional information relevant to the consent authorisation process.
    links objectLinks to additional resources for the consent authorisation.
    psuMessage string

    The message for the payment service user (PSU) during the authorisation.

Loading...