GB Bank Transactions API
The Transactions API from GB Bank — 2 operation(s) for transactions.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/gb-bank-transactions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
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 Specification
openapi: 3.2.0
info:
title: Account and Transaction API Specification Transactions 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: Transactions
paths:
/accounts/{AccountId}/transactions:
get:
tags:
- Transactions
summary: Get Transactions for an AccountId
description: Enables an AISP to retrieve transaction information for a specific PSU account.
operationId: GetAccountsAccountIdTransactions
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/FromBookingDateTimeParam'
- $ref: '#/components/parameters/ToBookingDateTimeParam'
- $ref: '#/components/parameters/x-client-id'
responses:
'200':
$ref: '#/components/responses/200AccountsAccountIdTransactionsRead'
'400':
$ref: '#/components/responses/400Error'
'401':
$ref: '#/components/responses/401Error'
'403':
$ref: '#/components/responses/403Error'
'405':
$ref: '#/components/responses/405Error'
'406':
$ref: '#/components/responses/406Error'
'429':
$ref: '#/components/responses/429Error'
'500':
$ref: '#/components/responses/500Error'
security:
- PSUOAuth2Security:
- accounts
/transactions:
get:
tags:
- Transactions
summary: Get Transactions
description: Enables an AISP to retrieve transaction information for account(s) that the PSU has consented to.
operationId: GetTransactions
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/x-customer-user-agent'
- $ref: '#/components/parameters/FromBookingDateTimeParam'
- $ref: '#/components/parameters/ToBookingDateTimeParam'
- $ref: '#/components/parameters/x-client-id'
responses:
'200':
$ref: '#/components/responses/200TransactionsRead'
'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:
Name_1:
description: Name by which an agent is known and which is usually used to identify that agent.
type: string
example: Agent Name
minLength: 1
maxLength: 140
TownName:
description: Name of a built-up area, with defined boundaries, and a local government.
type: string
example: London
minLength: 1
maxLength: 140
TransactionReference:
description: Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
type: string
minLength: 1
maxLength: 210
OBUltimateDebtor1:
description: Ultimate party that owes an amount of money to the (ultimate) creditor.
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'
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'
OBReadTransaction6:
type: object
required:
- Data
properties:
Data:
$ref: '#/components/schemas/OBReadDataTransaction6'
Links:
$ref: '#/components/schemas/Links'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
TransactionInformation:
description: "Further details of the transaction. \nThis is the transaction narrative, which is unstructured text."
type: string
minLength: 1
maxLength: 500
OBErrorResponse1:
description: An array of detail error codes, and messages, and URLs to documentation to help remediation.
type: object
properties:
Id:
description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
type: string
minLength: 1
maxLength: 40
Code:
description: Deprecated <br />High level textual error code, to help categorise the errors.
type: string
minLength: 1
example: 400 BadRequest
maxLength: 40
Message:
description: Deprecated <br />Brief Error message
type: string
minLength: 1
example: There is something wrong with the request parameters provided
maxLength: 500
Errors:
items:
$ref: '#/components/schemas/OBError1'
type: array
minItems: 1
required:
- Errors
additionalProperties: false
OBActiveCurrencyAndAmount_SimpleType:
description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
type: string
example: '1209.06'
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
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
OBExternalStatusReason1Code:
description: Low level textual error code, for all enum values see `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
minLength: 4
maxLength: 4
example: U001
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}$
OBActiveOrHistoricCurrencyAndAmount_10:
type: object
required:
- Amount
- Currency
description: Transaction charges to be paid by the charge bearer.
properties:
Amount:
$ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1'
OBSupplementaryData1:
type: object
properties: {}
additionalProperties: true
description: Additional information that can not be captured in the structured fields and/or any other specific block.
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
OBInternalTransactionMutability1Code:
description: 'Specifies the Mutability of the Transaction record. <br />
For a full list of enumeration values refer to `OBInternalTransactionMutability1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)'
type: string
enum:
- Mutable
- Immutable
OBIntermediaryAgent:
description: The intermediary agent associated with this transaction.
type: object
properties:
Name:
description: Name by which an agent is known and which is usually used to identify that agent.
type: string
minLength: 1
maxLength: 140
SchemeName:
$ref: '#/components/schemas/OBInternalAccountIdentification4Code'
Identification:
description: Unique and unambiguous identification of a financial institution or a branch of a financial institution.
type: string
minLength: 1
maxLength: 35
LEI:
$ref: '#/components/schemas/LEI'
PostalAddress:
$ref: '#/components/schemas/OBPostalAddress7'
ProcessingStatus:
description: Status of the payment at the Intermediary Agent. For a full list of enumeration values refer to `OBIntermediaryAgentStatus1Code` in `OB_Internal_CodeSet` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
enum:
- PDNG
- RCVD
- ACSP
- ACSC
- RJCT
- UNKN
- CANC
OBTransactionCashBalance:
type: object
required:
- CreditDebitIndicator
- Type
- Amount
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.
properties:
CreditDebitIndicator:
$ref: '#/components/schemas/OBCreditDebitCode_2'
Type:
$ref: '#/components/schemas/OBBalanceType1Code'
Amount:
type: object
required:
- Amount
- Currency
description: Amount of money of the cash balance after a transaction entry is applied to the account..
properties:
Amount:
$ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1'
additionalProperties: false
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
OBProxy1:
description: Specifies an alternate assumed name for the identification of the account.
type: object
required:
- Identification
- Code
properties:
Identification:
description: Identification used to indicate the account identification under another specified name.
type: string
example: '2360549017905188'
minLength: 1
maxLength: 2048
Code:
$ref: '#/components/schemas/ExternalProxyAccountType1Code'
Type:
type: string
description: Type of the proxy identification.
minLength: 1
maxLength: 35
ProprietaryBankTransactionCodeStructure1:
type: object
required:
- Code
description: Set of elements to fully identify a proprietary bank transaction code.
properties:
Code:
description: Proprietary bank transaction code to identify the underlying transaction.
type: string
minLength: 1
maxLength: 35
Issuer:
description: Identification of the issuer of the proprietary bank transaction code.
type: string
minLength: 1
maxLength: 35
additionalProperties: false
OBBankTransactionCodeStructure1:
type: object
required:
- Code
- SubCode
description: Set of elements used to fully identify the type of underlying transaction resulting in an entry.
properties:
Code:
description: Specifies the family within a domain.
type: string
SubCode:
description: Specifies the sub-product family within a specific family.
type: string
UnitNumber:
description: Number that identifies the unit of a specific address .
type: string
example: A88
minLength: 1
maxLength: 16
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 to the account owner in case of a debit transaction entry.\nUsage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date.\nFor transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days. 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
SecondaryIdentification:
description: "This is secondary identification of the account, as assigned by the account servicing institution. \nThis can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)."
type: string
example: '87562298675897'
minLength: 1
maxLength: 34
OBBranchAndFinancialInstitutionIdentification6_1:
type: object
description: Financial institution servicing an account for the creditor.
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'
BuildingName:
description: Name of a referenced building.
type: string
minLength: 1
maxLength: 140
OBInternalFinancialInstitutionIdentification4Code:
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 `OBInternalFinancialInstitutionIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
example: UK.OBIE.BICFI
x-namespaced-enum:
- UK.OBIE.BICFI
Floor:
description: Number that identifies the level within a building
type: string
example: '11'
minLength: 1
maxLength: 70
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
Identification_0:
description: Identification assigned by an institution to identify an account. This identification is known by the account owner.
type: string
example: '80200112344562'
minLength: 1
maxLength: 256
Name_0:
description: 'The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP''s online channels.
Note, the account name is not the product name or the nickname of the account.'
type: string
example: Jane Smith
minLength: 1
maxLength: 350
StatementReference:
description: Unique reference for the statement. This reference may be optionally populated if available.
type: string
example: '002'
minLength: 1
maxLength: 35
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'
PostCode:
description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
type: string
example: EC2N 4AG
minLength: 1
maxLength: 16
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
ExternalCategoryPurpose1Code:
description: Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see `ExternalCategoryPurpose1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
type: string
enum:
- BONU
- CASH
- CBLK
- CCRD
- CGWV
- CIPC
- CONC
- CORT
- DCRD
- DIVI
- DVPM
- EPAY
- FCDT
- FCIN
- FCOL
- GOVT
- GP2P
- HEDG
- ICCP
- IDCP
- INTC
- INTE
- LBOX
- LOAN
- MP2B
- MP2P
- OTHR
- PENS
- RPRE
- RRCT
- RVPM
- SALA
- SECU
- SSBE
- SUPP
- SWEP
- TAXS
- TOPG
- TRAD
- TREA
- VATX
- VOST
- WHLD
- ZABA
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
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'
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
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
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
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
ExternalEntryStatus1Code:
description: 'Status of a transaction entry on the books of the account servicer. <br />
For a full list of enumeration values refer to `ExternalEntryStatus1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)'
type: string
enum:
- BOOK
- FUTR
- INFO
- PDNG
- RJCT
StreetName:
description: Name of a street or thoroughfare.
type: string
example: Bank Street
minLength: 1
maxLength: 140
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
OBPostalAddress7:
type: object
description: Information that locates and identifies a specific address, as defined by postal services.
properties:
AddressType:
$ref: '#/components/schemas/OBAddressType2Code'
Department:
description: Identification of a division of a large organisation or building.
example: Finance
type: string
minLength: 1
maxLength: 70
SubDepartment:
description: Identification of a sub-division of a large organisation or building.
example: Payroll
type: string
minLength: 1
maxLength: 70
StreetName:
$ref: '#/components/schemas/StreetName'
BuildingNumber:
$ref: '#/components/schemas/BuildingNumber'
BuildingName:
$ref: '#/components/schemas/BuildingName'
Floor:
$ref: '#/components/schemas/Floor'
UnitNumber:
$ref: '#/components/schemas/UnitNumber'
Room:
$ref: '#/components/schemas/Room'
PostBox:
$ref: '#/components/schemas/PostBox'
TownLocationName:
$ref: '#/components/schemas/TownName'
DistrictName:
$ref: '#/components/schemas/DistrictName'
CareOf:
$ref: '#/components/schemas/CareOf'
PostCode:
$ref: '#/components/schemas/PostCode'
TownName:
$ref: '#/components/schemas/TownName'
CountrySubDivision:
description: Identifies a subdivision of a country such as state, region
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gb-bank/refs/heads/main/openapi/gb-bank-transactions-api-openapi.yml