Skip to main content

Page contents

What this API does:

This API lets you retrieve transaction information for one or for multiple accounts.

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

For 5 minutes, this API will return transaction details for any period that the customer provides consent for. If fromBookingDateTime is not specified we will default to 90 days. After 5 minutes, transaction details will only be returned for a 90 day period. Refresh consent to regain access to the longer period.

Endpoint configuration

Sandbox:  cb.sandbox-api-nc.cybservices.co.uk/open-banking/v3.1/aisp/transactions

Production:  api.openbanking.virginmoney.com/open-banking/v3.1/aisp/transactions

Bulk transaction information - retrieve account transaction 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}/transactions

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

Account transaction information for a specific AccountId is retrieved in the call to GET /accounts.

API calls

Transactions

NameDescription
AccountId *
string
(path)
AccountId
fromBookingDateTime
string($date-time)
(query)

The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

toBookingDateTime
string($date-time)
(query)

The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

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": {
    "Transaction": [
      {
        "AccountId": "string",
        "TransactionId": "string",
        "CreditDebitIndicator": "Credit",
        "Status": "Booked",
        "BookingDateTime": "2024-06-20T11:52:02.489Z",
        "TransactionInformation": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        },
        "ProprietaryBankTransactionCode": {
          "Code": "string"
        },
        "Balance": {
          "CreditDebitIndicator": "Credit",
          "Type": "ClosingAvailable",
          "Amount": {
            "Amount": "string",
            "Currency": "string"
          }
        },
        "DebtorAccount": {
          "SchemeName": "string",
          "Identification": "string"
        }
      }
    ]
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2024-06-20T11:52:02.489Z",
    "LastAvailableDateTime": "2024-06-20T11:52:02.489Z"
  }
}
#/definitions/OBReadTransaction5OBReadTransaction5{
Data*#/definitions/OBReadDataTransaction5OBReadDataTransaction5{
Transaction[#/definitions/OBTransaction5OBTransaction5{
description:
Provides further details on an entry in the report.
AccountId*AccountIdstring
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
TransactionIdTransactionIdstring
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
CreditDebitIndicator*OBCreditDebitCode_1string
Indicates whether the transaction is a credit or a debit entry.

Enum:
[ Credit, Debit ]
Status*OBEntryStatus1Codestring
Status of a transaction entry on the books of the account servicer.

Enum:
[ Booked, Pending ]
BookingDateTime*BookingDateTimestring($date-time)

Date and time when a transaction entry is posted to an account on the account servicer's books.
Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.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

TransactionInformationTransactionInformationstring

Further details of the transaction.
This is the transaction narrative, which is unstructured text.

Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_7OBActiveOrHistoricCurrencyAndAmount_7{
description:
Amount of money in the cash transaction entry.
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".

}
ProprietaryBankTransactionCode#/definitions/ProprietaryBankTransactionCodeStructure1ProprietaryBankTransactionCodeStructure1{
description:
Set of elements to fully identify a proprietary bank transaction code.
Code*string
minLength: 1
maxLength: 35
Proprietary bank transaction code to identify the underlying transaction.
}
Balance#/definitions/OBTransactionCashBalanceOBTransactionCashBalance{
description:
Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
CreditDebitIndicator*OBCreditDebitCode_2string

Indicates whether the balance is a credit or a debit balance.
Usage: A zero balance is considered to be a credit balance.


Enum:
[ Credit, Debit ]
Type*OBBalanceType1Codestring

Balance type, in a coded form.


Enum:
[ ClosingAvailable, ClosingBooked, ClosingCleared, Expected, ForwardAvailable, Information, InterimAvailable, InterimBooked, InterimCleared, OpeningAvailable, OpeningBooked, OpeningCleared, PreviouslyClosedBooked ]
Amount*{
description:
Amount of money of the cash balance after a transaction entry is applied to the account..
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".

}
}
DebtorAccount#/definitions/OBCashAccount6_1OBCashAccount6_1{
description:

Unambiguous identification of the account of the debtor, in the case of a crebit transaction.

SchemeNameOBExternalAccountIdentification4Codestring

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

