Funds Confirmations
Create Confirmation of Funds Request
POST /cbpii/funds-confirmations
Endpoint to which CBPIIs can submit confirmation of funds requests. The response will indicate whether or not the relevant account has the amount of funds available as specified in the request.
Request Arguments
| Parameter | Description |
|---|---|
accessToken Required | The access token you were provided. |
ConsentId Required | A unique identifier for the consent. This value should be used by the TPP in subsequent requests to reference the consent. |
Reference Required | Unique reference, as assigned by the CBPII, to unambiguously refer to the request related to the payment transaction. |
Amount Required | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. |
Currency Required | 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". |
$ curl "https://open-banking.capitalone.co.uk/open-banking/v3.1/cbpii/funds-confirmations" \
-H "accept: application/json" \
-H "Content-Type: application/json" \
-H 'Authorization: Bearer $accessToken' \
-d '{"Data":{"ConsentId":"{{ConsentId}}","Reference":"UNIQUE Reference","InstructedAmount":{"Amount":"0.01","Currency":"GBP"}}}'
Response Arguments
| Parameter | Description |
|---|---|
FundsConfirmationId | Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation resource. |
ConsentId | A unique identifier for the consent. This value should be used by the TPP in subsequent requests to reference the consent. |
CreationDateTime | The Date/Time (UTC) that the confirmation of funds was created. |
FundsAvailable | A boolean value referring to whether or not the funds are available. |
Reference | Unique reference, as assigned by the CBPII, to unambiguously refer to the request related to the payment transaction. |
Amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. |
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". |
TotalPages | The total number of pages available in the response. |
Self | An absolute URL that references this resource. |
Example 201 Response
{
"Data": {
"FundsConfirmationId": "string",
"ConsentId": "string",
"CreationDateTime": "2019-11-07T18:28:28.062Z",
"FundsAvailable": true,
"Reference": "string",
"InstructedAmount": {
"Amount": "string",
"Currency": "GBP"
}
},
"Links": {
"Self": "string"
},
"Meta": {
"TotalPages": 1
}
}