Skip to main content

Fetch consent details

GET 
/v1/consents/consentId

Description​

Retrieve detailed information about a specific consent.

tip

Access account details, balances and transactions authorised by a specific consent.

Request​

Path Parameters

    consentId stringrequired

    The ID of the consent as returned by the consent request.

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​

OK
Schema
    access objectThe access information granted with the consent.
    accounts object[]The accounts linked to the consent.
  • Array [
    • iban stringThe International Bank Account Number (IBAN) of the account.
    bban stringThe Basic Bank Account Number (BBAN) of the account.
    pan stringThe Primary Bank Account Number (PAN) of the account.
    maskedPan stringThe masked PAN of the account.
    msisdn stringThe MSISDN of the account.
    currency stringThe currency of the account.
  • ]
    • balances object[]The balances of the accounts that the consent is granted for.
  • Array [
    • iban stringThe International Bank Account Number (IBAN) of the account.
    bban stringThe Basic Bank Account Number (BBAN) of the account.
    pan stringThe Primary Account Number (PAN) of the account.
    maskedPan stringThe masked PAN of the account.
    msisdn stringThe MSISDN of the account.
    currency stringThe currency of the account.
  • ]
    • transactions object[]The transactions associated with the consent.
  • Array [
    • iban stringThe International Bank Account Number (IBAN) of the account.
    bban stringThe Basic Bank Account Number (BBAN) of the account
    pan stringThe Primary Account Number (PAN) of the account.
    maskedPan stringThe masked PAN of the account.
    msisdn stringThe MSISDN of the account.
    currency stringThe currency of the account.
  • ]
    • availableAccounts stringThe list of accounts that the consent is granted for.
    Available options: allAcounts (when used the accounts, balances and transactions are empty).
    availableAccountsWithBalance stringThe list of accounts that the consent is granted for.
    Available options: allAccounts (when used the accounts, balances and transactions are empty).
    allPsd2 stringIndicates if the consent is for all Payment Services Directive 2 (PSD2) services.
    Available options: allAccounts (when used the accounts, balances and transactions are empty).
    recurringIndicator booleanIndicator specifying whether the consent is for recurring payments.
    validUntil dateThe date and time until the consent is valid.
    frequencyPerDay int32The maximum frequency of payments per day allowed by the consent.
    lastActionDate dateThe date of the last confirmed action.
    consentStatus int32

    The status of the consent.
    Available options:
    0 = "The consent is received"
    1 = "The consent is rejected"
    2 = "The consent is valid"
    3 = "The consent is revoked by PSU"
    4 = "The consent is expired"
    5 = "The consent is terminated by TPP"

    links objectLinks associated to the consent.
    property name object
    href string
Loading...