IdentificationIdentification_0string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
}
}]
}
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
NameDescription
fromBookingDateTime
string($date-time)
(query)

The UTC ISO 8601 Date Time to filter transactions FROM
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

toBookingDateTime
string($date-time)
(query)

The UTC ISO 8601 Date Time to filter transactions TO
NB Time component is optional - set to 00:00:00 for just Date.
If the Date Time contains a timezone, the ASPSP must ignore the timezone component.

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": {
    "Transaction": [
      {
        "AccountId": "string",
        "TransactionId": "string",
        "CreditDebitIndicator": "Credit",
        "Status": "Booked",
        "BookingDateTime": "2024-06-20T12:01:08.680Z",
        "TransactionInformation": "string",
        "Amount": {
          "Amount": "string",
          "Currency": "string"
        },
        "ProprietaryBankTransactionCode": {
          "Code": "string"
        },
        "Balance": {
          "CreditDebitIndicator": "Credit",
          "Type": "ClosingAvailable",
          "Amount": {
            "Amount": "string",
            "Currency": "string"
          }
        },
        "DebtorAccount": {
          "SchemeName": "string",
          "Identification": "string"
        }
      }
    ]
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {
    "TotalPages": 0,
    "FirstAvailableDateTime": "2024-06-20T12:01:08.680Z",
    "LastAvailableDateTime": "2024-06-20T12:01:08.680Z"
  }
}
#/definitions/OBReadTransaction5OBReadTransaction5{
Data*#/definitions/OBReadDataTransaction5OBReadDataTransaction5{
Transaction[#/definitions/OBTransaction5OBTransaction5{
description:
Provides further details on an entry in the report.
AccountId*AccountIdstring
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
TransactionIdTransactionIdstring
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
CreditDebitIndicator*OBCreditDebitCode_1string
Indicates whether the transaction is a credit or a debit entry.

Enum:
[ Credit, Debit ]
Status*OBEntryStatus1Codestring
Status of a transaction entry on the books of the account servicer.

Enum:
[ Booked, Pending ]
BookingDateTime*BookingDateTimestring($date-time)

Date and time when a transaction entry is posted to an account on the account servicer's books.
Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.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

TransactionInformationTransactionInformationstring

Further details of the transaction.
This is the transaction narrative, which is unstructured text.

Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_7OBActiveOrHistoricCurrencyAndAmount_7{
description:
Amount of money in the cash transaction entry.
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".

}
ProprietaryBankTransactionCode#/definitions/ProprietaryBankTransactionCodeStructure1ProprietaryBankTransactionCodeStructure1{
description:
Set of elements to fully identify a proprietary bank transaction code.
Code*string
minLength: 1
maxLength: 35
Proprietary bank transaction code to identify the underlying transaction.
}
Balance#/definitions/OBTransactionCashBalanceOBTransactionCashBalance{
description:
Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
CreditDebitIndicator*OBCreditDebitCode_2string

Indicates whether the balance is a credit or a debit balance.
Usage: A zero balance is considered to be a credit balance.


Enum:
[ Credit, Debit ]
Type*OBBalanceType1Codestring

Balance type, in a coded form.


Enum:
[ ClosingAvailable, ClosingBooked, ClosingCleared, Expected, ForwardAvailable, Information, InterimAvailable, InterimBooked, InterimCleared, OpeningAvailable, OpeningBooked, OpeningCleared, PreviouslyClosedBooked ]
Amount*{
description:
Amount of money of the cash balance after a transaction entry is applied to the account..
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".

}
}
DebtorAccount#/definitions/OBCashAccount6_1OBCashAccount6_1{
description:

Unambiguous identification of the account of the debtor, in the case of a crebit transaction.

SchemeNameOBExternalAccountIdentification4Codestring

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

IdentificationIdentification_0string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
}
}]
}
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

