Main page - Kutxabank
Logos download
Download guide: By clicking on the logos button you will download a zip file containing all the logos of the entity partners.
| Version | Domains | |
| V1 | API sandbox https://apis-i.redsys.es:20443/psd2/xs2a/api-entrada-xs2a/services/kutxabank |
API oAuth-sandbox https://apis-i.redsys.es:20443/psd2/xs2a/api-oauth-xs2a/services/rest/kutxabank |
|
V1 |
API production |
API oAuth-production |
|
v1.1 |
API sandbox https://apis-i.redsys.es:20443/psd2/xs2a/api-entrada-xs2a/services/kutxabank/v1.1 |
API oAuth-sandbox https://apis-i.redsys.es:20443/psd2/xs2a/api-oauth-xs2a/services/rest/kutxabank |
|
v1.1 |
API production |
API oAuth-production |
Payment Initiation Service (PIS)
| Initiation of a simple and future payment | V1 | V1.1 | |||
| Simple payment start POST /payments/{payment-product} |
payment product | sepa-credit-transfers | Normal credit transfers within the euro zone (SEPA). It is indicated in the PATH of the request. | x | x |
| instant-sepa-credit-transfers | Immediate credit transfers within the euro zone (iSEPA). It is indicated in the PATH of the request. | x | x | ||
| target-2-payments | Payments by the TARGET2 system. It is indicated in the PATH of the request. | x | x | ||
| cross-border-credit-transfers | Cross-border credit transfers. It is indicated in the PATH of the request. | x | x | ||
| Payment start support multi-currency accounts | Applies to all payment products | Allows you to make a transfer from a sub-account identified by IBAN + currency | |||
| Future Payment Start POST /payments/{payment-product} |
payment product (Field requestedExecutionDate) |
sepa-credit-transfers | Normal credit transfers within the euro zone (SEPA). It is indicated in the PATH of the request. | ||
| instant-sepa-credit-transfers | Immediate credit transfers within the euro zone (iSEPA). It is indicated in the PATH of the request. | ||||
| target-2-payments | Payments by the TARGET2 system. It is indicated in the PATH of the request. | ||||
| cross-border-credit-transfers | Cross-border credit transfers. It is indicated in the PATH of the request. | ||||
| Future payment start support multi-currency accounts | Applies to all paid products | Allows you to make a transfer from a sub-account identified by IBAN + currency | |||
| Payment status GET /payments/{payment-product}/{paymentId}/status |
Check payment status | x | x | ||
| Get payment GET /payments/{payment-product}/{paymentId} |
Return of the payer's account | Sí | The payment detail is returned and IF the payer's account (debtorAccount) is informed after the SCA ok | x | x |
| Return of the payer's name | Sí | The payment detail is returned and IF the name of the payer (debtorName) is informed after the SCA ok | x | x | |
| Authorize start of payment POST /payments/{payment-product}/{paymentId}/authorisations |
The TPP requires an explicit authorization of the transaction or, the ASPSP has detected that the PSU has more than one SCA method available and it is necessary for the TPP to update the SCA method selected by the PSU. Also required in case the transaction requires multilevel SCA (several PSU sign the operation) |
x | |||
| Update PSU Authorization Data (scaMethod) PUT payments/{payment-product}/{paymentId}/authorisations/{authorisationId} |
The TPP can use this request to inform the ASPSP of the SCA method selected by the PSU in case of have more than one available | ||||
| Get list of authorization subresources GET /payments/{payment-product}/{paymentId}/authorisations |
The TPP can read the list of authorization subresource IDs that have been created | x | |||
| Authorization SCA Status GET /payments/{payment-product}/{paymentId}/authorisations/{authorisationId} |
The TPP can use this request to obtain the SCA status of the authorization. | x | |||
| Cancel payment DELETE /payments/{payment-product}/{paymentId} |
Functionality to cancel a payment (if allowed by the ASPSP). | ||||
| Implicit Cancellation Authorization | The TPP requires an implicit authorization of the transaction or, the ASPSP has detected that the PSU has more than one SCA method available and it is necessary for the TPP to update the SCA method selected by the PSU. Also required in case the transaction requires multilevel SCA (several PSU sign the operation) Note: mandatory if cancellation authorization supported |
||||
| Authorize payment initiation cancellation POST payments/{payment-product}/{paymentId}/cancelation-authorisations |
The TPP requires an explicit authorization of the transaction or, the ASPSP has detected that the PSU has more than one SCA method available and it is necessary for the TPP to update the SCA method selected by the PSU. Also required in case the transaction requires multilevel SCA (several PSU sign the operation) Note: mandatory if cancellation authorization supported |
||||
| Update PSU cancellation authorization data (scaMethod) PUT payments/{payment-product}/{paymentId}/cancelation-authorisations/{cancelationId} |
The TPP can use this request to inform the ASPSP of the SCA method selected by the PSU in case of have more than one available Note: mandatory if SCA method selection is supported |
||||
| Get Cancellation Authorization Sub-Resource List GET payments/{payment-product}/{paymentId}/cancelation-authorisations |
The TPP can read the list of cancellation authorization subresource IDs that have been created Note: mandatory if cancellation authorization supported |
||||
| SCA status of cancellation authorization GET payments/{payment-product}/{paymentId}/cancelation-authorisations/{cancellationId} |
The TPP can use this request to obtain the SCA status of the cancellation authorization Note: required if cancellation authorization supported |
||||
| Initiating a bulk payment | V1 | V1.1 | |||
| Bulk payment initiation POST bulk-payments/{payment-product} |
Payment product supported | sepa-credit-transfers | Normal credit transfers within the euro zone (SEPA). It is indicated in the PATH of the request. | ||
| instant-sepa-credit-transfers | Immediate credit transfers within the euro zone (iSEPA). It is indicated in the PATH of the request. | ||||
| target-2-payments | Payments through the TARGET2 system. It is indicated in the PATH of the request. | ||||
| cross-border-credit-transfers | Cross-border credit transfers. It is indicated in the PATH of the request. | ||||
| Support start payment bulk multi-currency accounts | Applies to all paid products | Allows you to make a transfer from a sub-account identified by IBAN + currency | |||
| Bulk payment status GET bulk-payments/{payment-product}/{paymentId}/status |
Check bulk payment status | ||||
| Get bulk payment GET bulk-payments/{payment-product}/{paymentId} |
Return of the payer's name | No | The payment detail is returned and the name of the payer (debtorName) is NOT reported after the SCA ok | ||
| Yes | The payment detail is returned and IF the name of the payer (debtorName) is reported after the SCA ok | ||||
| Authorize bulk payment initiation POST bulk-payments/{payment-product}/{paymentId}/authorisations |
The TPP requires an explicit authorization of the transaction or, the ASPSP has detected that the PSU has more than one SCA method available and it is necessary for the TPP to update the SCA method selected by the PSU. Also required in case the transaction requires multilevel SCA (several PSU sign the operation) |
||||
| Update PSU authorization data (scaMethod) PUT bulk-payments/{payment-product}/{paymentId}/authorisations/{authorisationId} |
The TPP can use this request to inform the ASPSP of the SCA method selected by the PSU in case of be more than one available | ||||
| Get list of authorization subresources GET bulk-payments/{payment-product}/{paymentId}/authorisations |
The TPP can read the list of authorization subresource IDs that have been created | ||||
| Authorization SCA Status GET bulk-payments/{payment-product}/{paymentId}/authorisations/{authorisationId} |
The TPP can use this request to obtain the SCA status of the authorization. | ||||
| Cancel bulk payment DELETE bulk-payments/{payment-product}/{paymentId} |
Functionality to cancel a bulk payment (if allowed by the ASPSP). | ||||
| Autorización implícita de cancelación | The TPP requires an implicit authorization of the transaction or, the ASPSP has detected that the PSU has more than one SCA method available and it is necessary for the TPP to update the SCA method selected by the PSU. Also required in case the transaction requires multilevel SCA (several PSU sign the operation) Note: mandatory if cancellation authorization supported |
||||
| Authorize cancellation of bulk payment initiation POST bulk-payments/{payment-product}/{paymentId}/cancelation-authorisations |
The TPP requires an explicit authorization of the transaction or, the ASPSP has detected that the PSU has more than one SCA method available and it is necessary for the TPP to update the SCA method selected by the PSU. Also required in case the transaction requires multilevel SCA (several PSU sign the operation) Note: mandatory if cancellation authorization supported |
||||
| Update PSU cancellation authorization data (scaMethod) PUT bulk-payments/{payment-product}/{paymentId}/cancelation-authorisations/{cancelationId} |
The TPP can use this request to inform the ASPSP of the SCA method selected by the PSU in case of have more than one available Note: mandatory if SCA method selection is supported |
||||
| Get Cancellation Authorization Sub-Resource List GET bulk-payments/{payment-product}/{paymentId}/cancelation-authorisations |
The TPP can read the list of cancellation authorization subresource IDs that have been created Note: mandatory if cancellation authorization supported |
||||
| SCA status of cancellation authorization GET bulk-payments/{payment-product}/{paymentId}/cancelation-authorisations/{cancelationId} |
The TPP can use this request to obtain the SCA status of the cancellation authorization Note: required if cancellation authorization supported |
||||
| Initiating a periodic/recurring payment | V1 | V1.1 | |||
| Start periodic/recurring payment POST periodic-payments/{payment-product} |
Supported payment product | sepa-credit-transfers | Normal credit transfers within the euro zone (SEPA). It is indicated in the PATH of the request. | x | x |
| instant-sepa-credit-transfers | Immediate credit transfers within the euro zone (iSEPA). It is indicated in the PATH of the request. | ||||
| target-2-payments | Payments through the TARGET2 system. It is indicated in the PATH of the request. | ||||
| cross-border-credit-transfers | Cross-border credit transfers. It is indicated in the PATH of the request. | ||||
| Support start payment periodic/recurring multi-currency accounts | Applies to all paid products | Allows you to make a transfer from a sub-account identified by IBAN + currency | |||
| Regular/Recurring Payment Status GET periodic-payments/{payment-product}/{paymentId}/status |
Check recurring/recurring payment status | x | x | ||
| Get regular/recurring payment GET periodic-payments/{payment-product}/{paymentId} |
Get the details of a recurring/recurring payment | x | x | ||
| Authorize start of periodic/recurring payment POST periodic-payments/{payment-product}/{paymentId}/authorisations |
The TPP requires an explicit authorization of the transaction or, the ASPSP has detected that the PSU has more than one SCA method available and it is necessary for the TPP to update the SCA method selected by the PSU. Also required in case the transaction requires multi-level SCA (several PSU sign the operation) |
x | |||
| Update PSU authorization data (scaMethod) PUT periodic-payments/{payment-product}/{paymentId}/authorisations/{authorisationId} |
The TPP can use this request to inform the ASPSP of the SCA method selected by the PSU in case of be more than one available | ||||
| Get list of authorization subresources GET periodic-payments/{payment-product}/{paymentId}/authorisations |
The TPP can read the list of authorization subresource IDs that have been created | x | |||
| SCA authorization status GET periodic-payments/{payment-product}/{paymentId}/authorisations/{authorisationId} |
The TPP can use this request to get the SCA status of the authorization. | x | |||
| Cancel periodic/recurring payment DELETE periodic-payments/{payment-product}/{paymentId} |
Functionality to cancel a periodic/recurring payment (if allowed by the ASPSP). | x | x | ||
| Implied authorization to cancel | The TPP requires an implicit authorization of the transaction or, the ASPSP has detected that the PSU has more than one SCA method available and it is necessary for the TPP to update the SCA method selected by the PSU. Also required in case the transaction requires multi-level SCA (several PSU sign the operation) Note: mandatory if cancellation authorization supported |
||||
| Authorize cancellation of periodic/recurring payment initiation POST periodic-payments/{payment-product}/{paymentId}/cancelation-authorisations |
The TPP requires an explicit authorization of the transaction or, the ASPSP has detected that the PSU has more than one SCA method available and it is necessary for the TPP to update the SCA method selected by the PSU. Also required in case the transaction requires multi-level SCA (several PSU sign the operation) Note: mandatory if cancellation authorization supported |
x | |||
| Update PSU cancellation authorization data (scaMethod) PUT periodic-payments/{payment-product}/{paymentId}/cancelation-authorisations/{cancellationId} |
The TPP can use this request to inform the ASPSP of the SCA method selected by the PSU in case of have more than one available Note: mandatory if SCA method selection is supported |
||||
| Get Cancellation Authorization Sub-Resource List GET periodic-payments/{payment-product}/{paymentId}/cancelation-authorisations |
The TPP can read the list of cancellation authorization subresource IDs that have been created Note: mandatory if cancellation authorization supported |
x | |||
| SCA status of cancellation authorization GET periodic-payments/{payment-product}/{paymentId}/cancelation-authorisations/{cancellationId} |
The TPP can use this request to obtain the SCA status of the cancellation authorization Note: required if cancellation authorization supported |
x | |||
Account access service (AIS)
| Manage consent | V1 | V1.1 | |||
| General | Sessions | combinedServiceIndicator | Sessions must be supported via the pre-step oauth token. The value of combinedServiceIndicator will be ignored. | x | |
| Multi-currency accounts | The ASPSP makes a distinction between multi-currency accounts. | ||||
| Request consent POST {provider}/{version}/consents |
Detailed consent (Detailed consent) |
Request type of access "accounts", "balances" and/or "transactions" indicating the accounts related to the requested consents | Consent to obtain: - Details of a dedicated account or a list of accessible accounts of the USP, once (single use consent) or several times (multiple use consent) - Dedicated account balances once or multiple times, once (single use consent) or multiple times times (multiple use consent) - Transactions (movements) of a dedicated account, a once (single use consent) or several times (multiple use consent) * In this type of consent the TPP indicates the specific accounts on which the consent is requested. consent. |
x | x |
| Request type of access "accounts", "balances" and/or "transactions" indicating the card accounts related to the requested consents | Consent to obtain: - Details of a dedicated card account or a list of accounts of accessible USP cards, once (single-use consent) or multiple times (single-use consent). multi-use) - Balances a dedicated card account once or several times, once (single use consent) or several times (multiple use consent) - Transactions (movements) of a dedicated card account, once (single-use consent) or several times (multiple use consent) * In this type of consent the TPP indicates the accounts specific card numbers for which consent is requested. |
||||
| Consent offered by the bank (Bank offered consent) |
Request type of access "accounts", "balances" and/or "transactions" without indicating the related accounts | Consent to obtain: - Details of a dedicated account or a list of accessible accounts of the USP, once (single use consent) or several times (multiple use consent) - Dedicated account balances once or multiple times, once (single use consent) or multiple times times (multiple use consent) - Transactions (movements) of a dedicated account, a once (single use consent) or several times (multiple use consent) * In this type of consent the accounts on which the type of access is requested are not specified by the TPP. They are agreed bilaterally between PSU-ASPSP. * Only available for "redirect" flow and "disengaged". aspsp.ais.bank-offered.enabled |
x | ||
| Request type of access "accounts", "balances" and/or "transactions" without indicating the card accounts related | Consent to obtain: - Details of a dedicated card account or a list of accounts of accessible USP cards, once (single-use consent) or multiple times (single-use consent). multi-use) - Balances a dedicated card account once or several times, once (single use consent) or several times (multiple use consent) - Transactions (movements) of a dedicated card account, once (single-use consent) or several times (multiple use consent) * In this type of consent the card accounts on which the type of access is requested are not specified by the TPP. They are agreed upon bilateral between PSU-ASPSP. * Only available for flow "redirect" and "decoupled". |
||||
| Global consent (Global consent) |
Consent with access type "availableAccounts" for list of available accounts without balances | The consent request supports the "availableAccounts" sub-attribute with the value "allAccounts" in instead of the "accounts", "balances" and/or "transactions" attributes. The accounts are not specified in the petition. Request a single-use consent to obtain the list of all accounts available from the PSU without supporting the "withBalance" attribute of the path. It will only return the counts (without details) in reading the list of available accounts. It will not include the balance. |
x | x | |
| Consent with access type "availableAccounts" for list of available card accounts without balances | The consent request supports the "availableAccounts" sub-attribute with the value "allAccounts" in instead of the "accounts", "balances" and/or "transactions" attributes. Card accounts not specified in the petition. Request a single-use consent to obtain the list of all the available card counts of the PSU without supporting the "withBalance" attribute of the path. Only will return the card accounts (without details) in the card account list reading available. It will not include the balance. |
||||
| Consent with access type "availableAccountsWithBalance" for list of available accounts with balances | The consent request supports the sub-attribute "availableAccountsWithBalance" with the value "allAccounts" instead of the "accounts", "balances" and/or "transactions" attributes. are not specified accounts in the petition. Request a single-use consent to obtain the list of all the available counts of the PSU supporting the "withBalance" attribute of the path. In reading list of available accounts, if requested by the TPP, you must return the accounts (without details) and their current balance. |
x | x | ||
| Consent with access type "allPsd2" | Consent that supports the "allPsd2" sub-attribute. Request all types of access ("accounts", "balances", "transactions") to all available PSU accounts. consent of a once (one time use consent with "recurringIndicator=false") or multiple times (one time use consent recurring with "recurringIndicator=true") |
x | x | ||
| Consent that supports the "allPsd2" sub-attribute. Request all types of access ("accounts", "balances", "transactions") to all available PSU card accounts. One-time consent (one-time consent with "recurringIndicator=false") or multiple times (recurring usage consent with "recurringIndicator=true") |
|||||
| Consent status GET /consents/{consentId}/status |
Read the authentication status of the indicated consent. | x | x | ||
| Get consent GET /consents/{consentId} |
Read the exact definition of the indicated consent, including the validity status. | x | x | ||
| Delete consent DELETE /consents/{consentId} |
Delete the indicated consent. | x | x | ||
| Authorize consent establishment POST consents/{consentId}/authorisations |
The TPP requires an explicit authorization of the transaction or, the ASPSP has detected that the PSU has more than one SCA method available and it is necessary for the TPP to update the SCA method selected by the PSU. Also required in case the transaction requires multilevel SCA (several PSU sign the operation) |
x | |||
| Update PSU authorization data (scaMethod) PUT consents/{consentId}/authorisations/{authorisationId} |
The TPP can use this request to inform the ASPSP of the SCA method selected by the PSU in case of have more than one available Note: mandatory if SCA method selection is supported |
||||
| Get list of authorization subresources GET consents/{consentId}/authorisations |
The TPP can read the list of authorization subresource IDs that have been created | x | |||
| SCA authorization status GET consents/{consentId}/authorisations/{authorisationId} |
The TPP can use this request to get the SCA status of the authorization. | x | |||
| Account Reading | V1 | V1.1 | |||
| Get list of available accounts GET /accounts{query-parameters} |
No balance | Obtain the list of available accounts from the PSU using a one-time consent without support the "withBalance" attribute of the path. Will only return available accounts (no details). It will not include the balance. |
x | x | |
| With balance | Get the list of available accounts from the PSU using a one-time consent supporting the "withBalance" attribute of the path. Will return the available accounts (without detail) and the balance. |
x | x | ||
| Get account details GET /accounts{query-parameters} |
Get dedicated account details (single account) | No balance | Obtain the detail of a PSU account using a consent of one or more uses with the type access "accounts", "balances" and/or "transactions" for the requested account without supporting the attribute "withBalance" from path. The account details will be returned. Balance will not be included. |
x | x |
| With balance | Obtain the detail of a PSU account using a consent of one or more uses with the type access "accounts", "balances" and/or "transactions" for the requested account supporting the attribute "withBalance" of the path. The account details will be returned along with the balance. |
x | x | ||
| Get account details from the list of accessible accounts | No balance | Obtain the detail of a list of PSU accounts using a consent of one or several uses with the access type "accounts", "balances" and/or "transactions" for the requested accounts not supported the "withBalance" attribute of the path. The details of each account in the list of accounts. Balance will not be included. |
x | x | |
| With balance | Obtain the detail of a list of PSU accounts using a consent of one or several uses with the type of access "accounts", "balances" and/or "transactions" for the requested accounts supporting the "withBalance" attribute of the path. The details of each account in the list of accounts will be returned including the balance of each account. |
x | x | ||
| Return the name of the connected PSU (ownerName) | Return of the PSU connected in the ownerName field | x | |||
| Get balances for a given account GET /accounts/{account-id}/balances |
Get the balances of a given account. | x | x | ||
| Get transaction information for a given account GET /accounts/{account-id}/transactions{query-parameters} |
Include balances | No balance | Obtain the transactions (movements) of a PSU account using the consent of one or multiple uses with "transactions" access type for the requested account without supporting the attribute "withBalance" of the path. Transactions for the account will be returned. Balance will not be included. |
x | x |
| With balance | Obtain the transactions (movements) of a PSU account using the consent of one or multiple uses with "transactions" access type for the requested account supporting the attribute "withBalance" of the path. The transactions of the account will be returned including the balance of the same. |
x | x | ||
| Search Filters | dateFrom - dateTo support | Obtain the transactions (movements) of a PSU account using the consent of one or multiple usages with "transactions" access type for the requested account. The query is made indicating the dateFrom date and, optionally, dateTo. |
x | x | |
| transactionId support | Obtain the transactions (movements) of a PSU account using the consent of one or multiple usages with "transactions" access type for the requested account. The query will return all transactions after the indicated "transactionId". If this attribute comes, dateFrom and dateTo are not taken into account. |
||||
| deltaList support | Obtain the transactions (movements) of a PSU account using the consent of one or multiple usages with "transactions" access type for the requested account. The query will return all transactions after the last access report. Alternative to "transactionId" and "dateFrom" and "dateTo". |
||||
| List of standing orders | bookingStatus=information | Get the list of standing orders associated with an account when the value is reported "information" in the bookingStatus field Note: mandatory if the Orders service is supported permanent for periodic/recurring payments |
x | x | |
| Trusted Beneficiaries | V1 | V1.1 | |||
| Get list of trusted beneficiaries GET /trusted-beneficiaries?{account-id} |
Global list | Get the listing global the beneficiaries de confidence del PSU Note: if "Global Listing" is supported it cannot be supported the "Listing by account" |
x | ||
| List by account | Get the list of the beneficiaries de confidence del Specific PSU per account Note: if "Listing per account" "Global Listing" cannot be supported |
||||
| Card bill reading | V1 | V1.1 | |||
| Get list of available card accounts GET /card-accounts{query-parameters} |
No balance | Obtain the list of available card accounts from the PSU using a consent from only one use without supporting the "withBalance" attribute of the path. They will only return the accounts of cards available (no details). Will not include balance. |
|||
| Get card account details GET /card-accounts{query-parameters} |
Get dedicated card account details (single account) | No balance | Obtain the detail of a PSU card account using the consent of one or various uses with the type of access "accounts", "balances" and/or "transactions" for the account of card requested without supporting the "withBalance" attribute of the path. Details will be returned from the card account. will not be included balance. |
||
| Get card account details from the list of accessible accounts | No balance | Obtain the details of a list of PSU card accounts using a consent of one or several uses with the type of access "accounts", "balances" and/or "transactions" for the accounts from cards requested without supporting the "withBalance" attribute of the path. The details of each card account in the list of accounts. will not be included balance. |
|||
| Get balances for a given card account GET /card-accounts/{account-id}/balances |
Get the balances of a specific card account. | ||||
| Get transaction information for a card account given GET /card-accounts/{account-id}/transactions{query-parameters} |
No balance | Obtain the transactions (movements) of a PSU card account using a consent to one or more uses with the "transactions" access type for the card account requested without supporting the "withBalance" attribute of the path. The transactions of the card account. will not be included balance. |
|||
| Search Filters | dateFrom - dateTo support | Obtain the transactions (movements) of a PSU account using a consent of one or several uses with the type of access "transactions" for the requested account. The query It does this by indicating the dateFrom date and, optionally, dateTo. |
|||
| deltaList support | Obtain the transactions (movements) of a PSU card account using a consent to one or more uses with the "transactions" access type for the card account requested. The query will return all transactions subsequent to the report of the Last Access. Alternative to "dateFrom" and "dateTo". |
||||
| Access counter control | V1 | V1.1 | |||
| The HUB keeps track of accesses for reading information about accounts and, when the limit is reached, the HUB filters the request so as not to send it to the ASPSP and returns the corresponding error instead. | x | ||||
Fund Confirmation Service
| Confirmation of funds | V1 | V1.1 | |||
| Confirmation POST /funds-confirmation |
Without indicating the card number | The fund query is made on the account indicated in the account field | x | ||
| Multi-currency accounts | The ASPSP makes a distinction between multi-currency accounts. | ||||
| Indicating the card number. | "cardNumber" attribute | Card number issued by the PISP. Used for choosing the sub-account on which to check the balance. | |||
Consent for confirmation of funds
| Confirmation of funds | V2 | V2.1 | |||
| General | Multi-currency accounts | The ASPSP makes a distinction between multi-currency accounts. | |||
| Request consent POST /consents/confirmation-of-funds |
Detailed consent (Detailed consent) |
The consent that the TPP has obtained from the PSU through the API is reported. Being able to indicate: account, cardNumber, expiration date,... With this consent it will be allowed to consume the request of confirmation of funds using token+consent. Note: In this type of consent the TPP indicates the specific account on which consent is requested. |
x | ||
| Consent Status GET /consents/confirmation-of-funds/{consentId}/status |
Read the authentication status of the indicated consent. | x | |||
| Get consent GET /consents/confirmation-of-funds/{consentId} |
Read the exact definition of indicated consent | x | |||
| Delete consent DELETE /consents/confirmation-of-funds/{consentId} |
Delete the indicated consent. | x | |||
| Authorize consent establishment POST /consents/confirmation-of-funds/{consentId}/authorisations |
The TPP requires an explicit authorization of the transaction or, the ASPSP has detected that the PSU has more than one SCA method available and it is necessary for the TPP to update the SCA method selected by the PSU. Also required in case the transaction requires multilevel SCA (several PSU sign the operation) |
x | |||
| Update PSU authorization data (scaMethod) PUT /consents/confirmation-of-funds/{consentId}/authorisations/{authorisationId} |
The TPP can use this request to inform the ASPSP of the SCA method selected by the PSU in case of be more than one available | ||||
| Get list of authorization subresources GET /consents/confirmation-of-funds/{consentId}/authorisations |
The TPP can read the list of authorization subresource IDs that have been created | x | |||
| SCA authorization status GET /consents/confirmation-of-funds/{consentId}/authorisations/{authorisationId} |
The TPP can use this request to get the SCA status of the authorization. | x | |||
| Signing basket | V1 | V1.1 | |||
| Set Signing Basket POST signing-baskets |
PIS Operations | The ASPSP supports that a TPP can establish N payments and sign them all at once with the Signing Basket | |||
| AIS operations | Set consent | The ASPSP supports that a TPP can establish N consents and sign them all at once with the Signing Basket | |||
| PIS+AS operations | Payment operations + establish consent | The ASPSP supports that a TPP can establish N consents and N payments and sign them all at once with the Signing Basket | |||
| Signing Basket Status GET signing-baskets/{basketId}/status |
Allows a TPP to know the state of the Signing Basket | ||||
| Retrieve contents of the Signing Basket GET signing-baskets/{basketId} |
Allows a TPP to retrieve the IDs of the operations to be signed in the Signing Basket | ||||
| Delete Signing Basket DELETE signing-baskets/{basketId} |
Allows a TPP to remove the structure from the Signing Basket (if it has not already been authorized) | ||||
| Authorize Signing Basket POST signing-baskets/{basketId}/authorisations |
The TPP requires an explicit authorization of the transaction or, the ASPSP has detected that the PSU has more than one SCA method available and it is necessary for the TPP to update the SCA method selected by the PSU. Also required in case the transaction requires multilevel SCA (several PSU sign the operation) |
||||
| Update PSU authorization data (scaMethod) PUT signing-baskets/{basketId}/authorisations/{authorisationId} |
The TPP can use this request to inform the ASPSP of the SCA method selected by the PSU in case of be more than one available | ||||
| Get list of authorization subresources GET signing-baskets/{basketId}/authorisations |
The TPP can read the list of authorization subresource IDs that have been created | ||||
| SCA authorization status GET signing-baskets/{basketId}/authorisations/{authorisationId} |
The TPP can use this request to obtain the SCA status of the authorization. Note: required if Signing Basket is supported |
||||
Added Value Services (SVA)
| Start payment with list of available accounts | V1 | V1.1 | |
| SVA payment start POST /sva/payments/{payment-product} |
Initiate a payment without informing the ordering account. In the SCA flow by redirection to the ASPSP, this will show the list of accounts available to the PSU so that it can select the one it wants to use. Note: for this start of payment, the same characteristics that the entity has selected in the start of CORE payment. |
x | x |
| Start periodic/recurring payment with list of available accounts | V1 | V1.1 | |
| SVA periodic/recurring payment start POST /sva/payments/{payment-product} |
Initiate a periodic/recurring payment without informing the ordering account. In the flow of SCA by redirection to the ASPSP, it will show the list of accounts available to the PSU so that it can select the which you want to use. Note: for this start of payment the same characteristics will apply selected the entity at the start of CORE payment. | x | |
| Get information from TPPs | V1 | V1.1 | |
| Get details of a TPP GET /tpps/{tppId} |
Allows the ASPSP to obtain the details of a TPP that connects through the HUB | ||
| Get list of TPPs GET /tpps |
Allows the ASPSP to obtain the list of TPPs that connect through the HUB | ||
| Notification of new TPP POST /sva/tpps |
When a new TPP connects through the Hub, all ASPSPs are notified of the information from this new TPP. (Except for the ASPSP addressee of the original request of the TPP) | ||
SCA flows
| SCA Flows | V1 | V1.1 | |||
| Redirect | Redirect only | The payment or consent authorization process is carried out through a redirection to the entity's authentication website and is executed after a correct SCA | x | x | |
| Redirect in Hub + OAuth2 ASPSP |
AuthToken | The ASPSP returns two tokens in the token request: accessToken and authToken (Required if Payment Execution is supported). Note: the rest of the configuration applies the one selected in the OAuth2 pre-step | |||
| Decoupled | The The payment authorization or consent process is carried out through a bank app and is executed after the correct SCA. | ||||
| Embedded | <Not supported> | <Not supported> | |||
| Multilevel SCA | The ASPSP supports multi-level SCA Note: required if offered in Online Banking |
||||
OAuth prestep
| Oauth prestep | V1 | V1.1 | |||
| Web login | ClientID of the HUB (Select an option) |
Generated by the Entity | The Client ID of the HUB that is sent to the ASPSP has been previously generated by the Entity (If this is selected, does not apply the "Generated by the Hub") | ||
| Generated by the HUB | The Client ID of the HUB that is sent to the ASPSP has been generated by Redsys (If this is selected, it does not applies the "Generated by Entity") | x | |||
| TPP ClientID (Select an option) |
Do not inform the ASPSP | The ASPSP does not require to be informed of the Client ID of the TPP | |||
| Report as clientId | The HUB sends the Client ID of the TPP in the clientID attribute and informs the Client ID of the HUB in the attribute optional secondClientId | ||||
| Report as secondClientId | The HUB sends the Client ID of the HUB in the clientID attribute and informs the Client ID of the TPP in the attribute optional secondClientId | x | |||
| Token renewal | Refresh token support. Especially useful for reading information about accounts in AIS | x | |||
| URL callback | The ASPSP requires to pre-register the HUB callback URL (If required, Redsys will inform the entity the required URL) | ||||
| Biometrics Note: required if offered in Online Banking |
Offer biometrics through current autorize endpoint | Biometric authentication via app-to-app redirection is offered by the same endpoint of /authorize used for web authentication | x | x | |
| Offer biometrics for additional endpoints than authorize | Individuals | A specific endpoint is used for biometrics through app-to-app redirection for individuals | |||
| Company | A specific endpoint is used for biometrics through app-to-app redirection for companies | ||||
We inform you that from this moment on, the biometrics APP for the Sandbox environment. If you want to request access to it, you must send an email to the mailbox psd2.sandbox.soporte@redsys.es, with the subject "APP access request biometrics Sandbox", and facilitating the following access data:
- User with which the TPP has been registered in Sandbox.
Once your download invitation has been processed, you will receive a confirmation email with the who have registered in the Sandbox of the APP Center tool and another of the mailbox psd2.sandbox.support@redsys.es
PSU profiles
| Standard PSU Profiles | |||||
| Profile Code | Account properties | Account data | PSU-ID | Supported payment products | Special features |
| PsuDefault-Private-1 | Particular account | AcctPsuDefPriv1 AcctPsuDefPriv2 AcctPsuDefPriv5 |
ID: user1 Pass: 1234 |
All supported by the ASPSP | SCA OK result |
| PsuDefault-Private-2 | Particular account | AcctPsuDefPriv3 AcctPsuDefPriv4 |
ID: user2 Pass: 1234 |
All supported by the ASPSP | SCA KO Result |
| PsuDefault-Corporate-1 | Company account with multilevel SCA | AcctPsuDefCorp1 | ID: user1 Pass: 1234 |
All supported by the ASPSP | SCA OK result |
| PsuDefault-Corporate-2 | Company account with multilevel SCA | AcctPsuDefCorp1 | ID: user2 Pass: 1234 |
All supported by the ASPSP | SCA KO Result |
| PSU profiles for SCA | |||||
| Profile Code | Account properties | Account data | PSU-ID | Supported payment products | Special features |
| RedirectSca-1a | Company account with multilevel SCA | AcctPsuDefCorp1 | ID: user1 Pass: 1234 |
All supported by the ASPSP | SCA OK result |
| RedirectSca-1b | Particular account | AcctPsuDefPriv1 AcctPsuDefPriv2 AcctPsuDefPriv5 |
ID: user1 Pass: 1234 |
All supported by the ASPSP | SCA OK result |
| RedirectSca-1c | Particular account | AcctPsuDefPriv3 AcctPsuDefPriv4 |
ID: user2 Pass: 1234 |
All supported by the ASPSP | SCA KO Result |
| PSU profiles for PIIS | |||||
| Profile Code | Account properties | Account data | PSU-ID | ||
| ConfFunds-1a | Particular account TPP activated for PIIS |
AcctPsuDefPriv1 AcctPsuDefPriv2 AcctPsuDefPriv5 |
NA | ||
| ConfFunds-1b | Particular account TPP not activated for PIIS |
Debtor account (IBAN) required | NA | ||
IBAN codes:
| Standard accounts | |||||
| Profile Code | Account properties | Account data | |||
| CredAcc-1 (Default creditor account) |
Particular account | Creditor Account (ES0040000000000000000001) required Creditor Name required |
|||
| AcctPsuDefPriv1 (1st account of the PsuDefault-Private1) |
Particular account |
ES3220953150241090149765 |
|||
| AcctPsuDefPriv2 (2nd account of the PsuDefault-Private1) |
Particular account |
ES3820955006389229636183 |
|||
| AcctPsuDefPriv3 (1st account of the PsuDefault-Private2) |
Particular account |
ES5520950545709114872395 |
|||
| AcctPsuDefPriv4 (2nd account of the PsuDefault-Private2) |
Particular account |
ES8520950081131010646982 |
|||
| AcctPsuDefPriv5 (3rd account of the PsuDefault-Private1) |
Particular account |
ES9820809181136339531758 |
|||
| Corporateaccount of PsuDefault-Corporate1 (Company account of PsuDefault-Corporate1) |
Company account |
NA |
|||
| Corporateaccount of PsuDefault-Corporate2 (Company account of PsuDefault-Corporate2) |
Company account |
NA |
|||