Skip to main content

Create consent

POST 
/v2/consents/confirmation-of-funds

Description​

Generate a consent that defines access rights to specific accounts for a given PSU_ID.

tip

Control access to dedicated accounts and manage recurring access permissions effectively.

Request​

Header Parameters

    X-Request-ID uuidrequired

    The unique request identifier associated with the consent.

    Certificate stringrequired

    The certificate used for signature verification.

    ClientId stringrequired

    The client ID associated with the request.

    PSU_ID stringrequired

    The Personalized Security User Identification linked to the consent. 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.

Body parameters

    account object

    Information regarding the account involved in the transaction.

    iban stringrequired

    The International Bank Account Number (IBAN) for the transaction.

    bban stringrequired

    The Basic Bank Account Number (IBAN) for the transaction.

    pan stringrequired

    The Primary Account Number (IBAN) for the transaction.

    maskedPan stringrequired

    The partially masked PAN for the transaction.

    msisdn stringrequired

    The Mobile Station International Subscriber Directory Number (MSISDN) for the transaction.

    currency stringrequired

    The currency in which the transaction is being processed.

    cardNumber stringrequired

    The card number linked to the transaction.

    cardExpiryDate date-timerequired

    The expiration date of the card used in the transaction.

    cardInformation stringrequired

    Information related to the card used in the transaction.

    registrationInformation stringrequired

    Information regarding the registration process for the transaction.

Responses​

Created
Schema
    consentStatus int32

    The status of the consent. Available options:
    0 = "received"
    1 = "rejected"
    2 = "valid"
    3 = "revokedByPsu"
    4 = "expired"
    5 = "terminatedByTpp"

    consentId stringThe unique identifier for the consent associated with the consent.
    scaMethods object[]The list of available SCA methods.
  • Array [
    • authenticationType int32

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

    authenticationVersion stringThe version of authentication being used for the SCA method.
    authenticationMethodId stringThe identification number of the SCA method.
    name stringThe name of the SCA method.
    explanation stringThe description of the SCA method.
  • ]
    • chosenScaMethod objectThe Strong Customer Authentication (SCA) method chosen for the consent.
    authenticationType int32

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

    authenticationVersion stringThe version of the authentication method.
    authenticationMethodId stringThe unique identifier of the authentication method.
    name stringThe name of the authentication method.
    explanation stringA detailed explanation or reason related to the consent.
    challengeData objectThe data related to any challenge presented during the consent process.
    image byteAn image associated with the consent.
    data string[]General data associated with the consent.
    imageLink stringThe link to the image associated with the consent.
    otpMaxLength int32The maximum length of the one-time password (OTP) for the consent.
    otpFormat int32

    The format in which the one-time password (OTP) is presented.
    Available options: 0 = "CHARACTERS", 1 = "INTEGER".

    additionalInformation stringAny additional or relevant information pertaining to the consent.
    links objectThe links to other resources related to the consent.
    message stringA message or information related to the consent request.
Loading...