OBReadStatement2{
Data*#/definitions/OBReadDataStatement2OBReadDataStatement2{
Statement[#/definitions/OBStatement2OBStatement2{
description:
Provides further details on a statement resource.
AccountId*AccountIdstring
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
StatementIdStatementIdstring
Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.
StatementReferenceStatementReferencestring
Unique reference for the statement. This reference may be optionally populated if available.
Type*OBExternalStatementType1Codestring

Statement type, in a coded form.

Enum:
[ AccountClosure, AccountOpening, Annual, Interim, RegularPeriodic ]
StartDateTime*StartDateTimestring($date-time)

Date and time at which the offer starts.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

EndDateTime*EndDateTimestring($date-time)

Date and time at which the statement period ends.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

CreationDateTime*CreationDateTimestring($date-time)

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

StatementDescription[string
minLength: 1
maxLength: 500
Other descriptions that may be available for the statement resource.
]
StatementBenefit[{
description:
Set of elements used to provide details of a benefit or reward amount for the statement resource.
Type*OBExternalStatementBenefitType1Codestring

Benefit type, in a coded form.

Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_3OBActiveOrHistoricCurrencyAndAmount_3{
description:
Amount of money associated with the statement benefit type.
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".

}
}]
StatementFee[{
description:
Set of elements used to provide details of a fee for the statement resource.
DescriptionDescription_1string
Description that may be available for the statement fee.
CreditDebitIndicator*OBCreditDebitCode_0string

Indicates whether the amount is a credit or a debit.
Usage: A zero amount is considered to be a credit amount.

Enum:
[ Credit, Debit ]
Type*OBExternalStatementFeeType1Codestring

Fee type, in a coded form.

RateOBRate1_0number

Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)

RateTypeOBExternalStatementFeeRateType1Codestring
Description that may be available for the statement fee rate type.
FrequencyOBExternalStatementFeeFrequency1Codestring
How frequently the fee is applied to the Account.
Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_4OBActiveOrHistoricCurrencyAndAmount_4{
description:
Amount of money associated with the statement fee type.
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".

}
}]
StatementInterest[{
description:
Set of elements used to provide details of a generic interest amount related to the statement resource.
DescriptionDescription_2string
Description that may be available for the statement interest.
CreditDebitIndicator*OBCreditDebitCode_0string

Indicates whether the amount is a credit or a debit.
Usage: A zero amount is considered to be a credit amount.

Enum:
[ Credit, Debit ]
Type*OBExternalStatementInterestType1Codestring

Interest amount type, in a coded form.

RateOBRate1_1number

field representing a percentage (e.g. 0.05 represents 5% and 0.9525 represents 95.25%). Note the number of decimal places may vary.

RateTypeOBExternalStatementInterestRateType1Codestring
Description that may be available for the statement Interest rate type.
FrequencyOBExternalStatementInterestFrequency1Codestring
Specifies the statement fee type requested
Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_5OBActiveOrHistoricCurrencyAndAmount_5{
description:
Amount of money associated with the statement interest amount type.
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".

}
}]
StatementAmount[{
description:
Set of elements used to provide details of a generic amount for the statement resource.
CreditDebitIndicator*OBCreditDebitCode_0string

Indicates whether the amount is a credit or a debit.
Usage: A zero amount is considered to be a credit amount.

Enum:
[ Credit, Debit ]
Type*OBExternalStatementAmountType1Codestring

Amount type, in a coded form.

Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_6OBActiveOrHistoricCurrencyAndAmount_6{
description:
Amount of money associated with the amount type.
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".

}
}]
StatementDateTime[{
description:
Set of elements used to provide details of a generic date time for the statement resource.
DateTime*DateTimestring($date-time)

Date and time associated with the date time type.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*OBExternalStatementDateTimeType1Codestring

Date time type, in a coded form.

}]
StatementRate[{
description:
Set of elements used to provide details of a generic rate related to the statement resource.
Rate*OBExternalStatementRateType1Codestring
Rate associated with the statement rate type.
Type*Type_0string

Statement rate type, in a coded form.

}]
StatementValue[{
description:
Set of elements used to provide details of a generic number value related to the statement resource.
Value*OBExternalStatementValueType1Codestring
Value associated with the statement value type.
Type*Type_1string

Statement value type, in a coded form.

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

}
}

OBReadDataStatement2{
Statement[#/definitions/OBStatement2OBStatement2{
description:
Provides further details on a statement resource.
AccountId*AccountIdstring
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
StatementIdStatementIdstring
Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.
StatementReferenceStatementReferencestring
Unique reference for the statement. This reference may be optionally populated if available.
Type*OBExternalStatementType1Codestring

Statement type, in a coded form.

Enum:
[ AccountClosure, AccountOpening, Annual, Interim, RegularPeriodic ]
StartDateTime*StartDateTimestring($date-time)

Date and time at which the offer starts.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

EndDateTime*EndDateTimestring($date-time)

Date and time at which the statement period ends.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

CreationDateTime*CreationDateTimestring($date-time)

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

StatementDescription[string
minLength: 1
maxLength: 500
Other descriptions that may be available for the statement resource.
]
StatementBenefit[{
description:
Set of elements used to provide details of a benefit or reward amount for the statement resource.
Type*OBExternalStatementBenefitType1Codestring

Benefit type, in a coded form.

Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_3OBActiveOrHistoricCurrencyAndAmount_3{
description:
Amount of money associated with the statement benefit type.
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".

}
}]
StatementFee[{
description:
Set of elements used to provide details of a fee for the statement resource.
DescriptionDescription_1string
Description that may be available for the statement fee.
CreditDebitIndicator*OBCreditDebitCode_0string

Indicates whether the amount is a credit or a debit.
Usage: A zero amount is considered to be a credit amount.

Enum:
[ Credit, Debit ]
Type*OBExternalStatementFeeType1Codestring

Fee type, in a coded form.

RateOBRate1_0number

Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)

RateTypeOBExternalStatementFeeRateType1Codestring
Description that may be available for the statement fee rate type.
FrequencyOBExternalStatementFeeFrequency1Codestring
How frequently the fee is applied to the Account.
Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_4OBActiveOrHistoricCurrencyAndAmount_4{
description:
Amount of money associated with the statement fee type.
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".

}
}]
StatementInterest[{
description:
Set of elements used to provide details of a generic interest amount related to the statement resource.
DescriptionDescription_2string
Description that may be available for the statement interest.
CreditDebitIndicator*OBCreditDebitCode_0string

Indicates whether the amount is a credit or a debit.
Usage: A zero amount is considered to be a credit amount.

Enum:
[ Credit, Debit ]
Type*OBExternalStatementInterestType1Codestring

Interest amount type, in a coded form.

RateOBRate1_1number

field representing a percentage (e.g. 0.05 represents 5% and 0.9525 represents 95.25%). Note the number of decimal places may vary.

RateTypeOBExternalStatementInterestRateType1Codestring
Description that may be available for the statement Interest rate type.
FrequencyOBExternalStatementInterestFrequency1Codestring
Specifies the statement fee type requested
Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_5OBActiveOrHistoricCurrencyAndAmount_5{
description:
Amount of money associated with the statement interest amount type.
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".

}
}]
StatementAmount[{
description:
Set of elements used to provide details of a generic amount for the statement resource.
CreditDebitIndicator*OBCreditDebitCode_0string

Indicates whether the amount is a credit or a debit.
Usage: A zero amount is considered to be a credit amount.

Enum:
[ Credit, Debit ]
Type*OBExternalStatementAmountType1Codestring

Amount type, in a coded form.

Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_6OBActiveOrHistoricCurrencyAndAmount_6{
description:
Amount of money associated with the amount type.
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".

}
}]
StatementDateTime[{
description:
Set of elements used to provide details of a generic date time for the statement resource.
DateTime*DateTimestring($date-time)

Date and time associated with the date time type.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*OBExternalStatementDateTimeType1Codestring

Date time type, in a coded form.

}]
StatementRate[{
description:
Set of elements used to provide details of a generic rate related to the statement resource.
Rate*OBExternalStatementRateType1Codestring
Rate associated with the statement rate type.
Type*Type_0string

Statement rate type, in a coded form.

}]
StatementValue[{
description:
Set of elements used to provide details of a generic number value related to the statement resource.
Value*OBExternalStatementValueType1Codestring
Value associated with the statement value type.
Type*Type_1string

Statement value type, in a coded form.

}]
}]
}

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

