Confirmation of Funds PSD2
Summary
The Funds Confirmation API allows a TPP to check the availability of funds in CPB client's authorized accounts through a secure interface.
The sandbox provides synthetic data to enable a TPP to explore the API and perform preliminary functional testing on a simulated environment. The calls to the API will be validated for correctness and compliance with the API specification to help the TPP uncover issues early when integrating with the API.
Below are some sample test data and unique identifiers that can be used for invoking the APIs and for recreating specific scenarios for validation and testing by the TPP.
Test Data
| Consent ID | Funds Available |
|---|---|
| 9COF201999664300 | Yes |
| 9COF201999664302 | No |
Some of the notable differences between the sandbox and market integrated interface are listed below:
- Sandbox uses a primarily stateless interaction model where some states such as the account balance is kept constant.
- The sandbox implements an OAuth 2.0 based Authentication and Authorization flow. In addition to using the API Playground to invoke the APIs, the API keys retrieved while registering an application can be used for calling the APIs from any REST client, such as curl, Postman, SoapUI, or programmatically through REST calls using access tokens retrieved either through a Client Credential or Authorization Code grant types depending on the API being invoked.
- As the sandbox is open to both TPPs and the general public, the following validations will be deferred to the integration environments: verification of TPP identity, SSA, EIDAS, QSEAL, QWAC certificates, mutual TLS. These validations will be available in the fully functional market integrated interfaces with valid Competent Authority issued certificates.
- 3-legged authentication requests for this API must be of the 'cpb_ob_fundsconfirmations' scope whereas in the market integrated version the scope would be 'fundsconfirmations'.
- Please use the scope '/api' for client_credential grant type in sandbox whereas in market integrated version use 'openid' and 'fundsconfirmations'.
- Date related validations are deferred to the market integration version as sandbox responses are static in nature.
| post /open-banking/v3.1/cbpii/funds-confirmation-consents | Creates funds confirmation consent |
| get /open-banking/v3.1/cbpii/funds-confirmation-consents/{ConsentId} | Retrieve funds confirmation consent |
| delete /open-banking/v3.1/cbpii/funds-confirmation-consents/{ConsentId} | Delete funds confirmation consent |
| post /open-banking/v3.1/cbpii/funds-confirmations | Create funds confirmation |
Creates funds confirmation consent
post
/open-banking/v3.1/cbpii/funds-confirmation-consents
Request CPB to create a new funds-confirmation-consent resource which effectively allows the TPP to send a copy of the consent to CPB to authorise access to funds confirmation resource. Prior to calling the API, the TPP must have an access token issued by the CPB using a client credentials grant.
SwaggerBody Parameters
OBFundsConfirmationConsent1Param
required
Default
Show schema
×
object: OBFundsConfirmationConsent1
{
"type": "object",
"properties": {
"Data": {
"type": "object",
"properties": {
"ExpirationDateTime": {
"description": "Specified date and time the funds confirmation authorisation will expire.\n If this is not populated, the authorisation will be open ended.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format.\nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00",
"type": "string",
"format": "date-time",
"example": "2017-05-02T00:00:00+00:00"
},
"DebtorAccount": {
"description": "Unambiguous identification of the account of the debtor to which a confirmation of funds consent will be applied.",
"type": "object",
"properties": {
"SchemeName": {
"description": "Name of the identification scheme, in a coded form as published in an external list.",
"type": "string",
"example": "UK.OBIE.BBAN",
"minLength": 1,
"maxLength": 40
},
"Identification": {
"description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
"type": "string",
"minLength": 1,
"maxLength": 256,
"example": "GB76LOYD30949301273801"
},
"Name": {
"description": "Name of the account, as assigned by the account servicing institution.\nUsage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"SecondaryIdentification": {
"description": "This is secondary identification of the account, as assigned by the account servicing institution.\nThis can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).",
"type": "string",
"minLength": 1,
"maxLength": 34,
"example": "Roll 56988"
}
},
"required": [
"SchemeName",
"Identification"
],
"additionalProperties": false
}
},
"required": [
"DebtorAccount"
],
"additionalProperties": false
}
},
"required": [
"Data"
],
"additionalProperties": false
}Header Parameters
Accept
string
required
application/json
x-fapi-financial-id
string
required
The unique ID of CPB to which the request is issued. Please use the ID CT_9001 for testing in sandbox. Note this not a real x-fapi-financial-id issued by OB.
x-fapi-customer-last-logged-time
string
Optional
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
string
Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string
Optional
An RFC4122 UID used as a correlation id.
Authorization
string
required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string
Optional
Indicates the user-agent that the PSU is using.
client_id
string
required
Client Id generated during application registration
- cURL
- Ruby
- Python
- PHP
- Java
- Node
- Go
- Swift
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
201
Funds Confirmation Consent Created
Definitions
-
Data
-
-
ConsentId
- Unique identification as assigned to identify the funds confirmation consent resource.
- type : string
- minLength : 1
- maxLength : 128
-
CreationDateTime
- Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- type : string
- format : date-time
-
Status
- Specifies the status of consent resource in code form.
- type : string
- enum : Authorised, AwaitingAuthorisation, Rejected, Revoked
-
StatusUpdateDateTime
- Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- type : string
- format : date-time
-
ExpirationDateTime
- Specified date and time the funds confirmation authorisation will expire. If this is not populated, the authorisation will be open ended. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- type : string
- format : date-time
-
DebtorAccount
- Unambiguous identification of the account of the debtor to which a confirmation of funds consent will be applied.
- type : object
- properties : Array
- required : Array
- additionalProperties :
-
ConsentId
-
-
Links
-
-
Self
- type : string
- format : uri
-
Self
-
-
Meta
-
-
TotalPages
- type : integer
- format : int32
-
TotalPages
-
Example Response for post
/open-banking/v3.1/cbpii/funds-confirmation-consents
400
Bad request
Definitions
-
Code
- High level textual error code, to help categorize the errors.
- type : string
- minLength : 1
- maxLength : 40
-
Id
- A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
- type : string
- minLength : 1
- maxLength : 40
-
Message
- Brief Error message, e.g., 'There is something wrong with the request parameters provided'
- type : string
- minLength : 1
- maxLength : 500
-
Errors
-
-
ErrorCode
- Low level textual error code, e.g., UK.OBIE.Field.Missing
- type : string
- minLength : 1
- maxLength : 128
-
Message
- A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
- type : string
- minLength : 1
- maxLength : 500
-
ErrorCode
-
Response Schema for post
/open-banking/v3.1/cbpii/funds-confirmation-consents
{
"description": "An array of detail error codes, and messages, and URLs to documentation to help remediation.",
"type": "object",
"properties": {
"Code": {
"description": "High level textual error code, to help categorize the errors.",
"type": "string",
"minLength": 1,
"maxLength": 40,
"example": "RequestValidationError"
},
"Id": {
"description": "A unique reference for the error instance, for audit purposes, in case of unknown\/unclassified errors.",
"type": "string",
"minLength": 1,
"maxLength": 40,
"example": "c09206d3-9d44-49a7-99c3-277386cadd1c"
},
"Message": {
"description": "Brief Error message, e.g., 'There is something wrong with the request parameters provided'",
"type": "string",
"minLength": 1,
"maxLength": 500,
"example": "There is something wrong with the request paramaters provided"
},
"Errors": {
"items": {
"type": "object",
"properties": {
"ErrorCode": {
"description": "Low level textual error code, e.g., UK.OBIE.Field.Missing",
"type": "string",
"minLength": 1,
"maxLength": 128,
"example": "UK.OBIE.Field.Invalid"
},
"Message": {
"description": "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBIE doesn't standardise this field",
"type": "string",
"minLength": 1,
"maxLength": 500,
"example": "RequestedExecutionDateTime must be in future"
},
"Path": {
"description": "Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Url": {
"description": "URL to help remediate the problem, or provide more information, or to API Reference, or help etc",
"type": "string"
}
},
"required": [
"ErrorCode",
"Message"
],
"additionalProperties": false,
"minProperties": 1
},
"type": "array",
"minItems": 1
}
},
"required": [
"Code",
"Message",
"Errors"
],
"additionalProperties": false
}
401
Unauthorized
This operation returns no content.
403
Forbidden
This operation returns no content.
404
Not found
This operation returns no content.
405
Method Not Allowed
This operation returns no content.
406
Not Acceptable
This operation returns no content.
415
Unsupported Media Type
This operation returns no content.
429
Too Many Requests
This operation returns no content.
500
Internal Server Error
Definitions
-
Code
- High level textual error code, to help categorize the errors.
- type : string
- minLength : 1
- maxLength : 40
-
Id
- A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
- type : string
- minLength : 1
- maxLength : 40
-
Message
- Brief Error message, e.g., 'There is something wrong with the request parameters provided'
- type : string
- minLength : 1
- maxLength : 500
-
Errors
-
-
ErrorCode
- Low level textual error code, e.g., UK.OBIE.Field.Missing
- type : string
- minLength : 1
- maxLength : 128
-
Message
- A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
- type : string
- minLength : 1
- maxLength : 500
-
ErrorCode
-
Response Schema for post
/open-banking/v3.1/cbpii/funds-confirmation-consents
{
"description": "An array of detail error codes, and messages, and URLs to documentation to help remediation.",
"type": "object",
"properties": {
"Code": {
"description": "High level textual error code, to help categorize the errors.",
"type": "string",
"minLength": 1,
"maxLength": 40,
"example": "RequestValidationError"
},
"Id": {
"description": "A unique reference for the error instance, for audit purposes, in case of unknown\/unclassified errors.",
"type": "string",
"minLength": 1,
"maxLength": 40,
"example": "c09206d3-9d44-49a7-99c3-277386cadd1c"
},
"Message": {
"description": "Brief Error message, e.g., 'There is something wrong with the request parameters provided'",
"type": "string",
"minLength": 1,
"maxLength": 500,
"example": "There is something wrong with the request paramaters provided"
},
"Errors": {
"items": {
"type": "object",
"properties": {
"ErrorCode": {
"description": "Low level textual error code, e.g., UK.OBIE.Field.Missing",
"type": "string",
"minLength": 1,
"maxLength": 128,
"example": "UK.OBIE.Field.Invalid"
},
"Message": {
"description": "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBIE doesn't standardise this field",
"type": "string",
"minLength": 1,
"maxLength": 500,
"example": "RequestedExecutionDateTime must be in future"
},
"Path": {
"description": "Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Url": {
"description": "URL to help remediate the problem, or provide more information, or to API Reference, or help etc",
"type": "string"
}
},
"required": [
"ErrorCode",
"Message"
],
"additionalProperties": false,
"minProperties": 1
},
"type": "array",
"minItems": 1
}
},
"required": [
"Code",
"Message",
"Errors"
],
"additionalProperties": false
}Retrieve funds confirmation consent
get
/open-banking/v3.1/cbpii/funds-confirmation-consents/{ConsentId}
Retrieve funds confirmation consent resource for a given ConsentId. Prior to calling this operation, the TPP must have an access token issued by the CPB using a client credentials grant.
Path Parameters
ConsentId
string
required
ConsentId
Header Parameters
Accept
string
required
application/json
x-fapi-financial-id
string
required
The unique ID of CPB to which the request is issued. Please use the ID CT_9001 for testing in sandbox. Note this not a real x-fapi-financial-id issued by OB.
x-fapi-customer-last-logged-time
string
Optional
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
string
Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string
Optional
An RFC4122 UID used as a correlation id.
Authorization
string
required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string
Optional
Indicates the user-agent that the PSU is using.
client_id
string
required
Client Id generated during application registration
- cURL
- Ruby
- Python
- PHP
- Java
- Node
- Go
- Swift
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
200
Funds Confirmation Consent Read
Definitions
-
Data
-
-
ConsentId
- Unique identification as assigned to identify the funds confirmation consent resource.
- type : string
- minLength : 1
- maxLength : 128
-
CreationDateTime
- Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- type : string
- format : date-time
-
Status
- Specifies the status of consent resource in code form.
- type : string
- enum : Authorised, AwaitingAuthorisation, Rejected, Revoked
-
StatusUpdateDateTime
- Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- type : string
- format : date-time
-
ExpirationDateTime
- Specified date and time the funds confirmation authorisation will expire. If this is not populated, the authorisation will be open ended. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- type : string
- format : date-time
-
DebtorAccount
- Unambiguous identification of the account of the debtor to which a confirmation of funds consent will be applied.
- type : object
- properties : Array
- required : Array
- additionalProperties :
-
ConsentId
-
-
Links
-
-
Self
- type : string
- format : uri
-
Self
-
-
Meta
-
-
TotalPages
- type : integer
- format : int32
-
TotalPages
-
Example Response for get
/open-banking/v3.1/cbpii/funds-confirmation-consents/{ConsentId}
400
Bad request
Definitions
-
Code
- High level textual error code, to help categorize the errors.
- type : string
- minLength : 1
- maxLength : 40
-
Id
- A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
- type : string
- minLength : 1
- maxLength : 40
-
Message
- Brief Error message, e.g., 'There is something wrong with the request parameters provided'
- type : string
- minLength : 1
- maxLength : 500
-
Errors
-
-
ErrorCode
- Low level textual error code, e.g., UK.OBIE.Field.Missing
- type : string
- minLength : 1
- maxLength : 128
-
Message
- A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
- type : string
- minLength : 1
- maxLength : 500
-
ErrorCode
-
Response Schema for get
/open-banking/v3.1/cbpii/funds-confirmation-consents/{ConsentId}
{
"description": "An array of detail error codes, and messages, and URLs to documentation to help remediation.",
"type": "object",
"properties": {
"Code": {
"description": "High level textual error code, to help categorize the errors.",
"type": "string",
"minLength": 1,
"maxLength": 40,
"example": "RequestValidationError"
},
"Id": {
"description": "A unique reference for the error instance, for audit purposes, in case of unknown\/unclassified errors.",
"type": "string",
"minLength": 1,
"maxLength": 40,
"example": "c09206d3-9d44-49a7-99c3-277386cadd1c"
},
"Message": {
"description": "Brief Error message, e.g., 'There is something wrong with the request parameters provided'",
"type": "string",
"minLength": 1,
"maxLength": 500,
"example": "There is something wrong with the request paramaters provided"
},
"Errors": {
"items": {
"type": "object",
"properties": {
"ErrorCode": {
"description": "Low level textual error code, e.g., UK.OBIE.Field.Missing",
"type": "string",
"minLength": 1,
"maxLength": 128,
"example": "UK.OBIE.Field.Invalid"
},
"Message": {
"description": "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBIE doesn't standardise this field",
"type": "string",
"minLength": 1,
"maxLength": 500,
"example": "RequestedExecutionDateTime must be in future"
},
"Path": {
"description": "Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Url": {
"description": "URL to help remediate the problem, or provide more information, or to API Reference, or help etc",
"type": "string"
}
},
"required": [
"ErrorCode",
"Message"
],
"additionalProperties": false,
"minProperties": 1
},
"type": "array",
"minItems": 1
}
},
"required": [
"Code",
"Message",
"Errors"
],
"additionalProperties": false
}
401
Unauthorized
This operation returns no content.
403
Forbidden
This operation returns no content.
404
Not found
This operation returns no content.
405
Method Not Allowed
This operation returns no content.
406
Not Acceptable
This operation returns no content.
429
Too Many Requests
This operation returns no content.
500
Internal Server Error
Definitions
-
Code
- High level textual error code, to help categorize the errors.
- type : string
- minLength : 1
- maxLength : 40
-
Id
- A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
- type : string
- minLength : 1
- maxLength : 40
-
Message
- Brief Error message, e.g., 'There is something wrong with the request parameters provided'
- type : string
- minLength : 1
- maxLength : 500
-
Errors
-
-
ErrorCode
- Low level textual error code, e.g., UK.OBIE.Field.Missing
- type : string
- minLength : 1
- maxLength : 128
-
Message
- A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
- type : string
- minLength : 1
- maxLength : 500
-
ErrorCode
-
Response Schema for get
/open-banking/v3.1/cbpii/funds-confirmation-consents/{ConsentId}
{
"description": "An array of detail error codes, and messages, and URLs to documentation to help remediation.",
"type": "object",
"properties": {
"Code": {
"description": "High level textual error code, to help categorize the errors.",
"type": "string",
"minLength": 1,
"maxLength": 40,
"example": "RequestValidationError"
},
"Id": {
"description": "A unique reference for the error instance, for audit purposes, in case of unknown\/unclassified errors.",
"type": "string",
"minLength": 1,
"maxLength": 40,
"example": "c09206d3-9d44-49a7-99c3-277386cadd1c"
},
"Message": {
"description": "Brief Error message, e.g., 'There is something wrong with the request parameters provided'",
"type": "string",
"minLength": 1,
"maxLength": 500,
"example": "There is something wrong with the request paramaters provided"
},
"Errors": {
"items": {
"type": "object",
"properties": {
"ErrorCode": {
"description": "Low level textual error code, e.g., UK.OBIE.Field.Missing",
"type": "string",
"minLength": 1,
"maxLength": 128,
"example": "UK.OBIE.Field.Invalid"
},
"Message": {
"description": "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBIE doesn't standardise this field",
"type": "string",
"minLength": 1,
"maxLength": 500,
"example": "RequestedExecutionDateTime must be in future"
},
"Path": {
"description": "Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Url": {
"description": "URL to help remediate the problem, or provide more information, or to API Reference, or help etc",
"type": "string"
}
},
"required": [
"ErrorCode",
"Message"
],
"additionalProperties": false,
"minProperties": 1
},
"type": "array",
"minItems": 1
}
},
"required": [
"Code",
"Message",
"Errors"
],
"additionalProperties": false
}Delete funds confirmation consent
delete
/open-banking/v3.1/cbpii/funds-confirmation-consents/{ConsentId}
Request CPB to revoke a given funds confirmation consent for the TPP. TPP must delete the funds-confirmation-consent resource with the CPB after getting confirmation about consent revocation from the CPB client. This is done by making a call to DELETE the funds-confirmation-consent resource. Prior to calling the operation, the TPP must have an access token issued by the CPB using a client credentials grant.
Path Parameters
ConsentId
string
required
ConsentId
Header Parameters
Accept
string
required
application/json
x-fapi-financial-id
string
required
The unique ID of CPB to which the request is issued. Please use the ID CT_9001 for testing in sandbox. Note this not a real x-fapi-financial-id issued by OB.
x-fapi-customer-last-logged-time
string
Optional
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
string
Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string
Optional
An RFC4122 UID used as a correlation id.
Authorization
string
required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string
Optional
Indicates the user-agent that the PSU is using.
client_id
string
required
Client Id generated during application registration
- cURL
- Ruby
- Python
- PHP
- Java
- Node
- Go
- Swift
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
204
Funds Confirmation Consent Deleted
This operation returns no content.
400
Bad request
Definitions
-
Code
- High level textual error code, to help categorize the errors.
- type : string
- minLength : 1
- maxLength : 40
-
Id
- A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
- type : string
- minLength : 1
- maxLength : 40
-
Message
- Brief Error message, e.g., 'There is something wrong with the request parameters provided'
- type : string
- minLength : 1
- maxLength : 500
-
Errors
-
-
ErrorCode
- Low level textual error code, e.g., UK.OBIE.Field.Missing
- type : string
- minLength : 1
- maxLength : 128
-
Message
- A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
- type : string
- minLength : 1
- maxLength : 500
-
ErrorCode
-
Response Schema for delete
/open-banking/v3.1/cbpii/funds-confirmation-consents/{ConsentId}
{
"description": "An array of detail error codes, and messages, and URLs to documentation to help remediation.",
"type": "object",
"properties": {
"Code": {
"description": "High level textual error code, to help categorize the errors.",
"type": "string",
"minLength": 1,
"maxLength": 40,
"example": "RequestValidationError"
},
"Id": {
"description": "A unique reference for the error instance, for audit purposes, in case of unknown\/unclassified errors.",
"type": "string",
"minLength": 1,
"maxLength": 40,
"example": "c09206d3-9d44-49a7-99c3-277386cadd1c"
},
"Message": {
"description": "Brief Error message, e.g., 'There is something wrong with the request parameters provided'",
"type": "string",
"minLength": 1,
"maxLength": 500,
"example": "There is something wrong with the request paramaters provided"
},
"Errors": {
"items": {
"type": "object",
"properties": {
"ErrorCode": {
"description": "Low level textual error code, e.g., UK.OBIE.Field.Missing",
"type": "string",
"minLength": 1,
"maxLength": 128,
"example": "UK.OBIE.Field.Invalid"
},
"Message": {
"description": "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBIE doesn't standardise this field",
"type": "string",
"minLength": 1,
"maxLength": 500,
"example": "RequestedExecutionDateTime must be in future"
},
"Path": {
"description": "Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Url": {
"description": "URL to help remediate the problem, or provide more information, or to API Reference, or help etc",
"type": "string"
}
},
"required": [
"ErrorCode",
"Message"
],
"additionalProperties": false,
"minProperties": 1
},
"type": "array",
"minItems": 1
}
},
"required": [
"Code",
"Message",
"Errors"
],
"additionalProperties": false
}
401
Unauthorized
This operation returns no content.
403
Forbidden
This operation returns no content.
404
Not found
This operation returns no content.
405
Method Not Allowed
This operation returns no content.
406
Not Acceptable
This operation returns no content.
429
Too Many Requests
This operation returns no content.
500
Internal Server Error
Definitions
-
Code
- High level textual error code, to help categorize the errors.
- type : string
- minLength : 1
- maxLength : 40
-
Id
- A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
- type : string
- minLength : 1
- maxLength : 40
-
Message
- Brief Error message, e.g., 'There is something wrong with the request parameters provided'
- type : string
- minLength : 1
- maxLength : 500
-
Errors
-
-
ErrorCode
- Low level textual error code, e.g., UK.OBIE.Field.Missing
- type : string
- minLength : 1
- maxLength : 128
-
Message
- A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
- type : string
- minLength : 1
- maxLength : 500
-
ErrorCode
-
Response Schema for delete
/open-banking/v3.1/cbpii/funds-confirmation-consents/{ConsentId}
{
"description": "An array of detail error codes, and messages, and URLs to documentation to help remediation.",
"type": "object",
"properties": {
"Code": {
"description": "High level textual error code, to help categorize the errors.",
"type": "string",
"minLength": 1,
"maxLength": 40,
"example": "RequestValidationError"
},
"Id": {
"description": "A unique reference for the error instance, for audit purposes, in case of unknown\/unclassified errors.",
"type": "string",
"minLength": 1,
"maxLength": 40,
"example": "c09206d3-9d44-49a7-99c3-277386cadd1c"
},
"Message": {
"description": "Brief Error message, e.g., 'There is something wrong with the request parameters provided'",
"type": "string",
"minLength": 1,
"maxLength": 500,
"example": "There is something wrong with the request paramaters provided"
},
"Errors": {
"items": {
"type": "object",
"properties": {
"ErrorCode": {
"description": "Low level textual error code, e.g., UK.OBIE.Field.Missing",
"type": "string",
"minLength": 1,
"maxLength": 128,
"example": "UK.OBIE.Field.Invalid"
},
"Message": {
"description": "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBIE doesn't standardise this field",
"type": "string",
"minLength": 1,
"maxLength": 500,
"example": "RequestedExecutionDateTime must be in future"
},
"Path": {
"description": "Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Url": {
"description": "URL to help remediate the problem, or provide more information, or to API Reference, or help etc",
"type": "string"
}
},
"required": [
"ErrorCode",
"Message"
],
"additionalProperties": false,
"minProperties": 1
},
"type": "array",
"minItems": 1
}
},
"required": [
"Code",
"Message",
"Errors"
],
"additionalProperties": false
}Create funds confirmation
post
/open-banking/v3.1/cbpii/funds-confirmations
Request CPB to create the funds-confirmation resource to confirm the funds availability. The TPP must use a token issued via an authorization code grant and specify the ConsentId in the request payload and TPP must use a currency of the account.
Body Parameters
OBFundsConfirmation1Param
required
Default
Show schema
×
object: OBFundsConfirmation1
{
"type": "object",
"properties": {
"Data": {
"type": "object",
"properties": {
"ConsentId": {
"description": "Unique identification as assigned by the CPB to uniquely identify the funds confirmation consent resource.",
"type": "string",
"minLength": 1,
"maxLength": 128,
"example": "88379"
},
"Reference": {
"description": "Unique reference, as assigned by the CBPII, to unambiguously refer to the request related to the payment transaction.",
"type": "string",
"minLength": 1,
"maxLength": 35,
"example": "Purchase01"
},
"InstructedAmount": {
"description": "Amount of money to be confirmed as available funds in the debtor account. Contains an Amount and a Currency.",
"type": "object",
"properties": {
"Amount": {
"description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.",
"type": "string",
"pattern": "^\\d{1,13}\\.\\d{1,5}$",
"example": "100.50"
},
"Currency": {
"description": "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\".",
"type": "string",
"pattern": "^[A-Z]{3,3}$",
"example": "GBP"
}
},
"required": [
"Amount",
"Currency"
],
"additionalProperties": false
}
},
"required": [
"ConsentId",
"Reference",
"InstructedAmount"
],
"additionalProperties": false
}
},
"required": [
"Data"
],
"additionalProperties": false
}Header Parameters
Accept
string
required
application/json
x-fapi-financial-id
string
required
The unique ID of CPB to which the request is issued. Please use the ID CT_9001 for testing in sandbox. Note this not a real x-fapi-financial-id issued by OB.
x-fapi-customer-last-logged-time
string
Optional
The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
string
Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string
Optional
An RFC4122 UID used as a correlation id.
Authorization
string
required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string
Optional
Indicates the user-agent that the PSU is using.
client_id
string
required
Client Id generated during application registration
- cURL
- Ruby
- Python
- PHP
- Java
- Node
- Go
- Swift
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
Example Request
201
Funds Confirmation Created
Definitions
-
Data
-
-
FundsConfirmationId
- Unique identification as assigned by the CPB to uniquely identify the funds confirmation resource.
- type : string
- minLength : 1
- maxLength : 40
-
ConsentId
- Unique identification as assigned by the CPB to uniquely identify the funds confirmation consent resource.
- type : string
- minLength : 1
- maxLength : 128
-
CreationDateTime
- Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00
- type : string
- format : date-time
-
FundsAvailable
- Flag to indicate the result of a confirmation of funds check.
- type : boolean
-
Reference
- Unique reference, as assigned by the CBPII, to unambiguously refer to the request related to the payment transaction.
- type : string
- minLength : 1
- maxLength : 35
-
InstructedAmount
- Amount of money to be confirmed as available funds in the debtor account. Contains an Amount and a Currency.
- type : object
- properties : Array
- required : Array
- additionalProperties :
-
FundsConfirmationId
-
-
Links
-
-
Self
- type : string
- format : uri
-
Self
-
-
Meta
-
-
TotalPages
- type : integer
- format : int32
-
TotalPages
-
Example Response for post
/open-banking/v3.1/cbpii/funds-confirmations
400
Bad request
Definitions
-
Code
- High level textual error code, to help categorize the errors.
- type : string
- minLength : 1
- maxLength : 40
-
Id
- A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
- type : string
- minLength : 1
- maxLength : 40
-
Message
- Brief Error message, e.g., 'There is something wrong with the request parameters provided'
- type : string
- minLength : 1
- maxLength : 500
-
Errors
-
-
ErrorCode
- Low level textual error code, e.g., UK.OBIE.Field.Missing
- type : string
- minLength : 1
- maxLength : 128
-
Message
- A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
- type : string
- minLength : 1
- maxLength : 500
-
ErrorCode
-
Response Schema for post
/open-banking/v3.1/cbpii/funds-confirmations
{
"description": "An array of detail error codes, and messages, and URLs to documentation to help remediation.",
"type": "object",
"properties": {
"Code": {
"description": "High level textual error code, to help categorize the errors.",
"type": "string",
"minLength": 1,
"maxLength": 40,
"example": "RequestValidationError"
},
"Id": {
"description": "A unique reference for the error instance, for audit purposes, in case of unknown\/unclassified errors.",
"type": "string",
"minLength": 1,
"maxLength": 40,
"example": "c09206d3-9d44-49a7-99c3-277386cadd1c"
},
"Message": {
"description": "Brief Error message, e.g., 'There is something wrong with the request parameters provided'",
"type": "string",
"minLength": 1,
"maxLength": 500,
"example": "There is something wrong with the request paramaters provided"
},
"Errors": {
"items": {
"type": "object",
"properties": {
"ErrorCode": {
"description": "Low level textual error code, e.g., UK.OBIE.Field.Missing",
"type": "string",
"minLength": 1,
"maxLength": 128,
"example": "UK.OBIE.Field.Invalid"
},
"Message": {
"description": "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBIE doesn't standardise this field",
"type": "string",
"minLength": 1,
"maxLength": 500,
"example": "RequestedExecutionDateTime must be in future"
},
"Path": {
"description": "Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Url": {
"description": "URL to help remediate the problem, or provide more information, or to API Reference, or help etc",
"type": "string"
}
},
"required": [
"ErrorCode",
"Message"
],
"additionalProperties": false,
"minProperties": 1
},
"type": "array",
"minItems": 1
}
},
"required": [
"Code",
"Message",
"Errors"
],
"additionalProperties": false
}
401
Unauthorized
This operation returns no content.
403
Forbidden
This operation returns no content.
404
Not found
This operation returns no content.
405
Method Not Allowed
This operation returns no content.
406
Not Acceptable
This operation returns no content.
415
Unsupported Media Type
This operation returns no content.
429
Too Many Requests
This operation returns no content.
500
Internal Server Error
Definitions
-
Code
- High level textual error code, to help categorize the errors.
- type : string
- minLength : 1
- maxLength : 40
-
Id
- A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
- type : string
- minLength : 1
- maxLength : 40
-
Message
- Brief Error message, e.g., 'There is something wrong with the request parameters provided'
- type : string
- minLength : 1
- maxLength : 500
-
Errors
-
-
ErrorCode
- Low level textual error code, e.g., UK.OBIE.Field.Missing
- type : string
- minLength : 1
- maxLength : 128
-
Message
- A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field
- type : string
- minLength : 1
- maxLength : 500
-
ErrorCode
-
Response Schema for post
/open-banking/v3.1/cbpii/funds-confirmations
{
"description": "An array of detail error codes, and messages, and URLs to documentation to help remediation.",
"type": "object",
"properties": {
"Code": {
"description": "High level textual error code, to help categorize the errors.",
"type": "string",
"minLength": 1,
"maxLength": 40,
"example": "RequestValidationError"
},
"Id": {
"description": "A unique reference for the error instance, for audit purposes, in case of unknown\/unclassified errors.",
"type": "string",
"minLength": 1,
"maxLength": 40,
"example": "c09206d3-9d44-49a7-99c3-277386cadd1c"
},
"Message": {
"description": "Brief Error message, e.g., 'There is something wrong with the request parameters provided'",
"type": "string",
"minLength": 1,
"maxLength": 500,
"example": "There is something wrong with the request paramaters provided"
},
"Errors": {
"items": {
"type": "object",
"properties": {
"ErrorCode": {
"description": "Low level textual error code, e.g., UK.OBIE.Field.Missing",
"type": "string",
"minLength": 1,
"maxLength": 128,
"example": "UK.OBIE.Field.Invalid"
},
"Message": {
"description": "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBIE doesn't standardise this field",
"type": "string",
"minLength": 1,
"maxLength": 500,
"example": "RequestedExecutionDateTime must be in future"
},
"Path": {
"description": "Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Url": {
"description": "URL to help remediate the problem, or provide more information, or to API Reference, or help etc",
"type": "string"
}
},
"required": [
"ErrorCode",
"Message"
],
"additionalProperties": false,
"minProperties": 1
},
"type": "array",
"minItems": 1
}
},
"required": [
"Code",
"Message",
"Errors"
],
"additionalProperties": false
}