Main page - Openbank


Documentation Download:

Domains
Production API
https://apis-i.redsys.es:20443/psd2/xs2a/api-entrada-xs2a/services/openbank		 Sandbox oAuth-API
https://apis-i.redsys.es:20443/psd2/xs2a/api-oauth-xs2a/services/rest/openbank 
Production API
https://psd2.redsys.es/api-entrada-xs2a/services/openbank		 Production oAuth-API
https://hubpsd2.redsys.es/api-oauth-xs2a/services/rest/openbank 

Entity Configuration:

Payment Initiation Service (PIS)

SIMPLE PAYMENT INITIATION
Payment Start
POST payments/{payment-product}		 Payment Product Supported sepa-credit-transfers
cross-border-credit-transfers
Future payment start support
(New field requestedExecutionDate)		 sepa-credit-transfers
cross-border-credit-transfers
Payment status
GET payments/{payment-product}/{paymentId}/status
Get payment
GET payments/{payment-product}/{paymentId}
Payment Execution
PUT payments/{payment-product}/{paymentId}
Authorize payment start
POST payments/{payment-product}/{paymentId}/authorisations
Get list of authorization sub-resources
GET payments/{payment-product}/{paymentId}/authorisations
SCA authorization status
GET payments/{payment-product}/{paymentId}/authorisations/{authorisationId}
Permanent order to initiate periodic / recurring payments
Start of periodic payment/recurrente
POST periodic-payments/{payment-product}		 Payment Product Supported sepa-credit-transfers
cross-border-credit-transfers
Periodic payment status/recurrente
GET periodic-payments/{payment-product}/{paymentId}/status
Get payment periodic/recurrente
GET periodic-payments/{payment-product}/{paymentId}
SCA authorization status
GET periodic-payments/{payment-product}/{paymentId}/authorisations/{authorisationId}
Cancel periodic payment/recurrente
DELETE periodic-payments/{payment-product}/{paymentId}

Account access service (AIS)

Manage consent
General Sessions combinedServiceIndicator
Request consent
POST {provider}/v1/consents		 Detailed consent
(Detailed consent)		 Request access type "accounts", "balances" and / or "transactions" indicating the accounts related to the requested consents
Bank offered consent

(Bank offered consent)		 Request access type "accounts", "balances" and / or "transactions" without indicating the related accounts
Consent status
GET /v1/consents/{consentId}/status
Get consent
GET /v1/consents/{consentId}
Remove consent
DELETE /v1/consents/{consentId}
SCA authorization status
GET consents/{consentId}/authorisations/{authorisationId}
Account Reading
Get list of available accounts
GET {provider}/{aspsp}/v1/accounts{query-parameters}		 No balance
With balance
Get account details
GET {provider}/{aspsp}/v1/accounts{query-parameters}		 Get dedicated account details (single account) No balance
With balance
Get account details from the list of accessible accounts No balance
With balance
Get balances for a given account
GET {provider}/{aspsp}/v1/accounts/{account-id}/balances
Get transaction information for a specific account
GET {provider}/{aspsp}/v1/accounts/{account-id}/transactions{query-parameters}		 Include balances No balance
With balance
Search Filters DateFrom - dateTo support

Access to fund consultation service

Fund inquiry
Query

POST /v1/funds-confirmations		 Without indicating the card number

Added Value Services (SVA)

PAYMENT START WITH LIST OF ACCOUNTS AVAILABLE FOR PISP
SVA payment start


POST /v1/sva/payments/{payment-product}

 Payment Product Supported sepa-credit-transfers
instant-sepa-credit-transfers
target-2-payments
cross-border-credit-transfers

Authentication

SCA
SCA Redirect Only redirect

PSU profiles

Standard PSU Profiles
Profile Code Account properties Account data PSU-ID Supported payment products Special features
PsuDefault-Private Particular account AcctPsuDefPriv1
AcctPsuDefPriv2
AcctPsuDefPriv5		 ID: user1
Pass: 1234		 All supported by the ASPSP SCA OK result
PsuDefault-Private Particular account AcctPsuDefPriv3
AcctPsuDefPriv4		 ID: user2
Pass: 1234		 All supported by the ASPSP SCA KO Result
PsuDefault-Private Company account with multilevel SCA AcctPsuDefCorp1 ID: user1
Pass: 1234		 All supported by the ASPSP SCA OK result
PsuDefault-Private Company account with multilevel SCA AcctPsuDefCorp1 ID: user2
Pass: 1234		 All supported by the ASPSP  
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 ES7300730100109999999991
AcctPsuDefPriv2
(2nd account of the PsuDefault-Private1)		 Particular account ES2800730100208888888882
AcctPsuDefPriv3
(1st account of the PsuDefault-Private2)		 Particular account ES1900730100109999999993
AcctPsuDefPriv4
(2nd account of the PsuDefault-Private2)		 Particular account ES7100730100208888888884
AcctPsuDefPriv5
(3rd account of the PsuDefault-Private1)		 Particular account ES6200730100109999999995
Corporateaccount of PsuDefault-Corporate1
(Company account of PsuDefault-Corporate1)		 Company account ES1700730100208888888886
Corporateaccount of PsuDefault-Corporate2
(Company account of PsuDefault-Corporate2)		 Company account ES8700730100208888888887