OBStatement2{
description:
Provides further details on a statement resource.
AccountId*AccountIdstring
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
StatementIdStatementIdstring
Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.
StatementReferenceStatementReferencestring
Unique reference for the statement. This reference may be optionally populated if available.
Type*OBExternalStatementType1Codestring

Statement type, in a coded form.

Enum:
[ AccountClosure, AccountOpening, Annual, Interim, RegularPeriodic ]
StartDateTime*StartDateTimestring($date-time)

Date and time at which the offer starts.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

EndDateTime*EndDateTimestring($date-time)

Date and time at which the statement period ends.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

CreationDateTime*CreationDateTimestring($date-time)

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

StatementDescription[string
minLength: 1
maxLength: 500
Other descriptions that may be available for the statement resource.
]
StatementBenefit[{
description:
Set of elements used to provide details of a benefit or reward amount for the statement resource.
Type*OBExternalStatementBenefitType1Codestring

Benefit type, in a coded form.

Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_3OBActiveOrHistoricCurrencyAndAmount_3{
description:
Amount of money associated with the statement benefit type.
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".

}
}]
StatementFee[{
description:
Set of elements used to provide details of a fee for the statement resource.
DescriptionDescription_1string
Description that may be available for the statement fee.
CreditDebitIndicator*OBCreditDebitCode_0string

Indicates whether the amount is a credit or a debit.
Usage: A zero amount is considered to be a credit amount.

Enum:
[ Credit, Debit ]
Type*OBExternalStatementFeeType1Codestring

Fee type, in a coded form.

RateOBRate1_0number

Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)

RateTypeOBExternalStatementFeeRateType1Codestring
Description that may be available for the statement fee rate type.
FrequencyOBExternalStatementFeeFrequency1Codestring
How frequently the fee is applied to the Account.
Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_4OBActiveOrHistoricCurrencyAndAmount_4{
description:
Amount of money associated with the statement fee type.
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".

}
}]
StatementInterest[{
description:
Set of elements used to provide details of a generic interest amount related to the statement resource.
DescriptionDescription_2string
Description that may be available for the statement interest.
CreditDebitIndicator*OBCreditDebitCode_0string

Indicates whether the amount is a credit or a debit.
Usage: A zero amount is considered to be a credit amount.

Enum:
[ Credit, Debit ]
Type*OBExternalStatementInterestType1Codestring

Interest amount type, in a coded form.

RateOBRate1_1number

field representing a percentage (e.g. 0.05 represents 5% and 0.9525 represents 95.25%). Note the number of decimal places may vary.

RateTypeOBExternalStatementInterestRateType1Codestring
Description that may be available for the statement Interest rate type.
FrequencyOBExternalStatementInterestFrequency1Codestring
Specifies the statement fee type requested
Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_5OBActiveOrHistoricCurrencyAndAmount_5{
description:
Amount of money associated with the statement interest amount type.
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".

}
}]
StatementAmount[{
description:
Set of elements used to provide details of a generic amount for the statement resource.
CreditDebitIndicator*OBCreditDebitCode_0string

Indicates whether the amount is a credit or a debit.
Usage: A zero amount is considered to be a credit amount.

Enum:
[ Credit, Debit ]
Type*OBExternalStatementAmountType1Codestring

Amount type, in a coded form.

Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_6OBActiveOrHistoricCurrencyAndAmount_6{
description:
Amount of money associated with the amount type.
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".

}
}]
StatementDateTime[{
description:
Set of elements used to provide details of a generic date time for the statement resource.
DateTime*DateTimestring($date-time)

Date and time associated with the date time type.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*OBExternalStatementDateTimeType1Codestring

Date time type, in a coded form.

}]
StatementRate[{
description:
Set of elements used to provide details of a generic rate related to the statement resource.
Rate*OBExternalStatementRateType1Codestring
Rate associated with the statement rate type.
Type*Type_0string

Statement rate type, in a coded form.

}]
StatementValue[{
description:
Set of elements used to provide details of a generic number value related to the statement resource.
Value*OBExternalStatementValueType1Codestring
Value associated with the statement value type.
Type*Type_1string

Statement value type, in a coded form.

}]
}

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

