Clarified use of Idempotency Key in endpoint table.
3.0-draft4
OB R/W API Team
Errata - made the Reference definition consistent across both the funds-confirmation request and response.
3.0-draft7
OB R/W API Team
No Change
3.0-RC2
OB R/W API Team
No Change
3.0-RC3
OB R/W API Team
No Change
3.0
OB R/W API Team
This is the baseline version. No change from RC3.
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
POST /funds-confirmations
Code Block
language
text
theme
Midnight
firstline
1
title
Funds Confirmation Endpoint
linenumbers
true
POST /funds-confirmations
...
The ASPSP creates the funds-confirmation resource and responds with a unique FundsConfirmationId to refer to the resource, and a flag confirming if funds are available.
The CBPII must use a token issued via authorization code grant and specify the ConsentId in the request payload.
This CBPII must use a currency of the account.
Data Model
This data dictionary section gives the detail on the payload content.
Funds Confirmation - Request
The OBFundsConfirmation1 object will be used for the following:
Request to POST /funds-confirmations
UML Diagram
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.
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}$
Funds Confirmation - Response
The OBFundsConfirmationResponse1 object will be used for the following:
Response to POST /funds-confirmations
UML Diagram
Notes:
The OBFundsConfirmationResponse1 object contains the same information as the OBFundsConfirmation1 - but with additional fields:
FundsConfirmationId - to uniquely identify the funds-confirmation resource
FundsAvailable - to indicate the result of a confirmation of funds check.
CreationDateTime - to indicate when the resource was created
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".