Skip to main content

Page contents

What this API does:

This API lets you retrieve information about scheduled payments from Virgin Money 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/accounts/{AccountId}/scheduled-payments

Production:  api.openbanking.virginmoney.com/open-banking/v3.1/aisp/accounts/{AccountId}/scheduled-payments

Scheduled payments information for a specific AccountId is retrieved in the call to GET /accounts.

API calls

Scheduled Payments

NameDescription
AccountId *
string
(path)
AccountId
x-fapi-auth-date
string
(header)

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
(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

Responses

CodeDescription
200
OK

{
  "Data": {
    "ScheduledPayment": [
      {
        "AccountId": "string",
        "ScheduledPaymentId": "string",
        "ScheduledPaymentDateTime": "2024-06-19T18:21:23.187Z",
        "ScheduledType": "Execution",
        "Reference": "string",
        "InstructedAmount": {
          "Amount": "string",
          "Currency": "string"
        },
        "CreditorAccount": {
          "SchemeName": "string",
          "Identification": "string",
          "Name": "string"
        }
      }
    ]
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2024-06-19T18:21:23.187Z",
    "LastAvailableDateTime": "2024-06-19T18:21:23.187Z"
  }
}
#/definitions/OBReadScheduledPayment2OBReadScheduledPayment2{
Data*{
ScheduledPayment[#/definitions/OBScheduledPayment2OBScheduledPayment2{
AccountId*AccountIdstring
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
ScheduledPaymentIdScheduledPaymentIdstring
A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
ScheduledPaymentDateTime*ScheduledPaymentDateTimestring($date-time)

The date on which the scheduled payment will be made.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

ScheduledType*OBExternalScheduleType1Codestring
Specifies the scheduled payment date type requested

Enum:
[ Execution ]
ReferenceReferencestring

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.

InstructedAmount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_9OBActiveOrHistoricCurrencyAndAmount_9{
description:

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Usage: This amount has to be transported unchanged through the transaction chain.

Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCode_1string

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".

}
CreditorAccount#/definitions/OBCashAccount5_0OBCashAccount5_0{
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*string
minLength: 1
maxLength: 256
Beneficiary account identification.
NameName_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.
Note, the account name is not the product name or the nickname of the account.

}
}]
}
Links#/definitions/LinksLinks{
description:
Links relevant to the payload
Self*string
Firststring
Prevstring
Nextstring
Laststring
}
Meta#/definitions/MetaMeta{
description:
Meta Data relevant to the payload
TotalPagesinteger($int32)
FirstAvailableDateTimeISODateTimestring($date-time)

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

LastAvailableDateTimeISODateTimestring($date-time)

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

}
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
400
Bad request

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1OBErrorResponse1{
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.

Idstring
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'
OBIE doesn't standardise this field

Pathstring
minLength: 1
maxLength: 500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Urlstring

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
401
Unauthorized

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
403
Forbidden

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1OBErrorResponse1{
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.

Idstring
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'
OBIE doesn't standardise this field

Pathstring
minLength: 1
maxLength: 500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Urlstring

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
404
Not found

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
405
Method Not Allowed

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
406
Not Acceptable

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
429
Too Many Requests

Headers:

NameDescriptionType
Retry-After
Number in seconds to wait
integer
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string
500
Internal Server Error

{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "string",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}
#/definitions/OBErrorResponse1OBErrorResponse1{
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.

Idstring
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'
OBIE doesn't standardise this field

Pathstring
minLength: 1
maxLength: 500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Urlstring

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]
}

Headers:

NameDescriptionType
x-fapi-interaction-id
An RFC4122 UID used as a correlation id.
string

Models

AccountIdstring
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.

OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

ActiveOrHistoricCurrencyCode_1string

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".

Meta{
description:
Meta Data relevant to the payload
TotalPagesinteger($int32)
FirstAvailableDateTimeISODateTimestring($date-time)

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

LastAvailableDateTimeISODateTimestring($date-time)

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

}

ISODateTimestring($date-time)

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

OBErrorResponse1{
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.

Idstring
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'
OBIE doesn't standardise this field

Pathstring
minLength: 1
maxLength: 500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Urlstring

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}]
}

OBError1{
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'
OBIE doesn't standardise this field

Pathstring
minLength: 1
maxLength: 500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Urlstring

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}

OBReadScheduledPayment2{
Data*{
ScheduledPayment[#/definitions/OBScheduledPayment2OBScheduledPayment2{
AccountId*AccountIdstring
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
ScheduledPaymentIdScheduledPaymentIdstring
A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
ScheduledPaymentDateTime*ScheduledPaymentDateTimestring($date-time)

The date on which the scheduled payment will be made.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

ScheduledType*OBExternalScheduleType1Codestring
Specifies the scheduled payment date type requested
Enum:
[ Execution ]
ReferenceReferencestring

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.

InstructedAmount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_9OBActiveOrHistoricCurrencyAndAmount_9{
description:

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Usage: This amount has to be transported unchanged through the transaction chain.

Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCode_1string

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".

}
CreditorAccount#/definitions/OBCashAccount5_0OBCashAccount5_0{
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*string
minLength: 1
maxLength: 256
Beneficiary account identification.
NameName_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.
Note, the account name is not the product name or the nickname of the account.

}
}]
}
Links#/definitions/LinksLinks{
description:
Links relevant to the payload
Self*string
Firststring
Prevstring
Nextstring
Laststring
}
Meta#/definitions/MetaMeta{
description:
Meta Data relevant to the payload
TotalPagesinteger($int32)
FirstAvailableDateTimeISODateTimestring($date-time)

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

LastAvailableDateTimeISODateTimestring($date-time)

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

}
}

OBScheduledPayment2{
AccountId*AccountIdstring
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
ScheduledPaymentIdScheduledPaymentIdstring
A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
ScheduledPaymentDateTime*ScheduledPaymentDateTimestring($date-time)

The date on which the scheduled payment will be made.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

ScheduledType*OBExternalScheduleType1Codestring
Specifies the scheduled payment date type requested
Enum:
[ Execution ]
ReferenceReferencestring

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.

InstructedAmount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_9OBActiveOrHistoricCurrencyAndAmount_9{
description:

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Usage: This amount has to be transported unchanged through the transaction chain.

Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCode_1string

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".

}
CreditorAccount#/definitions/OBCashAccount5_0OBCashAccount5_0{
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*string
minLength: 1
maxLength: 256
Beneficiary account identification.
NameName_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.
Note, the account name is not the product name or the nickname of the account.

}
}

ScheduledPaymentIdstring
A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.

ScheduledPaymentDateTimestring($date-time)

The date on which the scheduled payment will be made.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

OBExternalScheduleType1Codestring
Specifies the scheduled payment date type requested
Enum:
[ Execution ]

Referencestring

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.

OBActiveOrHistoricCurrencyAndAmount_9{
description:

Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.
Usage: This amount has to be transported unchanged through the transaction chain.

Amount*OBActiveCurrencyAndAmount_SimpleTypestring
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
Currency*ActiveOrHistoricCurrencyCode_1string

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".

}

OBCashAccount5_0{
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*string
minLength: 1
maxLength: 256
Beneficiary account identification.
NameName_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.
Note, the account name is not the product name or the nickname of the account.

}

OBExternalAccountIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list.

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.
Note, the account name is not the product name or the nickname of the account.

Having trouble?

Contact our dedicated team members via our ticketing system or via our support mailbox

OpenBankingResponse@virginmoney.com

Contact us