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

Field	Description	Type
`id`	Id of the consent to retrieve.	String
`consent`	The consents details with specified status for a specific PSU.	Object
`consent.consentStatus`	Authentication status of the consent.	String
`consent.frequencyPerDay`	The requested maximum frequency for an access per day.	String
`consent.validUntil`	Valid date for the requested consent. The content is the local ASPSP date in `ISODate` and the format is `2017-10-30`.	String
`consent.lastActionDate`	The 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.recurringIndicator`	`TRUE`: The consent is for recurring access to the account data. `FALSE`: The consent is for one access to the account data.	Boolean
`consent.access`	This is an object which holds access data fields.	Object
`consent.access.allPsd2`	The only valid value is: • `allAccounts`	String
`consent.access.availableAccounts`	The only valid values are: • `allAccounts` • `allAccountsWithBalances`	String
`consent.access.accounts`	Array which holds account detail fields.	Array
`consent.access.accounts.iban`	International Bank Account Number (IBAN) of an account, for example: `FR7612345987650123456789014`	String
`consent.access.accounts.bban`	Basic Bank Account Number (BBAN) Identifier. This data elements is used for payment accounts which have no IBAN, for example: `BARC12345612345678`	String
`consent.access.accounts.currency`	The 3-letter ISO-4217 currency code.	String
`consent.access.accounts.maskedPan`	Primary 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.msisdn`	An alias to access a payment account via a registered mobile phone number. Maximum length: 35	String
`consent.access.accounts.pan`	Primary 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.balances`	Array which holds balance detail fields.	Array
`consent.access.balances.iban`	International Bank Account Number (IBAN) of an account balance, for example: `FR7612345987650123456789014`.	String
`consent.access.balances.bban`	Basic Bank Account Number (BBAN) Identifier.	String
`consent.access.balances.currency`	The 3-letter ISO-4217 currency code.	String
`consent.access.balances.maskedPan`	Primary 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.msisdn`	An alias to access a payment account via a registered mobile phone number. Maximum length: 35	String
`consent.access.balances.pan`	Primary 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.transactions`	This is an array which holds transaction detail fields.	Array
`consent.access.transactions.iban`	International Bank Account Number (IBAN) of an account, for example: `FR7612345987650123456789014`	String
`consent.access.transactions.bban`	Basic Bank Account Number (BBAN) Identifier.	String
`consent.access.transactions.currency`	The 3-letter ISO-4217 currency code.	String
`consent.access.transactions.maskedPan`	Primary 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.msisdn`	An alias to access a payment account via a registered mobile phone number. Maximum length: 35	String
`consent.access.transactions.pan`	Primary 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.scaStatus`	Multiple level SCA approach in a corporate PSU context.	Object
`consent.scaStatus.otp`	The PSU can authorize the consent using the OTP code received as part of SCA process.	String
`consent.scaStatus.scaApproach`	This 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.scaRequred`	If the SCA is required for consent or not.	Boolean
`consent.scaStatus.status`	The consent authorization status.	String
`consent.scaStatus.tppNokRedirectUrl`	Redirect URL for the failure response.	String
`consent.scaStatus.tppRedirectUrl`	Redirect URL for the success response.	String
`payment`	One 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