Cynergy Bank Statements API
The Statements API from Cynergy Bank — 5 operation(s) for statements.
The Statements API from Cynergy Bank — 5 operation(s) for statements.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/cynergy-bank-statements-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Account and Transaction API Specification Statements API
description: 'Swagger for Account and Transaction API Specification.
**Please Note**: There are no optional fields, if a field is not marked as “Required” it is a Conditional field.
'
termsOfService: https://www.openbanking.org.uk/terms
contact:
name: Service Desk
email: ServiceDesk@openbanking.org.uk
license:
name: open-licence
url: https://www.openbanking.org.uk/open-licence
version: 4.0.1
servers:
- url: /open-banking/v4.0/aisp
tags:
- name: Statements
paths:
/accounts/{AccountId}/statements:
get:
tags:
- Statements
summary: Get Statements for an AccountId
description: Enables an AISP to retrieve statement information for a specific PSU account.
operationId: GetAccountsAccountIdStatements
parameters:
- $ref: '#/components/parameters/AccountId'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/FromStatementDateTimeParam'
- $ref: '#/components/parameters/ToStatementDateTimeParam'
- $ref: '#/components/parameters/x-client-id'
responses:
'200':
$ref: '#/components/responses/200AccountsAccountIdStatementsRead'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'405':
$ref: '#/components/responses/405Error'
'406':
$ref: '#/components/responses/406Error'
'429':
$ref: '#/components/responses/429Error'
'500':
$ref: '#/components/responses/500Error'
security:
- PSUOAuth2Security:
- accounts
/accounts/{AccountId}/statements/{StatementId}:
get:
tags:
- Statements
summary: Get Statement by StatementId for an AccountId
description: Enables an AISP to retrieve the statement information resource for a specific statement.
operationId: GetAccountsAccountIdStatementsStatementId
parameters:
- $ref: '#/components/parameters/StatementId'
- $ref: '#/components/parameters/AccountId'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-client-id'
responses:
'200':
$ref: '#/components/responses/200AccountsAccountIdStatementsStatementIdRead'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'405':
$ref: '#/components/responses/405Error'
'406':
$ref: '#/components/responses/406Error'
'429':
$ref: '#/components/responses/429Error'
'500':
$ref: '#/components/responses/500Error'
security:
- PSUOAuth2Security:
- accounts
/accounts/{AccountId}/statements/{StatementId}/file:
get:
tags:
- Statements
summary: Get Statement file by StatementId for an AccountId
description: Enables an AISP to retrieve a non-json representation of a specific statement.
operationId: GetAccountsAccountIdStatementsStatementIdFile
parameters:
- $ref: '#/components/parameters/StatementId'
- $ref: '#/components/parameters/AccountId'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-client-id'
responses:
'200':
$ref: '#/components/responses/200AccountsAccountIdStatementsStatementIdFileRead'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'405':
$ref: '#/components/responses/405Error'
'406':
$ref: '#/components/responses/406Error'
'429':
$ref: '#/components/responses/429Error'
'500':
$ref: '#/components/responses/500Error'
security:
- PSUOAuth2Security:
- accounts
/accounts/{AccountId}/statements/{StatementId}/transactions:
get:
tags:
- Statements
summary: Get Statement Transactions for an AccountId
description: Enables an AISP to retrieve transactions that appear on a selected statement for a specific PSU account.
operationId: GetAccountsAccountIdStatementsStatementIdTransactions
parameters:
- $ref: '#/components/parameters/StatementId'
- $ref: '#/components/parameters/AccountId'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-client-id'
responses:
'200':
$ref: '#/components/responses/200AccountsAccountIdStatementsStatementIdTransactionsRead'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'405':
$ref: '#/components/responses/405Error'
'406':
$ref: '#/components/responses/406Error'
'429':
$ref: '#/components/responses/429Error'
'500':
$ref: '#/components/responses/500Error'
security:
- PSUOAuth2Security:
- accounts
/statements:
get:
tags:
- Statements
summary: Get Statements
description: Enables an AISP to retrieve statement information for account(s) that the PSU has consented to.
operationId: GetStatements
parameters:
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/FromStatementDateTimeParam'
- $ref: '#/components/parameters/ToStatementDateTimeParam'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-client-id'
responses:
'200':
$ref: '#/components/responses/200StatementsRead'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'404':
$ref: '#/components/responses/404Error'
'405':
$ref: '#/components/responses/405Error'
'406':
$ref: '#/components/responses/406Error'
'429':
$ref: '#/components/responses/429Error'
'500':
$ref: '#/components/responses/500Error'
security:
- PSUOAuth2Security:
- accounts
components:
schemas:
AccountId:
description: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
type: string
example: '22289'
minLength: 1
maxLength: 40
OBUltimateCreditor1:
description: Ultimate party to which an amount of money is due.
type: object
properties:
Name:
description: Name by which a party is known and which is usually used to identify that party.
type: string
minLength: 1
maxLength: 140
Identification:
description: Identification assigned by an institution.
type: string
minLength: 1
maxLength: 256
LEI:
$ref: '#/components/schemas/LEI'
SchemeName:
$ref: '#/components/schemas/OBInternalAccountIdentification4Code'
PostalAddress:
$ref: '#/components/schemas/OBPostalAddress7'
StreetName:
description: Name of a street or thoroughfare.
type: string
example: Bank Street
minLength: 1
maxLength: 140
OBInternalStatementAmountType1Code:
description: Amount type, in a coded form.
type: string
example: UK.OBIE.CreditLimit
x-namespaced-enum:
- UK.OBIE.ArrearsClosingBalance
- UK.OBIE.AvailableBalance
- UK.OBIE.AverageBalanceWhenInCredit
- UK.OBIE.AverageBalanceWhenInDebit
- UK.OBIE.AverageDailyBalance
- UK.OBIE.BalanceTransferClosingBalance
- UK.OBIE.CashClosingBalance
- UK.OBIE.ClosingBalance
- UK.OBIE.CreditLimit
- UK.OBIE.CurrentPayment
- UK.OBIE.DirectDebitPaymentDue
- UK.OBIE.FSCSInsurance
- UK.OBIE.MinimumPaymentDue
- UK.OBIE.PendingTransactionsBalance
- UK.OBIE.PreviousClosingBalance
- UK.OBIE.PreviousPayment
- UK.OBIE.PurchaseClosingBalance
- UK.OBIE.StartingBalance
- UK.OBIE.TotalAdjustments
- UK.OBIE.TotalCashAdvances
- UK.OBIE.TotalCharges
- UK.OBIE.TotalCredits
- UK.OBIE.TotalDebits
- UK.OBIE.TotalPurchases
ActiveOrHistoricCurrencyCode_1:
description: 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".
type: string
example: GBP
pattern: ^[A-Z]{3,3}$
TownName:
description: Name of a built-up area, with defined boundaries, and a local government.
type: string
example: London
minLength: 1
maxLength: 140
BuildingName:
description: Name of a referenced building.
type: string
minLength: 1
maxLength: 140
OBTransaction6:
type: object
description: Provides further details on an entry in the report.
required:
- AccountId
- CreditDebitIndicator
- Status
- BookingDateTime
- Amount
properties:
AccountId:
$ref: '#/components/schemas/AccountId'
TransactionId:
$ref: '#/components/schemas/TransactionId'
TransactionReference:
$ref: '#/components/schemas/TransactionReference'
StatementReference:
type: array
items:
$ref: '#/components/schemas/StatementReference'
CreditDebitIndicator:
$ref: '#/components/schemas/OBCreditDebitCode_1'
Status:
$ref: '#/components/schemas/ExternalEntryStatus1Code'
TransactionMutability:
$ref: '#/components/schemas/OBInternalTransactionMutability1Code'
BookingDateTime:
$ref: '#/components/schemas/BookingDateTime'
ValueDateTime:
$ref: '#/components/schemas/ValueDateTime'
TransactionInformation:
$ref: '#/components/schemas/TransactionInformation'
AddressLine:
$ref: '#/components/schemas/AddressLine'
Amount:
$ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_9'
ChargeAmount:
$ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_10'
CurrencyExchange:
$ref: '#/components/schemas/OBCurrencyExchange5'
BankTransactionCode:
$ref: '#/components/schemas/OBBankTransactionCodeStructure1'
ProprietaryBankTransactionCode:
$ref: '#/components/schemas/ProprietaryBankTransactionCodeStructure1'
ExtendedProprietaryBankTransactionCodes:
type: array
items:
$ref: '#/components/schemas/OBExtendedProprietaryBankTransactionCode'
Balance:
$ref: '#/components/schemas/OBTransactionCashBalance'
MerchantDetails:
$ref: '#/components/schemas/OBMerchantDetails1'
CreditorAgent:
$ref: '#/components/schemas/OBBranchAndFinancialInstitutionIdentification6_1'
CreditorAccount:
$ref: '#/components/schemas/OBCashAccount6_0'
DebtorAgent:
$ref: '#/components/schemas/OBBranchAndFinancialInstitutionIdentification6_2'
DebtorAccount:
$ref: '#/components/schemas/OBCashAccount6_1'
CardInstrument:
$ref: '#/components/schemas/OBTransactionCardInstrument1'
SupplementaryData:
$ref: '#/components/schemas/OBSupplementaryData1'
CategoryPurposeCode:
$ref: '#/components/schemas/ExternalCategoryPurpose1Code'
PaymentPurposeCode:
$ref: '#/components/schemas/OBExternalPurpose1Code'
UltimateCreditor:
$ref: '#/components/schemas/OBUltimateCreditor1'
UltimateDebtor:
$ref: '#/components/schemas/OBUltimateDebtor1'
IntermediaryAgent1:
$ref: '#/components/schemas/OBIntermediaryAgent'
IntermediaryAgent2:
$ref: '#/components/schemas/OBIntermediaryAgent'
IntermediaryAgent3:
$ref: '#/components/schemas/OBIntermediaryAgent'
additionalProperties: false
OBExtendedProprietaryBankTransactionCode:
type: object
description: Additional proprietary bank transaction codes used by the ASPSP for the underlying transaction
required:
- Code
properties:
Code:
type: string
description: Proprietary bank transaction code to identify the underlying transaction.
minLength: 1
maxLength: 35
Issuer:
type: string
description: Identification of the issuer of the proprietary bank transaction code.
minLength: 1
maxLength: 35
Description:
type: string
description: Description of the code and its usage on the ASPSP channel
minLength: 1
maxLength: 500
BookingDateTime:
description: "Date and time when a transaction entry is posted to an account on the account servicer's books.\nUsage: 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. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
DistrictName:
description: Number that of the regional area, known as a district, which forms part of an address
type: string
example: Greater London
minLength: 1
maxLength: 140
OBMerchantDetails1:
type: object
description: Details of the merchant involved in the transaction.
properties:
MerchantName:
description: Name by which the merchant is known.
type: string
minLength: 1
maxLength: 350
MerchantCategoryCode:
description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.
type: string
minLength: 3
maxLength: 4
PostBox:
description: Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
type: string
example: PO Box 123456
minLength: 1
maxLength: 16
OBInternalStatementFeeRateType1Code:
description: This code indicates the specific type of fee rate (e.g., AER, EAR). For a full list of values see `OBInternalStatementFeeRateType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
example: UK.OBIE.AER
x-namespaced-enum:
- UK.OBIE.AER
- UK.OBIE.EAR
BuildingNumber:
description: Number that identifies the position of a building on a street.
type: string
example: '11'
minLength: 1
maxLength: 16
OBInternalStatementBenefitType1Code:
description: Benefit type, in a coded form. For a full list of values see `OBInternalStatementBenefitType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
example: UK.OBIE.Cashback
x-namespaced-enum:
- UK.OBIE.Cashback
- UK.OBIE.Insurance
- UK.OBIE.TravelDiscount
- UK.OBIE.TravelInsurance
OBInternalStatementFeeType1Code:
description: Fee type, in a coded form. For a full list of values see `OBInternalStatementFeeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
example: UK.OBIE.Annual
x-namespaced-enum:
- UK.OBIE.Annual
- UK.OBIE.BalanceTransfer
- UK.OBIE.CashAdvance
- UK.OBIE.CashTransaction
- UK.OBIE.ForeignCashTransaction
- UK.OBIE.ForeignTransaction
- UK.OBIE.Gambling
- UK.OBIE.LatePayment
- UK.OBIE.MoneyTransfer
- UK.OBIE.Monthly
- UK.OBIE.Overlimit
- UK.OBIE.PostalOrder
- UK.OBIE.PrizeEntry
- UK.OBIE.StatementCopy
- UK.OBIE.Total
- UK.OBIE.InstalmentPlan
- UK.OBIE.ReturnedPayment
OBInternalStatementType1Code:
description: Statement type, in a coded form. For a full list of values see `OBInternalStatementType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
example: RegularPeriodic
enum:
- AccountClosure
- AccountOpening
- Annual
- Interim
- RegularPeriodic
OBInternalAccountIdentification4Code:
description: Name of the identification scheme, in a coded form as published in an external list. <br /> For a full list of enumeration values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
x-namespaced-enum:
- UK.OBIE.BBAN
- UK.OBIE.IBAN
- UK.OBIE.PAN
- UK.OBIE.Paym
- UK.OBIE.SortCodeAccountNumber
- UK.OBIE.Wallet
OBActiveOrHistoricCurrencyAndAmount_6:
type: object
required:
- Amount
- Currency
description: Amount of money associated with the statement fee type.
properties:
Amount:
$ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1'
TransactionInformation:
description: "Further details of the transaction. \nThis is the transaction narrative, which is unstructured text."
type: string
minLength: 1
maxLength: 500
OBInternalStatementFeeFrequency1Code:
description: How frequently the fee is applied to the Account. For a full list of values see `OBInternalStatementFeeFrequency1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
example: UK.OBIE.StatementMonthly
x-namespaced-enum:
- UK.OBIE.ChargingPeriod
- UK.OBIE.PerTransactionAmount
- UK.OBIE.PerTransactionPercentage
- UK.OBIE.Quarterly
- UK.OBIE.StatementMonthly
- UK.OBIE.Weekly
OBRate1_0:
description: Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)
example: 0.05
type: number
OBReadDataTransaction6:
type: object
properties:
Transaction:
type: array
items:
$ref: '#/components/schemas/OBTransaction6'
additionalProperties: false
File:
type: object
properties: {}
OBSupplementaryData1:
type: object
properties: {}
additionalProperties: true
description: Additional information that can not be captured in the structured fields and/or any other specific block.
OBAddressType2Code:
description: Identifies the nature of the postal address. <br /> For a full set of codes see `OBAddressType2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
type: string
example: BIZZ
enum:
- BIZZ
- DLVY
- MLTO
- PBOX
- ADDR
- HOME
- CORR
- STAT
OBBranchAndFinancialInstitutionIdentification6_2:
type: object
description: Financial institution servicing an account for the debtor.
properties:
SchemeName:
$ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code'
Identification:
$ref: '#/components/schemas/Identification_2'
Name:
$ref: '#/components/schemas/Name_1'
LEI:
$ref: '#/components/schemas/LEI'
PostalAddress:
$ref: '#/components/schemas/OBPostalAddress7'
Rate:
description: Rate associated with the statement rate type.
type: string
example: '0.224'
maxLength: 40
pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$
Identification_2:
description: Unique and unambiguous identification of a financial institution or a branch of a financial institution.
type: string
minLength: 1
maxLength: 35
OBCreditDebitCode_1:
description: 'Indicates whether the transaction is a credit or a debit entry. <br />
<br />
For a full list of enumeration values refer to `OBInternalCreditDebitCode` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)'
type: string
enum:
- Credit
- Debit
OBActiveOrHistoricCurrencyAndAmount_9:
type: object
required:
- Amount
- Currency
description: Amount of money in the cash transaction entry.
properties:
Amount:
$ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1'
OBInternalStatementValueType1Code:
description: Statement value type, in a coded form. For a full list of values see `OBInternalStatementValueType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
example: UK.OBIE.Credit
x-namespaced-enum:
- UK.OBIE.AirMilesPoints
- UK.OBIE.AirMilesPointsBalance
- UK.OBIE.Credits
- UK.OBIE.Debits
- UK.OBIE.HotelPoints
- UK.OBIE.HotelPointsBalance
- UK.OBIE.RetailShoppingPoints
- UK.OBIE.RetailShoppingPointsBalance
Links:
type: object
description: Links relevant to the payload
properties:
Self:
type: string
format: uri
First:
type: string
format: uri
Prev:
type: string
format: uri
Next:
type: string
format: uri
Last:
type: string
format: uri
additionalProperties: false
required:
- Self
OBError1:
type: object
properties:
ErrorCode:
$ref: '#/components/schemas/OBExternalStatusReason1Code'
Message:
description: 'A description of the error that occurred. e.g., ''A mandatory field isn''t supplied'' or ''RequestedExecutionDateTime must be in future''
OBL doesn''t standardise this field'
type: string
minLength: 1
maxLength: 500
Path:
description: Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
type: string
minLength: 1
maxLength: 500
Url:
description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc
type: string
required:
- ErrorCode
additionalProperties: false
minProperties: 1
OBTransactionCardInstrument1:
type: object
required:
- CardSchemeName
description: 'Set of elements to describe the card instrument used in the transaction. <br />
For a full list of enumeration values refer to `OBInternalCardSchemeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)'
properties:
CardSchemeName:
description: 'Name of the card scheme. <br />
For a full list of enumeration values refer to `OBInternalCardSchemeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)'
type: string
enum:
- AmericanExpress
- Diners
- Discover
- MasterCard
- VISA
AuthorisationType:
description: 'The card authorisation type. <br />
For a full list of enumeration values refer to `OBInternalCardAuthorisationType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)'
type: string
enum:
- ConsumerDevice
- Contactless
- None
- PIN
Name:
description: Name of the cardholder using the card instrument.
type: string
minLength: 1
maxLength: 70
Identification:
description: Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked.
type: string
minLength: 1
maxLength: 34
additionalProperties: false
DateTime:
description: "Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
example: '2024-05-29T00:00:00Z'
format: date-time
ISODateTime:
description: "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
type: string
format: date-time
OBExternalPurpose1Code:
type: string
minLength: 1
maxLength: 4
description: For a full list of enumeration values refer to `ExternalPurpose1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
enum:
- BKDF
- BKFE
- BKFM
- BKIP
- BKPP
- CBLK
- CDCB
- CDCD
- CDCS
- CDDP
- CDOC
- CDQC
- ETUP
- FCOL
- MTUP
- ACCT
- CASH
- COLL
- CSDB
- DEPT
- INTC
- INTP
- LIMA
- NETT
- BFWD
- CCIR
- CCPC
- CCPM
- CCSM
- CRDS
- CRPR
- CRSP
- CRTL
- EQPT
- EQUS
- EXPT
- EXTD
- FIXI
- FWBC
- FWCC
- FWSB
- FWSC
- MARG
- MBSB
- MBSC
- MGCC
- MGSC
- OCCC
- OPBC
- OPCC
- OPSB
- OPSC
- OPTN
- OTCD
- REPO
- RPBC
- RPCC
- RPSB
- RPSC
- RVPO
- SBSC
- SCIE
- SCIR
- SCRP
- SHBC
- SHCC
- SHSL
- SLEB
- SLOA
- SWBC
- SWCC
- SWPT
- SWSB
- SWSC
- TBAS
- TBBC
- TBCC
- TRCP
- AGRT
- AREN
- BEXP
- BOCE
- COMC
- CPYR
- GDDS
- GDSV
- GSCB
- LICF
- MP2B
- POPE
- ROYA
- SCVE
- SERV
- SUBS
- SUPP
- TRAD
- CHAR
- COMT
- MP2P
- ECPG
- ECPR
- ECPU
- EPAY
- CLPR
- COMP
- DBTC
- GOVI
- HLRP
- HLST
- INPC
- INPR
- INSC
- INSU
- INTE
- LBRI
- LIFI
- LOAN
- LOAR
- PENO
- PPTI
- RELG
- RINP
- TRFD
- FORW
- FXNT
- ADMG
- ADVA
- BCDM
- BCFG
- BLDM
- BNET
- CBFF
- CBFR
- CCRD
- CDBL
- CFEE
- CGDD
- CORT
- COST
- CPKC
- DCRD
- DSMT
- DVPM
- EDUC
- FACT
- FAND
- FCPM
- FEES
- GIFT
- GOVT
- ICCP
- IDCP
- IHRP
- INSM
- IVPT
- MCDM
- MCFG
- MSVC
- NOWS
- OCDM
- OCFG
- OFEE
- OTHR
- PADD
- PTSP
- RCKE
- RCPT
- REBT
- REFU
- RENT
- REOD
- RIMB
- RPNT
- RRBN
- RRCT
- RRTP
- RVPM
- SLPI
- SPLT
- STDY
- TBAN
- TBIL
- TCSC
- TELI
- TMPG
- TPRI
- TPRP
- TRNC
- TRVC
- WEBI
- IPAY
- IPCA
- IPDO
- IPEA
- IPEC
- IPEW
- IPPS
- IPRT
- IPU2
- IPUW
- ANNI
- CAFI
- CFDI
- CMDT
- DERI
- DIVD
- FREX
- HEDG
- INVS
- PRME
- SAVG
- SECU
- SEPI
- TREA
- UNIT
- FNET
- FUTR
- ANTS
- CVCF
- DMEQ
- DNTS
- HLTC
- HLTI
- HSPC
- ICRF
- LTCF
- MAFC
- MARF
- MDCS
- VIEW
- CDEP
- SWFP
- SWPP
- SWRS
- SWUF
- ADCS
- AEMP
- ALLW
- ALMY
- BBSC
- BECH
- BENE
- BONU
- CCHD
- COMM
- CSLP
- GFRP
- GVEA
- GVEB
- GVEC
- GVED
- GWLT
- HREC
- PAYR
- PEFC
- PENS
- PRCP
- RHBS
- SALA
- SPSP
- SSBE
- LBIN
- LCOL
- LFEE
- LMEQ
- LMFI
- LMRK
- LREB
- LREV
- LSFL
- ESTX
- FWLV
- GSTX
- HSTX
- INTX
- NITX
- PTXP
- RDTX
- TAXS
- VATX
- WHLD
- TAXR
- B112
- BR12
- TLRF
- TLRR
- AIRB
- BUSB
- FERB
- RLWY
- TRPT
- CBTV
- ELEC
- ENRG
- GASB
- NWCH
- NWCM
- OTLC
- PHON
- UBIL
- WTER
- BOND
- CABD
- CAEQ
- CBCR
- DBCR
- DICL
- EQTS
- FLCR
- EFTC
- EFTD
- MOMA
- RAPI
- GAMB
- LOTT
- AMEX
- SASW
- AUCO
- PCOM
- PDEP
- PLDS
- PLRF
- GAFA
- GAHO
- CPEN
- DEPD
- RETL
- DEBT
- CRYP
OBCashAccount6_0:
type: object
description: Unambiguous identification of the account of the creditor, in the case of a debit transaction.
properties:
SchemeName:
$ref: '#/components/schemas/OBInternalAccountIdentification4Code'
Identification:
$ref: '#/components/schemas/Identification_0'
Name:
$ref: '#/components/schemas/Name_0'
SecondaryIdentification:
$ref: '#/components/schemas/SecondaryIdentification'
Proxy:
$ref: '#/components/schemas/OBProxy1'
Description_2:
description: Description that may be available for the statement interest.
example: Interest occurred over statement duration
type: string
minLength: 1
maxLength: 128
ValueDateTime:
description: "Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available
# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cynergy-bank/refs/heads/main/openapi/cynergy-bank-statements-api-openapi.yml