What this API does:
These APIs provide the ability for allow a Card Based Payment Instrument Issuer ('CBPII') to:
- Register an intent to confirm funds by creating a "funds confirmation consent", the consent is long lived but needs to be re-authorised every 90 days.
- Subsequently make a request to confirm funds are available.
Please note the example responses accurately reflect the response data being returned by Virgin Money. The underlying data dictionary is the Open Banking definitions that includes some optional fields VM will not be returning.
Access
- Restricted to authorised CBPIIs - see support pages for information on how to onboard.
- For Transport & Signing certificates supported - see support pages
- For production endpoint - see support pages
Endpoint configuration
Production: https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/cbpii/funds-confirmations
Production: https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/cbpii/funds-confirmations
Production: https://secureapi.prod.ob.virginmoney.com/vmpsd2-psd2prod/psd2-production/open-banking/v3.1/cbpii/funds-confirmations
API calls
Name | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
OBFundsConfirmationConsent1Param * (body) | Default { #/definitions/OBFundsConfirmationConsent1OBFundsConfirmationConsent1{
| ||||||||||||||||
x-fapi-financial-id * string (header) | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB. | ||||||||||||||||
x-fapi-customer-last-logged-time string (header) | The time when the PSU last logged in with the TPP. | ||||||||||||||||
x-fapi-customer-ip-address string (header) | The PSU's IP address if the PSU is currently logged in with the TPP. | ||||||||||||||||
x-fapi-interaction-id string (header) | An RFC4122 UID used as a correlation id. | ||||||||||||||||
Authorization * string (header) | An Authorisation Token as per https://tools.ietf.org/html/rfc6750 Link opens in a new window | ||||||||||||||||
x-customer-user-agent string (header) | Indicates the user-agent that the PSU is using. |
Responses
Code | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
201 | Funds Confirmation Consent Created { #/definitions/OBFundsConfirmationConsentResponse1OBFundsConfirmationConsentResponse1{
Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | Bad request { "Code": "string", "Id": "string", "Message": "string", "Errors": [ { "ErrorCode": "string", "Message": "string", "Path": "string", "Url": "string" } ]} #/definitions/OBErrorResponse1OBErrorResponse1{
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
401 | Unauthorized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
403 | Forbidden | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | Not found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
405 | Method Not Allowed | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
406 | Not Acceptable | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
415 | Unsupported Media Type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | Too Many Requests Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | Internal Server Error { #/definitions/OBErrorResponse1OBErrorResponse1{
|
Name | Description |
---|---|
ConsentId * string (path) | ConsentId |
x-fapi-financial-id * string (header) | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB. |
x-fapi-customer-last-logged-time string (header) | The time when the PSU last logged in with the TPP. |
x-fapi-customer-ip-address string (header) | The PSU's IP address if the PSU is currently logged in with the TPP. |
x-fapi-interaction-id string (header) | An RFC4122 UID used as a correlation id. |
Authorization * string (header) | An Authorisation Token as per https://tools.ietf.org/html/rfc6750 Link opens in a new window |
x-customer-user-agent string (header) | Indicates the user-agent that the PSU is using. |
Responses
Code | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | Funds Confirmation Consent Read { #/definitions/OBFundsConfirmationConsentResponse1OBFundsConfirmationConsentResponse1{
Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | Bad request { #/definitions/OBErrorResponse1OBErrorResponse1{
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
401 | Unauthorized | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
403 | Forbidden | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | Not found | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
405 | Method Not Allowed | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
406 | Not Acceptable | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | Too Many Requests Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | Internal Server Error { "Code": "string", "Id": "string", "Message": "string", "Errors": [ { "ErrorCode": "string", "Message": "string", "Path": "string", "Url": "string" } ]} #/definitions/OBErrorResponse1OBErrorResponse1{
|
Name | Description |
---|---|
ConsentId * string (path) | ConsentId |
x-fapi-financial-id * string (header) | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB. |
x-fapi-customer-last-logged-time string (header) | The time when the PSU last logged in with the TPP. |
x-fapi-customer-ip-address string (header) | The PSU's IP address if the PSU is currently logged in with the TPP. |
x-fapi-interaction-id string (header) | An RFC4122 UID used as a correlation id. |
Authorization * string (header) | An Authorisation Token as per https://tools.ietf.org/html/rfc6750 Link opens in a new window |
x-customer-user-agent string (header) | Indicates the user-agent that the PSU is using. |
Responses
Code | Description | ||||||||||||||||||
204 | Funds Confirmation Consent Deleted Headers:
| ||||||||||||||||||
400 | Bad request { #/definitions/OBErrorResponse1OBErrorResponse1{
| ||||||||||||||||||
401 | Unauthorized | ||||||||||||||||||
403 | Forbidden | ||||||||||||||||||
404 | Not found | ||||||||||||||||||
405 | Method Not Allowed | ||||||||||||||||||
406 | Not Acceptable | ||||||||||||||||||
429 | Too Many Requests Headers:
| ||||||||||||||||||
500 | Internal Server Error { |
description: | An array of detail error codes, and messages, and URLs to documentation to help remediation. | ||||||||
Code* | string minLength: 1 maxLength: 40 High level textual error code, to help categorize the errors. | ||||||||
Id | string minLength: 1 maxLength: 40 A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors. | ||||||||
Message* | string minLength: 1 maxLength: 500 Brief Error message, e.g., 'There is something wrong with the request parameters provided' | ||||||||
Errors* | [ minItems: 1#/definitions/OBError1OBError1{
|
Name | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
OBFundsConfirmation1Param * (body) | Default { #/definitions/OBFundsConfirmation1OBFundsConfirmation1{
| ||||||||||||||
x-fapi-financial-id * string (header) | The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB. | ||||||||||||||
x-fapi-customer-last-logged-time string (header) | The time when the PSU last logged in with the TPP. | ||||||||||||||
x-fapi-customer-ip-address string (header) | The PSU's IP address if the PSU is currently logged in with the TPP. | ||||||||||||||
x-fapi-interaction-id string (header) | An RFC4122 UID used as a correlation id. | ||||||||||||||
Authorization * string (header) | An Authorisation Token as per https://tools.ietf.org/html/rfc6750 Link opens in a new window | ||||||||||||||
x-customer-user-agent string (header) | Indicates the user-agent that the PSU is using. |
Responses
Code | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
201 | Funds Confirmation Created { #/definitions/OBFundsConfirmationResponse1OBFundsConfirmationResponse1{
Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
400 | Bad request { #/definitions/OBErrorResponse1OBErrorResponse1{
| ||||||||||||||||||||||||||||||||||||||||||||||||||
401 | Unauthorized | ||||||||||||||||||||||||||||||||||||||||||||||||||
403 | Forbidden | ||||||||||||||||||||||||||||||||||||||||||||||||||
404 | Not found | ||||||||||||||||||||||||||||||||||||||||||||||||||
405 | Method Not Allowed | ||||||||||||||||||||||||||||||||||||||||||||||||||
406 | Not Acceptable | ||||||||||||||||||||||||||||||||||||||||||||||||||
415 | Unsupported Media Type | ||||||||||||||||||||||||||||||||||||||||||||||||||
429 | Too Many Requests Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
500 | Internal Server Error { #/definitions/OBErrorResponse1OBErrorResponse1{
|
Models
OBActiveCurrencyAndAmount_SimpleType
string
pattern: ^\d{1,13}\.\d{1,2}$
OBActiveOrHistoricCurrencyAndAmount
description: | Amount of money to be confirmed as available funds in the debtor account. Contains an Amount and a Currency. |
Amount* | OBActiveCurrencyAndAmount_SimpleTypestring pattern: ^\d{1,13}\.\d{1,2}$ A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. For Virgin Money this must be to 2 decimal places. |
Currency* | string pattern: ^[A-Z]{3,3}$ 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". |
description: | Unambiguous identification of the account of the debtor to which a confirmation of funds consent will be applied. |
SchemeName* | OBExternalAccountIdentification4Codestring example: List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ] minLength: 1 maxLength: 40 Name of the identification scheme, in a coded form as published in an external list. |
Identification* | string minLength: 1 maxLength: 256 Identification assigned by an institution to identify an account. This identification is known by the account owner. |
Name | string minLength: 1 maxLength: 70 Name of the account, as assigned by the account servicing institution. |
SecondaryIdentification | string minLength: 1 maxLength: 34 This is secondary identification of the account, as assigned by the account servicing institution. |
OBExternalAccountIdentification4Code
example: List [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ]
minLength: 1
maxLength: 40
Name of the identification scheme, in a coded form as published in an external list.
[ Authorised, AwaitingAuthorisation, Rejected, Revoked ]
Data* | #/definitions/OBFundsConfirmationData1OBFundsConfirmationData1{
|
Data* | #/definitions/OBFundsConfirmationConsentData1OBFundsConfirmationConsentData1{
|
OBFundsConfirmationConsentData1
ExpirationDateTime | string($date-time) Specified date and time the funds confirmation authorisation will expire. | ||||||||||
DebtorAccount* | #/definitions/OBCashAccountDebtor4OBCashAccountDebtor4{
|
OBFundsConfirmationConsentDataResponse1
ConsentId* | string minLength: 1 maxLength: 128 Unique identification as assigned to identify the funds confirmation consent resource. | ||||||||||
CreationDateTime* | string($date-time) Date and time at which the resource was created. | ||||||||||
Status* | OBExternalRequestStatus1Codestring Specifies the status of consent resource in code form. Enum:[ Authorised, AwaitingAuthorisation, Rejected, Revoked ] | ||||||||||
StatusUpdateDateTime* | string($date-time) Date and time at which the resource status was updated. | ||||||||||
ExpirationDateTime | string($date-time) Specified date and time the funds confirmation authorisation will expire. | ||||||||||
DebtorAccount* | #/definitions/OBCashAccountDebtor4OBCashAccountDebtor4{
|
OBFundsConfirmationConsentResponse1
Data* | #/definitions/OBFundsConfirmationConsentDataResponse1OBFundsConfirmationConsentDataResponse1{
| ||||||||||||||||||||||
Links* | #/definitions/LinksLinks{
| ||||||||||||||||||||||
Meta* | #/definitions/MetaMetaData{
|
ConsentId* | string minLength: 1 maxLength: 128 Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent resource. | ||||||
Reference* | string minLength: 1 maxLength: 35 Unique reference, as assigned by the CBPII, to unambiguously refer to the request related to the payment transaction. | ||||||
InstructedAmount* | #/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
|
OBFundsConfirmationDataResponse1
FundsConfirmationId* | string minLength: 1 maxLength: 40 Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation resource. | ||||||
ConsentId* | string minLength: 1 maxLength: 128 Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent resource. | ||||||
CreationDateTime* | string($date-time) Date and time at which the resource was created. | ||||||
FundsAvailable* | boolean Flag to indicate the result of a confirmation of funds check. | ||||||
Reference* | string minLength: 1 maxLength: 35 Unique reference, as assigned by the CBPII, to unambiguously refer to the request related to the payment transaction. | ||||||
InstructedAmount* | #/definitions/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
|
Data* | #/definitions/OBFundsConfirmationDataResponse1OBFundsConfirmationDataResponse1{
| ||||||||||||||||||
Links* | #/definitions/LinksLinks{
| ||||||||||||||||||
Meta* | #/definitions/MetaMetaData{
|
description: | Links relevant to the payload |
Self* | string($uri) |
First | string($uri) |
Prev | string($uri) |
Next | string($uri) |
Last | string($uri) |
description: | Meta Data relevant to the payload |
TotalPages | integer($int32) |
FirstAvailableDateTime | ISODateTimestring($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. |
LastAvailableDateTime | ISODateTimestring($date-time) All dates in the JSON payloads are represented in ISO 8601 date-time format. |
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
ErrorCode* | string minLength: 1 maxLength: 128 Low level textual error code, e.g., UK.OBIE.Field.Missing |
Message* | string minLength: 1 maxLength: 500 A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' |
Path | string minLength: 1 maxLength: 500 Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency |
Url | string URL to help remediate the problem, or provide more information, or to API Reference, or help etc |
description: | An array of detail error codes, and messages, and URLs to documentation to help remediation. | ||||||||
Code* | string minLength: 1 maxLength: 40 High level textual error code, to help categorize the errors. | ||||||||
Id | string minLength: 1 maxLength: 40 A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors. | ||||||||
Message* | string minLength: 1 maxLength: 500 Brief Error message, e.g., 'There is something wrong with the request parameters provided' | ||||||||
Errors* | [ minItems: 1#/definitions/OBError1OBError1{
|
Having trouble?
Contact our dedicated team members via our ticketing system or via our support mailbox