StatementIdstring
Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.

StatementReferencestring
Unique reference for the statement. This reference may be optionally populated if available.

OBExternalStatementType1Codestring

Statement type, in a coded form.

Enum:
[ AccountClosure, AccountOpening, Annual, Interim, RegularPeriodic ]

StartDateTimestring($date-time)

Date and time at which the offer starts.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

EndDateTimestring($date-time)

Date and time at which the statement period ends.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

CreationDateTimestring($date-time)

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

OBExternalStatementBenefitType1Codestring

Benefit type, in a coded form.

OBActiveOrHistoricCurrencyAndAmount_3{
description:
Amount of money associated with the statement benefit type.
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".

}

Description_1string
Description that may be available for the statement fee.

OBCreditDebitCode_0string

Indicates whether the amount is a credit or a debit.
Usage: A zero amount is considered to be a credit amount.

Enum:
[ Credit, Debit ]

OBExternalStatementAmountType1Codestring

Amount type, in a coded form.

OBActiveOrHistoricCurrencyAndAmount_6{
description:
Amount of money associated with the amount type.
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".

}

OBExternalStatementFeeType1Codestring

Fee type, in a coded form.

OBRate1_0number

Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)

OBExternalStatementFeeRateType1Codestring
Description that may be available for the statement fee rate type.

