3.1. Confirmation of funds (COF)
3.1. Confirmation of funds (COF)
GET/api/v1/funds-confirmation
Inquiry payments and details.
Path parameters
No path parameters
Query parameters
No query parameters.
Request headers
| Attribute | Type | Condition | Description |
|---|---|---|---|
| X-Request-ID | UUID | Mandatory | ID of the request, unique to the call, as determined by the initiating party (TPP). |
| Authorization | String | Mandatory | The oAuth2 Bearer token obtained from the performed SCA performed prior to this request. |
| TPP-Redirect-URI | String | Mandatory | URI of the TPP, where the transaction flow shall be redirected to after a Redirect. |
| Consent-ID | UUID | Mandatory | The consent ID of the related AIS consent. |
Request body
| Attribute | Type | Condition | Description |
|---|---|---|---|
| account | Card Account | Mandatory |
Reference to an account by IBAN or masked PAN. The masked PAN should apply to pattern 123456xxxxxx1234 The IBAN should apply to pattern [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30} |
| instructedAmount | Object | Mandatory | The amount given with fractional digits, where fractions must be compliant to the currency definition. |
| amount | String | Mandatory |
Up to 14 significant digits, Negative amounts are signed my minus. The decimal separator is a dot. Pattern: -?[0-9]{1,14}(\.[0-9]{1,3})? |
| currency | String | Mandatory |
ISO 4217 Alpha 3 currency code. Pattern: [A-Z]{3} |
Response Code
HTTP Response Code 200 (OK).
Response headers
| Attribute | Type | Condition | Description |
|---|---|---|---|
| X-Request-ID | UUID | Mandatory | ID of the request, unique to the call, as determined by the initiating party (TPP). |
| Location | String | Mandatory | Location of the created resource. |
| ASPSP-SCA-Approach | String | Mandatory | REDIRECT. |
Response body
| Attribute | Type | Condition | Description |
|---|---|---|---|
| fundsAvailable | Boolean | Mandatory | Equals true if sufficient funds are available at the time of the request, false otherwise. |