Version 3.0.0
Changes related to version 3.0.0
Payment product
When initiating a payment, you must tell which kind of payment you want to do in the new field paymentProduct of payment initiation request.
The available payment products for a connector are found in the payment options /ob/pis/payments/options/{connectorId}.
The values for this new field are:
- 0: Domestic;
- 1: SEPA;
- 2: CrossBorder.
This field is located at the root of the payment initiation request (partial):
{
"recipient": {...},
"debtor": {...},
"psuUserAgent": "string",
"paymentProduct": 0|1|2
}
Revamping Docker endpoints
We have revamped the Docker endpoints to improve the readability and to gather related things together.
Here are the matching list of old/new method and endpoints.
Changed methods are bold & italic
Open Banking
method | endpoint | > | method | endpoint | comment |
---|---|---|---|---|---|
Get | /Ais/banks | Get | /ob/banks | ||
Post | /Ais/gw/user/register | Post | /ob/gw/users | ||
Put | /Ais/gw/user/{id} | Put | /ob/gw/users/{id} | ||
Get | /Ais/gw/user/{id} | Get | /ob/gw/users/{id} | ||
Get | /Ais/gw/tc/latest | Get | /ob/gw/tc/latest | ||
Get | /Ais/gw/tc/latest/{id} | Get | /ob/gw/users/{id}/tc/latest | ||
Post | /Ais/user/register | Post | /ob/users | ||
Get | /Ais/access/option/{connectorId} | Get | /ob/ais/access/options/{connectorId} | ||
Post | /Ais/access | Post | /ob/ais/access | ||
Get | /Ais/access/findFlowId | Get | /ob/findFlowId | ||
Post | /Ais/access/finalize | Put | /ob/ais/access | ||
Post | /Ais/access/deleteAccount | Put | /ob/ais/accounts/delete | ||
Post | /Ais/access/deleteConsent | Put | /ob/ais/consents/delete | ||
Post | /Ais/accounts | Post | /ob/ais/accounts | ||
Post | /Ais/accounts/{accountId}/balances | Post | /ob/ais/accounts/{accountId}/balances | ||
Post | /Ais/accounts/{accountId}/transactions | Post | /ob/ais/accounts/{accountId}/transactions | ||
Post | /Ais/accounts/{accountId}/transactions/next | Post | /ob/ais/accounts/{accountId}/transactions/next | ||
N/A | |||||
Get | /Pis/payment/options/{connectorId} | Get | /ob/pis/payments/options/{connectorId} | ||
Post | /Pis/payment | Post | /ob/pis/payments | ||
Post | /Pis/payment/finalize | Put | /ob/pis/payments | ||
Post | /Pis/payment/status | Post | /ob/pis/payments/status |
Premium: Bank of America
method | endpoint | > | method | endpoint | comment |
---|---|---|---|---|---|
Post | /BankOfAmerica/user/register | Post | /pb/BankOfAmerica/users | ||
Post | /BankOfAmerica/ais/accounts/{accountNumber}/balances | Post | /pb/BankOfAmerica/ais/accounts/{accountId}/balances | ||
Post | /BankOfAmerica/ais/accounts/{accountNumber}/transactions | Post | /pb/BankOfAmerica/ais/accounts/{accountId}/transactions |
Premium: Citi Institutional
method | endpoint | > | method | endpoint | comment |
---|---|---|---|---|---|
Post | /CitiInstitutional/user/register | Post | /pb/CitiInstitutional/users | ||
Post | /CitiInstitutional/ais/accounts/{accountId}/balances | Post | /pb/CitiInstitutional/ais/accounts/{accountId}/balances |
Premium: DeutscheBank
method | endpoint | > | method | endpoint | comment |
---|---|---|---|---|---|
Post | /DeutscheBank/user/register | Post | /pb/DeutscheBank/users | ||
Get | /DeutscheBank/ais/access/option | Get | /pb/DeutscheBank/ais/access/options | ||
Post | /DeutscheBank/ais/access | Post | /pb/DeutscheBank/ais/access | ||
Post | /DeutscheBank/ais/access/finalize | Put | /pb/DeutscheBank/ais/access | ||
Post | /DeutscheBank/ais/access/deleteAccount | Put | /pb/DeutscheBank/ais/accounts/delete | ||
Post | /DeutscheBank/ais/access/deleteConsent | Put | /pb/DeutscheBank/ais/consents/delete | ||
Post | /DeutscheBank/ais/accounts | Post | /pb/DeutscheBank/ais/accounts | ||
Post | /DeutscheBank/ais/accounts/{accountId}/balances | Post | /pb/DeutscheBank/ais/accounts/{accountId}/balances | ||
Post | /DeutscheBank/ais/accounts/{accountId}/transactions | Post | /pb/DeutscheBank/ais/accounts/{accountId}/transactions | ||
Post | /DeutscheBank/ais/accounts/{accountId}/transactions/next | Post | /pb/DeutscheBank/ais/accounts/{accountId}/transactions/next | ||
N/A | |||||
Get | /DeutscheBank/pis/payment/options | Get | /pb/DeutscheBank/pis/payments/options | ||
Post | /DeutscheBank/pis/payment | Post | /pb/DeutscheBank/pis/payments | ||
Post | /DeutscheBank/pis/payment/finalize | Put | /pb/DeutscheBank/pis/payments | ||
Post | /DeutscheBank/pis/payment/status | Post | /pb/DeutscheBank/pis/payments/status |
Premium: JP Morgan
method | endpoint | > | method | endpoint | comment |
---|---|---|---|---|---|
Post | /JpMorgan/user/register | Post | /pb/JpMorgan/users | ||
Post | /JpMorgan/ais/accounts/{accountId}/balances | Post | /pb/JpMorgan/ais/accounts/{accountId}/balances | ||
Post | /JpMorgan/ais/accounts/{accountId}/transactions | Post | /pb/JpMorgan/ais/accounts/{accountId}/transactions |
Moved AdditionalPropertiesRequested List in payment options
This list of properties that must/may be given to the payment request is now in the context of the payment products (sepaCreditTransfers, instantSepaCreditTransfers, domesticCreditTransfers...).
The structure remains the same.
In the previous version, it was located at the root of the options. For upwards compatibility, the field is still there but it is obsolete.
Partial old structure:
{
"sepaCreditTransfers":{...}
"additionalPropertiesRequested": [
{
"name": "userId",
"title": "User ID",
"required": false,
"description": "Swedish social security number in the format YYYYMMDDXXXX",
"template": "^(19|20)\\d{2}[01]\\d[0-3]\\d\\d{4}$"
}
]
}
The new location is sepaCreditTransfers.additionalPropertiesRequested.
Partial:
{
"sepaCreditTransfers": {
"paymentInitiationRequestOptions": {...}
"additionalPropertiesRequested": [
{
"name": "userId",
"title": "User ID",
"required": false,
"description": "Swedish social security number in the format YYYYMMDDXXXX",
"template": "^(19|20)\\d{2}[01]\\d[0-3]\\d\\d{4}$"
}
]
}
}
Removed DebtorIban field in payment options.
The field DebtorIban located at options structure root is removed in favor of accountIdentification for each payment products (sepaCreditTransfers, instantSepaCreditTransfers, domesticCreditTransfers...).
Example path for SEPA options: sepaCreditTransfers.paymentInitiationRequestOptions.debtor.accountIdentification
Values are
- 0: Required
- 1: Optional
- 2: Unused
Here is a partial structure of options:
{
"sepaCreditTransfers": {
"paymentInitiationRequestOptions": {
"debtor": {
"accountIdentification": 0
}
}
}
}