OBExternalStatementFeeFrequency1Codestring
How frequently the fee is applied to the Account.

OBActiveOrHistoricCurrencyAndAmount_4{
description:
Amount of money associated with the statement fee type.
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".

}

Description_2string
Description that may be available for the statement interest.

OBExternalStatementInterestType1Codestring

Interest amount type, in a coded form.

OBRate1_1number

field representing a percentage (e.g. 0.05 represents 5% and 0.9525 represents 95.25%). Note the number of decimal places may vary.

OBExternalStatementInterestRateType1Codestring
Description that may be available for the statement Interest rate type.

OBExternalStatementInterestFrequency1Codestring
Specifies the statement fee type requested

OBActiveOrHistoricCurrencyAndAmount_5{
description:
Amount of money associated with the statement interest amount type.
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".

}

DateTimestring($date-time)

Date and time associated with the date time type.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

OBExternalStatementDateTimeType1Codestring

Date time type, in a coded form.

OBExternalStatementRateType1Codestring
Rate associated with the statement rate type.

OBExternalStatementValueType1Codestring
Value associated with the statement value type.

OBExternalStatementValueType1Codestring
Value associated with the statement value type.

Type_1string

Statement value type, in a coded form.

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

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

}

OBReadTransaction5{
Data*#/definitions/OBReadDataTransaction5OBReadDataTransaction5{
Transaction[#/definitions/OBTransaction5OBTransaction5{
description:
Provides further details on an entry in the report.
AccountId*AccountIdstring
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
TransactionIdTransactionIdstring
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
CreditDebitIndicator*OBCreditDebitCode_1string
Indicates whether the transaction is a credit or a debit entry.
Enum:
[ Credit, Debit ]
Status*OBEntryStatus1Codestring
Status of a transaction entry on the books of the account servicer.
Enum:
[ Booked, Pending ]
BookingDateTime*BookingDateTimestring($date-time)

Date and time when a transaction entry is posted to an account on the account servicer's books.
Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.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

TransactionInformationTransactionInformationstring

Further details of the transaction.
This is the transaction narrative, which is unstructured text.

Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_7OBActiveOrHistoricCurrencyAndAmount_7{
description:
Amount of money in the cash transaction entry.
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".

}
ProprietaryBankTransactionCode#/definitions/ProprietaryBankTransactionCodeStructure1ProprietaryBankTransactionCodeStructure1{
description:
Set of elements to fully identify a proprietary bank transaction code.
Code*string
minLength: 1
maxLength: 35
Proprietary bank transaction code to identify the underlying transaction.
}
Balance#/definitions/OBTransactionCashBalanceOBTransactionCashBalance{
description:
Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
CreditDebitIndicator*OBCreditDebitCode_2string

Indicates whether the balance is a credit or a debit balance.
Usage: A zero balance is considered to be a credit balance.

Enum:
[ Credit, Debit ]
Type*OBBalanceType1Codestring

Balance type, in a coded form.

Enum:
[ ClosingAvailable, ClosingBooked, ClosingCleared, Expected, ForwardAvailable, Information, InterimAvailable, InterimBooked, InterimCleared, OpeningAvailable, OpeningBooked, OpeningCleared, PreviouslyClosedBooked ]
Amount*{
description:
Amount of money of the cash balance after a transaction entry is applied to the account..
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".

}
}
DebtorAccount#/definitions/OBCashAccount6_1OBCashAccount6_1{
description:

