Account Details by Customer Consent ID

The Account Details by Customer Consent ID API allows Client to get the account details using the customer's consent Id for open banking, as part of the AIS flow.

Example Response

{
    "id": "db50d17a-d849-42a6-8a49-07371fccd717",
    "consent": {
        "consentStatus": "received",
        "frequencyPerDay": 4,
        "validUntil": "2021-04-15",
        "lastActionDate": "2021-03-17",
        "recurringIndicator": true,
        "access": {
            "allPsd2": null,
            "availableAccounts": null,
            "accounts": [
                {
                    "iban": "LT563590020000000102",
                    "bban": null,
                    "currency": "EUR",
                    "maskedPan": null,
                    "msisdn": null,
                    "pan": null
                },
                {
                    "iban": "LT563590020000000102",
                    "bban": null,
                    "currency": "EUR",
                    "maskedPan": null,
                    "msisdn": null,
                    "pan": null
                }
            ],
            "balances": [
                {
                    "iban": "LT563590020000000102",
                    "bban": null,
                    "currency": "EUR",
                    "maskedPan": null,
                    "msisdn": null,
                    "pan": null
                },
                {
                    "iban": "LT563590020000000102",
                    "bban": null,
                    "currency": "EUR",
                    "maskedPan": null,
                    "msisdn": null,
                    "pan": null
                }
            ],
            "transactions": [
                {
                    "iban": "LT563590020000000102",
                    "bban": null,
                    "currency": "EUR",
                    "maskedPan": null,
                    "msisdn": null,
                    "pan": null
                },
                {
                    "iban": "LT563590020000000102",
                    "bban": null,
                    "currency": "EUR",
                    "maskedPan": null,
                    "msisdn": null,
                    "pan": null
                }
            ]
        },
        "scaStatus": {
            "otp": null,
            "scaApproach": "REDIRECT",
            "scaRequred": true,
            "status": "IDENTIFIED",
            "tppNokRedirectUrl": "http://www.google.com",
            "tppRedirectUrl": "http://www.epiphany.eu"
        }
    },
    "payment": null
}

Response Body

FieldDescriptionType
idId of the consent to retrieve.String
consentThe consents details with specified status for a specific PSU.Object
consent.consentStatusAuthentication status of the consent.String
consent.frequencyPerDayThe requested maximum frequency for an access per day.String
consent.validUntilValid date for the requested consent. The content is the local ASPSP date in ISODate and the format is 2017-10-30.String
consent.lastActionDateThe date of the last action on the consent object either through the XS2A interface or the PSU/ASPSP interface having an impact on the status.String
consent.recurringIndicatorTRUE: The consent is for recurring access to the account data.
FALSE: The consent is for one access to the account data.
Boolean
consent.accessThis is an object which holds access data fields.Object
consent.access.allPsd2The only valid value is:
allAccounts
String
consent.access.availableAccountsThe only valid values are:
allAccounts
allAccountsWithBalances
String
consent.access.accountsArray which holds account detail fields.Array
consent.access.accounts.ibanInternational Bank Account Number (IBAN) of an account, for example: FR7612345987650123456789014String
consent.access.accounts.bbanBasic Bank Account Number (BBAN) Identifier. This data elements is used for payment accounts which have no IBAN, for example: BARC12345612345678String
consent.access.accounts.currencyThe 3-letter ISO-4217 currency code.String
consent.access.accounts.maskedPanPrimary Account Number (PAN) of a card in a masked form. This is used for card account in responses, for example 1234.
Maximum length: 35
String
consent.access.accounts.msisdnAn alias to access a payment account via a registered mobile phone number.
Maximum length: 35
String
consent.access.accounts.panPrimary Account Number (PAN) of a card, can be tokenized by the ASPSP due to PCI DSS requirements. This is used for card account in responses.
Maximum length: 35
String
consent.access.balancesArray which holds balance detail fields.Array
consent.access.balances.ibanInternational Bank Account Number (IBAN) of an account balance, for example: FR7612345987650123456789014.String
consent.access.balances.bbanBasic Bank Account Number (BBAN) Identifier.String
consent.access.balances.currencyThe 3-letter ISO-4217 currency code.String
consent.access.balances.maskedPanPrimary Account Number (PAN) of a card in a masked form. This is used for card account in responses, for example " 1234".
Maximum length: 35
String
consent.access.balances.msisdnAn alias to access a payment account via a registered mobile phone number.
Maximum length: 35
String
consent.access.balances.panPrimary Account Number (PAN) of a card, can be tokenized by the ASPSP due to PCI DSS requirements. This is used for card account in responses.
Maximum length: 35
String
consent.access.transactionsThis is an array which holds transaction detail fields.Array
consent.access.transactions.ibanInternational Bank Account Number (IBAN) of an account, for example: FR7612345987650123456789014String
consent.access.transactions.bbanBasic Bank Account Number (BBAN) Identifier.String
consent.access.transactions.currencyThe 3-letter ISO-4217 currency code.String
consent.access.transactions.maskedPanPrimary Account Number (PAN) of a card in a masked form. This is used for card account in responses, for example 1234.
Maximum length: 35
String
consent.access.transactions.msisdnAn alias to access a payment account via a registered mobile phone number.
Maximum length: 35
String
consent.access.transactions.panPrimary Account Number (PAN) of a card, can be tokenized by the ASPSP due to PCI DSS requirements. This is used for card account in responses.
Maximum length: 35
String
consent.scaStatusMultiple level SCA approach in a corporate PSU context.Object
consent.scaStatus.otpThe PSU can authorize the consent using the OTP code received as part of SCA process.String
consent.scaStatus.scaApproachThis data element must be contained, if the SCA approach is already fixed. The possible values are:
EMBEDDED
DECOUPLED
REDIRECT

The OAuth SCA approach will be subsumed by REDIRECT.
String
consent.scaStatus.scaRequredIf the SCA is required for consent or not.Boolean
consent.scaStatus.statusThe consent authorization status.String
consent.scaStatus.tppNokRedirectUrlRedirect URL for the failure response.String
consent.scaStatus.tppRedirectUrlRedirect URL for the success response.String
paymentOne or more processes that implement the business logic related to payment flows such as payment initiation, single payment execution, including security checks, logging, etc.String