| Page Properties | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
|
...
| Version | Date | Author | Comments |
|---|---|---|---|
| 3.0 | OB R/W API Team | This is the baseline version. No change from RC3. | |
| 3.1-draft1 | OB R/W API Team | This is the initial draft version for 3.1 Errata:
| |
| 3.1-draft2 | OB R/W API Team | No Change | |
| 3.1-draft3 | OB R/W API Team | Draft 3 Changes:
Errata
| |
| 3.1 | OB R/w API Team | Version 3.1 final release. No changes from Version 3.1 RC1. |
Endpoints
| Resource | HTTP Operation | Endpoint | Mandatory ? | Scope | Grant Type | Message Signing | Idempotency Key | Request Object | Response Object |
|---|---|---|---|---|---|---|---|---|---|
| funds-confirmation | POST | POST /funds-confirmations | Mandatory | fundsconfirmations | Authorization Code | No | No | OBFundsConfirmation1 | OBFundsConfirmationResponse1 |
...
- Request to POST /funds-confirmations
UML Diagram
Notes:
- Funds can only be confirmed against the currency of the account, ASPSP must reject the request when Amount is in a different currency than the currency of the underlying account.
Data Dictionary
| Name | Occurrence | XPath | EnhancedDefinition | Class | Codes |
|---|---|---|---|---|---|
| OBFundsConfirmation1 | OBFundsConfirmation1 | OBFundsConfirmation1 | |||
| Data | 1..1 | OBFundsConfirmation1/Data | OBFundsConfirmationData1 | ||
| ConsentId | 1..1 | OBFundsConfirmation1/Data/ConsentId | Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent resource. | Max128Text | |
| Reference | 1..1 | OBFundsConfirmation1/Data/Reference | Unique reference, as assigned by the CBPII, to unambiguously refer to the request related to the payment transaction. | Max35Text | |
| InstructedAmount | 1..1 | OBFundsConfirmation1/Data/InstructedAmount | Amount of money to be confirmed as available funds in the debtor account. Contains an Amount and a Currency. | OBActiveOrHistoricCurrencyAndAmount | |
| Amount | 1..1 | OBFundsConfirmation1/Data/InstructedAmount/Amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. | OBActiveCurrencyAndAmount_SimpleType | ^\d{1,13}\.\d{1,5}$ |
| Currency | 1..1 | OBFundsConfirmation1/Data/InstructedAmount/Currency | A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". | ActiveOrHistoricCurrencyCode | ^[A-Z]{3,3}$ |
...