Unambiguous identification of the account of the debtor, in the case of a crebit transaction.

SchemeNameOBExternalAccountIdentification4Codestring

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

IdentificationIdentification_0string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
}
}]
}
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

}
}

OBReadDataTransaction5{
Transaction[#/definitions/OBTransaction5OBTransaction5{
description:
Provides further details on an entry in the report.
AccountId*AccountIdstring
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
TransactionIdTransactionIdstring
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
CreditDebitIndicator*OBCreditDebitCode_1string
Indicates whether the transaction is a credit or a debit entry.
Enum:
[ Credit, Debit ]
Status*OBEntryStatus1Codestring
Status of a transaction entry on the books of the account servicer.
Enum:
[ Booked, Pending ]
BookingDateTime*BookingDateTimestring($date-time)

Date and time when a transaction entry is posted to an account on the account servicer's books.
Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.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

TransactionInformationTransactionInformationstring

Further details of the transaction.
This is the transaction narrative, which is unstructured text.

Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_7OBActiveOrHistoricCurrencyAndAmount_7{
description:
Amount of money in the cash transaction entry.
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".

}
ProprietaryBankTransactionCode#/definitions/ProprietaryBankTransactionCodeStructure1ProprietaryBankTransactionCodeStructure1{
description:
Set of elements to fully identify a proprietary bank transaction code.
Code*string
minLength: 1
maxLength: 35
Proprietary bank transaction code to identify the underlying transaction.
}
Balance#/definitions/OBTransactionCashBalanceOBTransactionCashBalance{
description:
Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
CreditDebitIndicator*OBCreditDebitCode_2string

Indicates whether the balance is a credit or a debit balance.
Usage: A zero balance is considered to be a credit balance.

Enum:
[ Credit, Debit ]
Type*OBBalanceType1Codestring

Balance type, in a coded form.

Enum:
[ ClosingAvailable, ClosingBooked, ClosingCleared, Expected, ForwardAvailable, Information, InterimAvailable, InterimBooked, InterimCleared, OpeningAvailable, OpeningBooked, OpeningCleared, PreviouslyClosedBooked ]
Amount*{
description:
Amount of money of the cash balance after a transaction entry is applied to the account..
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".

}
}
DebtorAccount#/definitions/OBCashAccount6_1OBCashAccount6_1{
description:

Unambiguous identification of the account of the debtor, in the case of a crebit transaction.

SchemeNameOBExternalAccountIdentification4Codestring

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

IdentificationIdentification_0string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
}
}]
}

OBTransaction5{
description:
Provides further details on an entry in the report.
AccountId*AccountIdstring
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
TransactionIdTransactionIdstring
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
CreditDebitIndicator*OBCreditDebitCode_1string
Indicates whether the transaction is a credit or a debit entry.
Enum:
[ Credit, Debit ]
Status*OBEntryStatus1Codestring
Status of a transaction entry on the books of the account servicer.
Enum:
[ Booked, Pending ]
BookingDateTime*BookingDateTimestring($date-time)

Date and time when a transaction entry is posted to an account on the account servicer's books.
Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.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

TransactionInformationTransactionInformationstring

Further details of the transaction.
This is the transaction narrative, which is unstructured text.

Amount*#/definitions/OBActiveOrHistoricCurrencyAndAmount_7OBActiveOrHistoricCurrencyAndAmount_7{
description:
Amount of money in the cash transaction entry.
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".

}
ProprietaryBankTransactionCode#/definitions/ProprietaryBankTransactionCodeStructure1ProprietaryBankTransactionCodeStructure1{
description:
Set of elements to fully identify a proprietary bank transaction code.
Code*string
minLength: 1
maxLength: 35
Proprietary bank transaction code to identify the underlying transaction.
}
Balance#/definitions/OBTransactionCashBalanceOBTransactionCashBalance{
description:
Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
CreditDebitIndicator*OBCreditDebitCode_2string

