What this API does:
This API lets you retrieve information about the beneficiaries under one or more of a customer’s accounts.
Before calling the API, you must have an access token issued by Virgin Money using 'Authorization Code' grant.
This API will provide a valid response for 5 minutes from the time the authorization code is generated. After 5 minutes, a 403 error code will be returned. You can get a further 5 minutes access by refreshing the consent.
Endpoint configuration
Sandbox: cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.1/aisp/beneficiaries
Production: api.openbanking.virginmoney.com/open-banking/v3.1/aisp/beneficiaries
Bulk information - you can retrieve the account balance and borrowing information for all authorised accounts linked to the account request.
Sandbox: cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.1/aisp/accounts/{AccountId}/beneficiaries
Production: api.openbanking.virginmoney.com/open-banking/v3.1/aisp/accounts/{AccountId}/beneficiaries
The account balance and borrowing information for a specific AccountId is retrieved in the call to GET /accounts.
API calls
Beneficiaries
Name | Description |
---|---|
AccountId * string (path) | AccountId |
x-fapi-auth-date 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 |
Responses
Code | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
200 | OK { #/definitions/OBReadBeneficiary3OBReadBeneficiary3{
Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
400 | Bad request { #/definitions/OBErrorResponse1OBErrorResponse1{
Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
401 | Unauthorized Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
403 | Forbidden { #/definitions/OBErrorResponse1OBErrorResponse1{
Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
404 | Not found Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
405 | Method Not Allowed Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
406 | Not Acceptable Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
429 | Too Many Requests Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
500 | Internal Server Error { #/definitions/OBErrorResponse1OBErrorResponse1{
Headers:
|
Name | Description |
---|---|
x-fapi-auth-date 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 |
Responses
Code | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
200 | OK { #/definitions/OBReadBeneficiary3OBReadBeneficiary3{
Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
400 | Bad request { #/definitions/OBErrorResponse1OBErrorResponse1{
Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
401 | Unauthorized Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
403 | Forbidden { #/definitions/OBErrorResponse1OBErrorResponse1{
Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
404 | Not found Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
405 | Method Not Allowed Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
406 | Not Acceptable Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
429 | Too Many Requests Headers:
| ||||||||||||||||||||||||||||||||||||||||||||||||||
500 | Internal Server Error { #/definitions/OBErrorResponse1OBErrorResponse1{
Headers:
|
Models
Data* | {
| ||||||||||||||||||
Links | #/definitions/LinksLinks{
| ||||||||||||||||||
Meta | #/definitions/MetaMeta{
|
AccountId | AccountIdstring A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. | ||||||||
BeneficiaryId | BeneficiaryIdstring A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner. | ||||||||
Reference | Referencestring Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. | ||||||||
CreditorAccount | #/definitions/OBCashAccount5_1OBCashAccount5_1{
|
description: | Links relevant to the payload |
Self* | string |
First | string |
Prev | string |
Next | string |
Last | string |
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
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.
Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.
If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.
description: | Provides the details to identify the beneficiary account. |
SchemeName* | OBExternalAccountIdentification4Codestring Name of the identification scheme, in a coded form as published in an external list. |
Identification* | Identification_0string Identification assigned by an institution to identify an account. This identification is known by the account owner. |
Name | Name_0string The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. |
OBExternalAccountIdentification4Code
Name of the identification scheme, in a coded form as published in an external list.
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.
Note, the account name is not the product name or the nickname of the account.
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{
|
ErrorCode* | string 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 |
Having trouble?
Contact our dedicated team members via our ticketing system or via our support mailbox