Skip to main content

Page contents

What this API does:

This API lets you retrieve Direct Debit information for Virgin Money customer accounts.

Before calling the API, you must have an access token issued by Virgin Money using 'Authorization Code' grant.

Endpoint configuration

Sandbox:  cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.1/aisp/accounts/{AccountId}/direct-debits

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

Direct Debit information for a specific AccountId is retrieved in the call to GET /accounts.

API calls

Direct Debits

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": {
    "DirectDebit": [
      {
        "AccountId": "string",
        "DirectDebitId": "string",
        "MandateIdentification": "string",
        "DirectDebitStatusCode": "Active",
        "Name": "string",
        "PreviousPaymentDateTime": "2024-06-12T13:40:11.270Z",
        "PreviousPaymentAmount": {
          "Amount": "string",
          "Currency": "string"
        }
      }
    ]
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2024-06-12T13:40:11.270Z",
    "LastAvailableDateTime": "2024-06-12T13:40:11.270Z"
  }
}
#/definitions/OBReadDirectDebit1OBReadDirectDebit1{
Data*{
DirectDebit[{
description:
Account to or from which a cash entry is made.
AccountId*AccountIdstring
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
DirectDebitIdstring
minLength: 1
maxLength: 40
A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner.
MandateIdentification*string
minLength: 1
maxLength: 35
Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.
DirectDebitStatusCodestring
Specifies the status of the direct debit in code form.
Enum:
[ Active, Inactive ]
Name*string
minLength: 1
maxLength: 70
Name of Service User.
PreviousPaymentDateTimestring($date-time)

Date of most recent direct debit collection.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

PreviousPaymentAmount{
description:
The amount of the most recent direct debit collection.
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".

}
}]
}
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

OBReadDirectDebit1{
Data*{
DirectDebit[{
description:
Account to or from which a cash entry is made.
AccountId*AccountIdstring
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
DirectDebitIdstring
minLength: 1
maxLength: 40
A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner.
MandateIdentification*string
minLength: 1
maxLength: 35
Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.
DirectDebitStatusCodestring
Specifies the status of the direct debit in code form.
Enum:
[ Active, Inactive ]
Name*string
minLength: 1
maxLength: 70
Name of Service User.
PreviousPaymentDateTimestring($date-time)

Date of most recent direct debit collection.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

PreviousPaymentAmount{
description:
The amount of the most recent direct debit collection.
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".

}
}]
}
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

}
}

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

}

Having trouble?

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

OpenBankingResponse@virginmoney.com

Contact us