Indicates whether the balance is a credit or a debit balance.
Usage: A zero balance is considered to be a credit balance.

Enum:
[ Credit, Debit ]
Type*OBBalanceType1Codestring

Balance type, in a coded form.

Enum:
[ ClosingAvailable, ClosingBooked, ClosingCleared, Expected, ForwardAvailable, Information, InterimAvailable, InterimBooked, InterimCleared, OpeningAvailable, OpeningBooked, OpeningCleared, PreviouslyClosedBooked ]
Amount*{
description:
Amount of money of the cash balance after a transaction entry is applied to the account..
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".

}
}
DebtorAccount#/definitions/OBCashAccount6_1OBCashAccount6_1{
description:

Unambiguous identification of the account of the debtor, in the case of a crebit transaction.

SchemeNameOBExternalAccountIdentification4Codestring

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

IdentificationIdentification_0string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
}
}

TransactionIdstring
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.

OBCreditDebitCode_1string
Indicates whether the transaction is a credit or a debit entry.
Enum:
[ Credit, Debit ]

OBEntryStatus1Codestring
Status of a transaction entry on the books of the account servicer.
Enum:
[ Booked, Pending ]

TransactionInformationstring

Further details of the transaction.
This is the transaction narrative, which is unstructured text.

OBActiveOrHistoricCurrencyAndAmount_7{
description:
Amount of money in the cash transaction entry.
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".

}

ProprietaryBankTransactionCodeStructure1{
description:
Set of elements to fully identify a proprietary bank transaction code.
Code*string
minLength: 1
maxLength: 35
Proprietary bank transaction code to identify the underlying transaction.
}

OBTransactionCashBalance{
description:
Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.
CreditDebitIndicator*OBCreditDebitCode_2string

Indicates whether the balance is a credit or a debit balance.
Usage: A zero balance is considered to be a credit balance.

Enum:
[ Credit, Debit ]
Type*OBBalanceType1Codestring

Balance type, in a coded form.

Enum:
[ ClosingAvailable, ClosingBooked, ClosingCleared, Expected, ForwardAvailable, Information, InterimAvailable, InterimBooked, InterimCleared, OpeningAvailable, OpeningBooked, OpeningCleared, PreviouslyClosedBooked ]
Amount*{
description:
Amount of money of the cash balance after a transaction entry is applied to the account..
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".

}
}

OBCashAccount6_1{
description:

Unambiguous identification of the account of the debtor, in the case of a crebit transaction.

SchemeNameOBExternalAccountIdentification4Codestring

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

IdentificationIdentification_0string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
}

OBBalanceType1Codestring

Balance type, in a coded form.

Enum:
[ ClosingAvailable, ClosingBooked, ClosingCleared, Expected, ForwardAvailable, Information, InterimAvailable, InterimBooked, InterimCleared, OpeningAvailable, OpeningBooked, OpeningCleared, PreviouslyClosedBooked ]

OBExternalAccountIdentification4Codestring

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

Identification_0string
Identification assigned by an institution to identify an account. This identification is known by the account owner.

BookingDateTimestring($date-time)

Date and time when a transaction entry is posted to an account on the account servicer's books.
Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.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

OBCreditDebitCode_2string

Indicates whether the balance is a credit or a debit balance.
Usage: A zero balance is considered to be a credit balance.

Enum:
[ Credit, Debit ]

Having trouble?

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

OpenBankingResponse@virginmoney.com

Contact us