accountId | string – required in path; unique bank account ID to specify the account information requested

200 Success | status=OK – operation completed successfully

account | object – contains information about the requested bank account

accountDetails | object – contains details that identify, correlate and validate the bank account details

accountHolderName | string – name of the account holder/owner

bic | string – standard format for business identifier code (also) known as SWIFT code) used to identify banks and financial institutions globally

identifier | string – type of accountIdentifier being used — bban, gbDomestic, iban, msisdn, pan or token

accountIdentifiers | object – account numbers and other strings that identify this as a unique bank account

bangiro | object –identifier for domestic bank accounts in Sweden

bankgiroNumber | string – consists of 7 or 8 digits; clearing code is not used

bban | object – represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers.

bban | string – 10 to 30 characters comprising the bank code (including the account number) and a checksum key

gbDomestic | object – a domestic bank account in the UK

accountNumber | string – unique string of numbers identifying a deposit account

sortCode | string – number assigned to a branch of a bank, typically containing six digits in the ##-##-## format and most commonly used in the UK and Ireland

iban | object – international bank account number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders

iban | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

msisdn | object – mobile station International subscriber director number is basically the user's mobile phone number; used as a unique identity to enable routing of voice and SMS traffic to and from a specific subscription/ device on a wireless/mobile network

msisdn | string – composed of the country code and the national destination code; be sure to remove the + sign and any 0 before the mobile number

pan | object – primary account number; card identifier found on payment cards, such as credit cards and debit cards, as well as stored-value cards, gift cards and other similar card, sometimes referred to as a bank card number

pan | string – 14, 15, or 16 digit number generated as a unique identifier for a primary account

plusgiro | object – domestic transaction clearing system in Sweden

plusgiroNumber | string – bank account number (minimum 2 and maximum 8 digits); clearing code is not used

token | object – primary account number; card identifier found on payment cards, such as credit cards and debit cards, as well as stored-value cards, gift cards and other similar card, sometimes referred to as a bank card number

accountId | string – bank account identifier for a linked account used by Token's Bank Integration Account Linking Service

memberId | string – Token-generated member identifier for the user/account holder

metadata | object – additional fields returned by the bank at its option in response to your particular request. The presence and type of metadata are entirely dependent on the bank and generally comprise additional information about the account or the transaction pertinent to your specific use case. How you use this information, when included in the bank's response, is entirely up to you

bank-defined | [*] – bank-dependent fields 0 .. n; each respective data type is also bank-dependent (string, number, boolean, null/empty, object, or array)

providerAccountDetails | object – specific information regarding the bank required by the respective Open Banking API standard adopted (CMA9, NextGenPSD2, PolishAPI, or STET)

cma9AccountDetails | object – provider account details required under the CMA9 standard

accountSubtype | string – specifies the sub type of the account (INVALID_ACCOUNT_SUBTYPE, CHARGE_CARD, CURRENT_ACCOUNT, EMONEY, LOAN, MORTGAGE, PREPAID_CARD, SAVINGS); default = INVALID_ACCOUNT_SUBTYPE

accountType | string – Specifies the sub type of account (INVALID_ACCOUNT_TYPE, BUSINESS_ACCOUNT, PERSONAL_ACCOUNT); default = INVALID_ACCOUNT_TYPE

address | object – complete postal address of a party

city | string – name of the city as given in postal addresses of the building/area

conscriptNumber | string – special kind of house number; relates to a settlement instead of a street. Conscription numbers were introduced in the Austro-Hungarian Empire and are still in use in some parts of Europe, sometimes together with street-related house numbers, which are also called orientation numbers

country | string – nation with its own government, occupying a particular territory containing the address

district | string – defined district within the city or country containing the address

flats | string – house numbers (range or list) of flats behind a door

full | string – used for a full-text, often multi-line, address if you find the structured address fields unsuitable for denoting the address of this particular location. Examples: "Fifth house on the left after the village oak, Smalltown, Smallcounty" or "1200 West Sunset Boulevard Suite 110A". Typically, such strings cannot be parsed by software

hamlet | string – small human settlement. In different jurisdictions and geographies, a hamlet may be the size of a town, village or parish, or may be considered to be a smaller settlement or subdivision or satellite entity to a larger settlement

houseName | string – name of a house; sometimes used in countries like England instead of (or in addition to) a house number

houseNumber | string – house number (may contain letters, dashes or other characters); identifies a single building with multiple addresses

place | string – part of an address which refers to the name of some territorial zone (like an island, square) instead of a street; should not be included together with street

postCode | string – identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail

province | string – for Canada, uppercase two-letter postal abbreviations (BC, AB, ON, QC, etc.)

state | string –For the US, uppercase two-letter postal abbreviation (AK, CA, HI, NY, TX, WY, etc.)

street | string – name of the respective street in which the dwelling or business is located or where mail is received

subdistrict | string – smaller, readily identifiable part of a district

suburb | string – suburbs and localities are the names of geographic subdivisions of urban area in Australia

addressType | string – identifies the nature of the postal address (INVALID_ADDRESS_TYPE, BUSINESS, CORRESPONDENCE, DELIVERTYTO, MAILTO, POBOX, POSTAL, RESIDENTIAL, STATEMENT)

description | string – description of the account type

emailAddress | string – electronic mail address associated with the account

mobile | string – mobile phone number associated with the account

name | string – Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

partyId | string – unique and immutable identifier used to identify the customer resource; this identifier has no meaning to the account owner

partyNumber | string – number assigned by an agent to identify its customer

partyType | string – party type, in a coded form (INVALID_PARTY_TYPE, DELEGATE, JOINT, SOLE); default = INVALID_PARTY_TYPE

phone | string – collection of information that identifies a phone number, as defined by the telecom service

nextGenPsd2AccountDetails | object – provider account details required under the NextGenPSD2 standard

bban | string – 10 to 30 characters comprising the bank code (including the account number) and a checksum key

bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally

cashAccountType | string – ExternalCashAccountType1Code from ISO 20022

currency | string – ISO 4217 currency code for the account

details | string – details provided by the bank regarding characteristics of the account or characteristics of the relevant card

iban | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

linkedAccounts | string – in the case of a set of pending card transactions, the relevant cash account the card is set up on; same as resourceId of the relevant cash account

msisdn | string – mobile station International subscriber director number is basically the user's mobile phone number; used as a unique identity to enable routing of voice and SMS traffic to and from a specific subscription/device on a wireless/mobile network; composed of the country code and the national destination code; be sure to remove the + sign and any 0 before the mobile number

product | string – bank's product name for this account; will typically have a proprietary definition

usage | string – specifies the usage of the account (PRIV = private account, ORGA = professional account)

polishApiAccountDetails | object – provider account details required under the Polish API standard

accountHolderType | string – specifies the type of account holder (INVALID_ACCOUNT_HOLDER_TYPE, INDIVIDUAL, CORPORATION); default = INVALID_ACCOUNT_HOLDER_TYPE

accountNameClient | string – specifies the account owner name

auxData | object – bank-defined auxiliary data associated with the account

bank-defined | [*] – bank-dependent fields 0 .. n; each respective data type is also bank-dependent (string, number, boolean, null/empty, object, or array)

bank | object – specifies information about the bank itself

address | string – physical/mailing address of the bank

bicOrSwift | string – standard format for business identifier codes (BIC), used to identify banks and financial institutions globally

name | string – official name of the bank corresponding to its SWIFT/BIC code

currency | string – ISO 4217 currency code for the account

nameAddress | object – DBA and/or other names and addresses of the company

value | string – bank-defined

psuRelations | object – bank-provided information concerning the relationship between the PSU and an account

stake | int32 – total value, expressed as a percentage, specifying the PSU's share of the funds on the account or its liability in the case of credit products; applies to the Owner, Borrower, Guarantor relationship

typeOfProxy | string – type of PSU's power of attorney to the payment account; required when the relationship type is an account representative (INVALID_TYPE_OF_PROXY, GENERAL, SPECIAL, ADMINISTRATOR, USER); default = INVALID_TYPE_OF_PROXY

typeOfRelation | string – type of relation between PSU and the account (INVALID_TYPE_OF_RELATION, OWNER, BORROWER, GUARANTOR, PROXY_OWNER, BENEFICIARY, TRUSTEE); default = INVALID_TYPE_OF_RELATION

stetAccountDetails | object – provider account details required under the French API standard

accountId | object – bank-defined d account identifiers

currency | string – ISO 4217 currency code for the account

iban | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

other | object – bank-defined

identification | string – alias of the account

issuer | string – entity that assigned the identification; country code or any organisation name or identifier that can be recognized by both parties

schemeName | string – name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are (a) BANK (BankPartyIdentification): Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client; (b) COID (CountryIdentificationCode) : Country authority given organisation identification; e.g., corporate registration number; (c) SREN (SIREN): 9-digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France; (d) SRET (SIRET): 14-digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France; consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity; (e) NIDN (NationalIdentityNumber): assigned by an authority to identify the national identity number of a person. Other values are also permitted, for instance: - OAUT (OAUTH2): OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU - CPAN (CardPan): Card PAN

BicFi | string – ASPSP-defined association with the BIC

cashAccountType | string – specifies the type of the account

details | string – ASPSP-defined characteristics of the account or characteristics of the card

linkedAccount | string – relevant cash account the card is set up on

product | string – bank-defined product name for this account; proprietary definition

psuStatus | string – relationship between the PSU and the account; e.g., Account Holder, Co-account Holder, Attorney

usage | string – specifies the usage of the account (PRIV = private personal account, ORGA = professional account)

status | string – specifies the bank-defined status of the account (open, closed, active, inactive, etc.)

type | string– specifies the type of account (INVALID, OTHER, CHECKING, SAVINGS, LOAN, CARD); default = INVALID

accountFeatures | object – Open Banking features supported for this account

requiresExternalAuth | boolean – account requires external authorization

supportsInformation | boolean – account available for AIS operations

supportsPayment | boolean – account available for PIS operations

supportsRecievePayment | boolean – account can receive money transfers

supportsSendPayment | boolean – account can send money transfers

bankId | string – unique Token Platform identifier for this bank

id | string – unique identifier for this account

isLocked | boolean($boolean) – all services locked out for this account

lastCacheUpdateMs | string($string) – last update timestamp in milliseconds; ex. 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000

name | string – unique name of this account

nextCacheUpdateMs | string($string) – next update timestamp in milliseconds; ex. 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000

400 Bad Request | status=INVALID_ARGUMENT.withDescription(error) – client specified an invalid argument

401 Unauthorized | status=UNAUTHENTICATED.withDescription(error) – request does not have valid authentication credentials needed to perform the operation

403 Forbidden | status=PERMISSION_DENIED.withDescription(error) – caller does not have the required permission to execute the operation specified. This error message will be accompanied by the reason from the bank. Typically means the access token has expired and the TPP needs its user to re-authenticate with the bank

404 Not Found | status=NOT_FOUND.withDescription(error) – requested entity, such as a file or directory, was not found

429 Too Many Requests | status=RESOURCE_EXHAUSTED.withDescription(error) – resource, such as a per-user quota or file system, is exhausted (out of space)

500 Internal Server Error | status=INTERNAL.withDescription(error) – could refer to either an error on Token’s end or an error on the bank’s end. When the bank reports a 5xx error, Token sets token-external-error=true as a header in the HTTP response, indicating that the "internal" error originates from the bank. When one of Token's internal services fails or when the bank reports a 4xx error, this header is not populated. The absence of this response header should be interpreted as token-external-error=false.

501 Not Implemented | status=UNIMPLEMENTED.withDescription(error) – operation not implemented / supported / enabled by the bank

503 Service Unavailable | status=UNAVAILABLE.withDescription(error) – service is unavailable, likely due to a transient condition; usually corrected with a retry

504 Gateway Timeout | status=DEADLINE_EXCEEDED.withDescription(error) – deadline expired before operation could complete

accountId | string – required in path; unique bank account ID to specify the account information requested

200 Success | status=OK – operation completed successfully

balance | object – relevant information associated with the monetary balance of an individual account

accountId | string – unique identifier for the account

available | object – the account's balance available to the account holder

currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"

value | string – amount valued in currency

current | object – the account's total current balance, both available and on-hold

currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"

value | string – amount valued in currency

otherBalances | object array – other bank-defined balances associated with the account

amount | object – balance currency and value

currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"

value | string – amount valued in currency

type | string – bank-defined type of other balance

updatedAtMs | string($string) – last update timestamp in milliseconds; ex. 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000

updatedAtMs | string($string) – last update timestamp in milliseconds; ex. 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000

status | string – specifies the status of the request (INVALID_REQUEST, SUCCESSFUL_REQUEST, MORE_SIGNATURES_NEEDED ); default = INVALID_REQUEST

400 Bad Request | status=INVALID_ARGUMENT.withDescription(error) – client specified an invalid argument

401 Unauthorized | status=UNAUTHENTICATED.withDescription(error) – request does not have valid authentication credentials needed to perform the operation

403 Forbidden | status=PERMISSION_DENIED.withDescription(error) – caller does not have the required permission to execute the operation specified. This error message will be accompanied by the reason from the bank. Typically means the access token has expired and the TPP needs its user to re-authenticate with the bank

404 Not Found | status=NOT_FOUND.withDescription(error) – requested entity, such as a file or directory, was not found

429 Too Many Requests | status=RESOURCE_EXHAUSTED.withDescription(error) – resource, such as a per-user quota or file system, is exhausted (out of space)

500 Internal Server Error | status=INTERNAL.withDescription(error) – could refer to either an error on Token’s end or an error on the bank’s end. When the bank reports a 5xx error, Token sets token-external-error=true as a header in the HTTP response, indicating that the "internal" error originates from the bank. When one of Token's internal services fails or when the bank reports a 4xx error, this header is not populated. The absence of this response header should be interpreted as token-external-error=false.

501 Not Implemented | status=UNIMPLEMENTED.withDescription(error) – operation not implemented / supported / enabled by the bank

503 Service Unavailable | status=UNAVAILABLE.withDescription(error) – service is unavailable, likely due to a transient condition; usually corrected with a retry

504 Gateway Timeout | status=DEADLINE_EXCEEDED.withDescription(error) – deadline expired before operation could complete

accountId | string – required in path; unique bank account ID to specify the account information requested

body | object – required request body; contains the body details of the request

amount | object – specifies the transaction amount

currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"

value | string – amount valued in currency

200 Success | status=OK – operation completed successfully

fundsAvailable | boolean – true = funds available; false = funds not available

400 Bad Request | status=INVALID_ARGUMENT.withDescription(error) – client specified an invalid argument

401 Unauthorized | status=UNAUTHENTICATED.withDescription(error) – request does not have valid authentication credentials needed to perform the operation

403 Forbidden | status=PERMISSION_DENIED.withDescription(error) – caller does not have the required permission to execute the operation specified. This error message will be accompanied by the reason from the bank. Typically means the access token has expired and the TPP needs its user to re-authenticate with the bank

404 Not Found | status=NOT_FOUND.withDescription(error) – requested entity, such as a file or directory, was not found

429 Too Many Requests | status=RESOURCE_EXHAUSTED.withDescription(error) – resource, such as a per-user quota or file system, is exhausted (out of space)

500 Internal Server Error | status=INTERNAL.withDescription(error) – could refer to either an error on Token’s end or an error on the bank’s end. When the bank reports a 5xx error, Token sets token-external-error=true as a header in the HTTP response, indicating that the "internal" error originates from the bank. When one of Token's internal services fails or when the bank reports a 4xx error, this header is not populated. The absence of this response header should be interpreted as token-external-error=false.

501 Not Implemented | status=UNIMPLEMENTED.withDescription(error) – operation not implemented / supported / enabled by the bank

503 Service Unavailable | status=UNAVAILABLE.withDescription(error) – service is unavailable, likely due to a transient condition; usually corrected with a retry

504 Gateway Timeout | status=DEADLINE_EXCEEDED.withDescription(error) – deadline expired before operation could complete

accountId | string – required in path; unique bank account ID to specify the account information requested

page.offset | string – query parameter, optional; zero-based offset of the first item in the collection to return

page.limit | integer($int32) – mandatory query parameter specifying maximum number of records to return; must be a non-zero number

200 Success | status=OK – operation completed successfully

offset | string – offset of the first item in the collection returned

standingOrders | object array – contains the list of requested standing order records retrieved

createdAtMs | string – specifies when the standing order was created; timestamp in milliseconds; ex. 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000

creditorEndpoint | object – contains pertinent information about the payee/creditor account

account | object specifies required information about the payee account

accountFeatures | object – Open Banking features supported for this account

requiresExternalAuth | boolean – account requires external authorization

supportsInformation | boolean – account available for AIS operations

supportsPayment | boolean – account available for PIS operations

supportsRecievePayment | boolean – account can receive money transfers

supportsSendPayment | boolean – account can send money transfers

ach | object –specifies Account Clearing House account and routing information

account | string – payee's ACH-registered bank account

routing | string – payee's ACH-registered bank routing number

bank | object – specifies payee's bank information

bankId | string – unique Token bank identifier

custom | object – specifies a customized/one-off beneficiary transfer destination (creditor endpoint)

bankId | object – unique Token bank identifier

payload | string – special/custom transfer instructions

domestic | object – specifies a transfer destination/endpoint within the same country as payer

accountNumber | string – payee's bank account number

bankCode | string – domestic bank code of payee's bank

country | string – common country in which both payer and payee banks have their place of business

fasterPayments | object – specifies account information for UK banking service offering near-instant payment times

accountNumber | string – payee's UK bank account number

sortCode | string – 6-digit number identifying the payee's bank branch

guest | object – identifies transfer endpoint for a payee that is not a Token member; permission-restricted

bankId | string – unique Token bank identifier

nonce | string – time-variant arbitrary number valid for a single use only

iban | object – specifies an international bank account number for cross-border transfer

bic | string – standard format for business identifier code (also known as SWIFT code) for payee's bank

iban | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

metadata | object – additional fields returned by the bank at its option in response to your particular request. The presence and type of metadata are entirely dependent on the bank and generally comprise additional information about the account or the transaction pertinent to your specific use case. How you use this information, when included in the bank's response, is entirely up to you

bank-defined | [*] – bank-dependent fields 0 .. n; each respective data type is also bank-dependent (string, number, boolean, null/empty, object, or array)

secret | object – used for wrapping, if original account number contains a PAN

secretId | string – identifier used to mask account number if it contains a primary/principal account number

sepa | object – destination account information for Single Euro Payments Area (SEPA) transaction system

bic | string – standard format for business identifier code (also known as SWIFT code) for payee's bank

iban | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

swift | object – account information for Society of Worldwide Interbank Financial Telecommunication (SWIFT), global system EFTs

account | string – payee's account number

bic | string – standard format for business identifier code (also known as SWIFT code) for payee's bank

token | object – destination account information for a Token member

accountId | string – specifies unique Token account identifier for payee's account

memberId | string – specifies unique Token member ID for payee

tokenAuthorization | object array – contains encrypted bank authorization information

authorization | object – contains bank authorization messages for each transaction

accounts | object array – contains Token authorization messages and encryption information for each respective account

ciphertext | string – base64url encoded encrypted message

noop | object – empty object indicating no-op encryption

rsa | object – specifies RSA method information for decrypting ciphertext

algorithm | string – RSA/ECB/OAEPWithSHA-256AndMGF1Padding

keyId | string – ID of the key used for encryption

signature | string – Base64url encoded ciphertext signature

signatureKeyId | string – key-id of the signature

rsaAes | object – indicates that a session AES key is protected with RSA encryption

aesAlgorithm | string – AES/CBC/PKCS5Padding

encryptedAesKey | string – Base64url encoded RSA-encrypted AES key

rsaAlgorithm | string – RSA/ECB/OAEPWithSHA-256AndMGF1Padding

rsaKeyId | string – identifies the public key protected content from the perspective of the licence

signature | string – Base64url encoded ciphertext signature

signatureKeyId | string – key-id of the signature

bankId | string – specifies unique bank identifier for payee's bank recognized by the Token Platform

accountIdentifier | object – account numbers and other strings that identify this as a unique bank account

bangiro | object –identifier for domestic bank accounts in Sweden

bankgiroNumber | string – consists of 7 or 8 digits; clearing code is not used

bban | object – represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers.

bban | string – 10 to 30 characters comprising the bank code (including the account number) and a checksum key

gbDomestic | object – a domestic bank account in the UK

accountNumber | string – unique string of numbers identifying a deposit account

sortCode | string – number assigned to a branch of a bank, typically containing six digits in the ##-##-## format and most commonly used in the UK and Ireland

iban | object – international bank account number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders

iban | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

msisdn | object – mobile station International subscriber director number is basically the user's mobile phone number; used as a unique identity to enable routing of voice and SMS traffic to and from a specific subscription/ device on a wireless/mobile network

msisdn | string – composed of the country code and the national destination code; be sure to remove the + sign and any 0 before the mobile number

pan | object – primary account number; card identifier found on payment cards, such as credit cards and debit cards, as well as stored-value cards, gift cards and other similar card, sometimes referred to as a bank card number

pan | string – 14, 15, or 16 digit number generated as a unique identifier for a primary account

plusgiro | object – domestic transaction clearing system in Sweden

plusgiroNumber | string – bank account number (minimum 2 and maximum 8 digits); clearing code is not used

token | object – primary account number; card identifier found on payment cards, such as credit cards and debit cards, as well as stored-value cards, gift cards and other similar card, sometimes referred to as a bank card number

accountId | string – bank account identifier for a linked account used by Token's Bank Integration Account Linking Service

memberId | string – Token-generated member identifier for the user/account holder

bankId | string – unique Token Platform identifier for payer's bank

bic | string – standard format for business identifier code (also known as SWIFT code) for payer's bank

customerData | object – specifies legal identity information for the payer/customer

address | object – complete postal address of a party

city | string – name of the city as given in postal addresses of the building/area

conscriptNumber | string – special kind of house number; relates to a settlement instead of a street. Conscription numbers were introduced in the Austro-Hungarian Empire and are still in use in some parts of Europe, sometimes together with street-related house numbers, which are also called orientation numbers

country | string – nation with its own government, occupying a particular territory containing the address

district | string – defined district within the city or country containing the address

flats | string – house numbers (range or list) of flats behind a door

full | string – used for a full-text, often multi-line, address if you find the structured address fields unsuitable for denoting the address of this particular location. Examples: "Fifth house on the left after the village oak, Smalltown, Smallcountry" or "1200 West Sunset Boulevard Suite 110A". Typically, such strings cannot be parsed by software

hamlet | string – small human settlement. In different jurisdictions and geographies, a hamlet may be the size of a town, village or parish, or may be considered to be a smaller settlement or subdivision or satellite entity to a larger settlement

houseName | string – name of a house; sometimes used in countries like England instead of (or in addition to) a house number

houseNumber | string – house number (may contain letters, dashes or other characters); identifies a single building with multiple addresses

place | string – part of an address which refers to the name of some territorial zone (like an island, square) instead of a street; should not be included together with street

postCode | string – identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail

province | string – for Canada, uppercase two-letter postal abbreviations (BC, AB, ON, QC, etc.)

state | string –For the US, uppercase two-letter postal abbreviation (AK, CA, HI, NY, TX, WY, etc.)

street | string – name of the respective street in which the dwelling or business is located or where mail is received

subdistrict | string – smaller, readily identifiable part of a district

suburb | string – suburbs and localities are the names of geographic subdivisions of urban area in Australia

legal names | string array – comma-separated list of payer's registered legal identities

frequency | string – specifies ISO 20022 code for the scheduled frequency of standing order payments:  DAIL – daily; once a day; WEEK – weekly; once a week; TOWK – twice weekly/ two times a week; MNTH – monthly/once a month; TOMN – twice monthly/two times a month; QUTR – quarterly/once every 3 months; SEMI – semi-annually/two times each year; YEAR – annually/once a year

id | string – standing order ID; labelled standingOrderId in specific standing order access requests

providerStandingOrderDetails | object – specifies applicable non-standard (varied frequency and payment amount) recurring payment instructions and schedule

cma9StandingOrderDetails | object – contains the recurring payment details for standing order placed with a CMA9 bank in the UK

creditorAccount | object – specifies the payer's account with the creditor

identification | string – payer's creditor account ID/number

name | string – name of the payer listed for the creditor account

schemeName | string – creditor-defined recurring payment scheme name; e.g., "Purchase instalment plan"

finalPaymentAmount | object – specifies the currency and amount for the standing order's final payment

currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"

value | string – amount valued in currency

finalPaymentDateTime | string – due date and time for the final payment in ISO 8601 format (YYYY-MM-DDThh:mm:ssTZD or YYYYMMDDThh:mm:ssTZD)

firstPaymentAmount | object – specifies the currency and amount for the standing order's first payment

currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"

value | string – amount valued in currency

firstPaymentDateTime | string – due date and time for the first payment in ISO 8601 format (YYYY-MM-DDThh:mm:ssTZD or YYYYMMDDThh:mm:ssTZD)

frequency | string – specifies ISO 20022 code for the scheduled frequency of standing order payments occurring between the first and final payments:  DAIL – daily; once a day; WEEK – weekly; once a week; TOWK – twice weekly/ two times a week; MNTH – monthly/once a month; TOMN – twice monthly/two times a month; QUTR – quarterly/once every 3 months; SEMI – semi-annually/two times each year; YEAR – annually/once a year

nextPaymentAmount | object – specifies the currency and amount of regularly scheduled payments according to frequency

currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"

value | string – amount valued in currency

nextPaymentDateTime | string – due date and time for the next payment in ISO 8601 format (YYYY-MM-DDThh:mm:ssTZD or YYYYMMDDThh:mm:ssTZD)

numberOfPayments | integer($int32) – total number of recurring payments

reference | string – TPP/merchant reference number/code for the standing order

status | string – current status of the standing order: INVALID, ACTIVE, INACTIVE, PROCESSING, FAILED, UNKNOWN

tokenId | string – access token ID of the account information request authorized by the account holder

tokenSubmissionId | string – submission ID of the standing order information request; points to the token submission, only set for Token standing orders

status | string – status of the account information request: INVALID_REQUEST, SUCCESSFUL_REQUEST, MORE_SIGNATURES_NEEDED); default = INVALID_REQUEST

400 Bad Request | status=INVALID_ARGUMENT.withDescription(error) – client specified an invalid argument

401 Unauthorized | status=UNAUTHENTICATED.withDescription(error) – request does not have valid authentication credentials needed to perform the operation

403 Forbidden | status=PERMISSION_DENIED.withDescription(error) – caller does not have the required permission to execute the operation specified. This error message will be accompanied by the reason from the bank. Typically means the access token has expired and the TPP needs its user to re-authenticate with the bank

404 Not Found | status=NOT_FOUND.withDescription(error) – requested entity, such as a file or directory, was not found

429 Too Many Requests | status=RESOURCE_EXHAUSTED.withDescription(error) – resource, such as a per-user quota or file system, is exhausted (out of space)

500 Internal Server Error | status=INTERNAL.withDescription(error) – could refer to either an error on Token’s end or an error on the bank’s end. When the bank reports a 5xx error, Token sets token-external-error=true as a header in the HTTP response, indicating that the "internal" error originates from the bank. When one of Token's internal services fails or when the bank reports a 4xx error, this header is not populated. The absence of this response header should be interpreted as token-external-error=false.

501 Not Implemented | status=UNIMPLEMENTED.withDescription(error) – operation not implemented / supported / enabled by the bank

503 Service Unavailable | status=UNAVAILABLE.withDescription(error) – service is unavailable, likely due to a transient condition; usually corrected with a retry

504 Gateway Timeout | status=DEADLINE_EXCEEDED.withDescription(error) – deadline expired before operation could complete

accountId | string – required in path; unique bank account ID to specify the account information requested

standingOrderId | string – required in path; unique identifier for the requested standing order; labelled id and available in standingOrders(pl.) object of more general response to a request for all standing orders

200 Success | status=OK – operation completed successfully

standingOrders | object array – contains the list of standing order records retrieved

createdAtMs | string – specifies when the standing order was created; timestamp in milliseconds; ex. 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000

creditorEndpoint | object – contains pertinent information about the payee/creditor account

account | object specifies required information about the payee account

accountFeatures | object – Open Banking features supported for this account

requiresExternalAuth | boolean – account requires external authorization

supportsInformation | boolean – account available for AIS operations

supportsPayment | boolean – account available for PIS operations

supportsRecievePayment | boolean – account can receive money transfers

supportsSendPayment | boolean – account can send money transfers

ach | object –specifies Account Clearing House account and routing information

account | string – payee's ACH-registered bank account

routing | string – payee's ACH-registered bank routing number

bank | object – specifies payee's bank information

bankId | string – unique Token bank identifier

custom | object – specifies a customized/one-off beneficiary transfer destination (creditor endpoint)

bankId | object – unique Token bank identifier

payload | string – special/custom transfer instructions

domestic | object – specifies a transfer destination/endpoint within the same country as payer

accountNumber | string – payee's bank account number

bankCode | string – domestic bank code of payee's bank

country | string – common country in which both payer and payee banks have their place of business

fasterPayments | object – specifies account information for UK banking service offering near-instant payment times

accountNumber | string – payee's UK bank account number

sortCode | string – 6-digit number identifying the payee's bank branch

guest | object – identifies transfer endpoint for a payee that is not a Token member; permission-restricted

bankId | string – unique Token bank identifier

nonce | string – time-variant arbitrary number valid for a single use only

iban | object – specifies an international bank account number for cross-border transfer

bic | string – standard format for business identifier code (also known as SWIFT code) for payee's bank

iban | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

metadata | object – additional fields returned by the bank at its option in response to your particular request. The presence and type of metadata are entirely dependent on the bank and generally comprise additional information about the account or the transaction pertinent to your specific use case. How you use this information, when included in the bank's response, is entirely up to you

bank-defined | [*] – bank-dependent fields 0 .. n; each respective data type is also bank-dependent (string, number, boolean, null/empty, object, or array)

secret | object – used for wrapping, if original account number contains a PAN

secretId | string – identifier used to mask account number if it contains a primary/principal account number

sepa | object – destination account information for Single Euro Payments Area (SEPA) transaction system

bic | string – standard format for business identifier code (also known as SWIFT code) for payee's bank

iban | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

swift | object – account information for Society of Worldwide Interbank Financial Telecommunication (SWIFT), global system EFTs

account | string – payee's account number

bic | string – standard format for business identifier code (also known as SWIFT code) for payee's bank

token | object – destination account information for a Token member

accountId | string – specifies unique Token account identifier for payee's account

memberId | string – specifies unique Token member ID for payee

tokenAuthorization | object array – contains encrypted bank authorization information

authorization | object – contains bank authorization messages for each transaction

accounts | object array – contains Token authorization messages and encryption information for each respective account

ciphertext | string – base64url encoded encrypted message

noop | object – empty object indicating no-op encryption

rsa | object – specifies RSA method information for decrypting ciphertext

algorithm | string – RSA/ECB/OAEPWithSHA-256AndMGF1Padding

keyId | string – ID of the key used for encryption

signature | string – Base64url encoded ciphertext signature

signatureKeyId | string – key-id of the signature

rsaAes | object – indicates that a session AES key is protected with RSA encryption

aesAlgorithm | string – AES/CBC/PKCS5Padding

encryptedAesKey | string – Base64url encoded RSA-encrypted AES key

rsaAlgorithm | string – RSA/ECB/OAEPWithSHA-256AndMGF1Padding

rsaKeyId | string – identifies the public key protected content from the perspective of the licence

signature | string – Base64url encoded ciphertext signature

signatureKeyId | string – key-id of the signature

bankId | string – specifies unique bank identifier for payee's bank recognized by the Token Platform

accountIdentifier | object – account numbers and other strings that identify this as a unique bank account

bangiro | object –identifier for domestic bank accounts in Sweden

bankgiroNumber | string – consists of 7 or 8 digits; clearing code is not used

bban | object – represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers.

bban | string – 10 to 30 characters comprising the bank code (including the account number) and a checksum key

gbDomestic | object – a domestic bank account in the UK

accountNumber | string – unique string of numbers identifying a deposit account

sortCode | string – number assigned to a branch of a bank, typically containing six digits in the ##-##-## format and most commonly used in the UK and Ireland

iban | object – international bank account number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders

iban | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

msisdn | object – mobile station International subscriber director number is basically the user's mobile phone number; used as a unique identity to enable routing of voice and SMS traffic to and from a specific subscription/ device on a wireless/mobile network

msisdn | string – composed of the country code and the national destination code; be sure to remove the + sign and any 0 before the mobile number

pan | object – primary account number; card identifier found on payment cards, such as credit cards and debit cards, as well as stored-value cards, gift cards and other similar card, sometimes referred to as a bank card number

pan | string – 14, 15, or 16 digit number generated as a unique identifier for a primary account

plusgiro | object – domestic transaction clearing system in Sweden

plusgiroNumber | string – bank account number (minimum 2 and maximum 8 digits); clearing code is not used

token | object – primary account number; card identifier found on payment cards, such as credit cards and debit cards, as well as stored-value cards, gift cards and other similar card, sometimes referred to as a bank card number

accountId | string – bank account identifier for a linked account used by Token's Bank Integration Account Linking Service

memberId | string – Token-generated member identifier for the user/account holder

bankId | string – unique Token Platform identifier for payer's bank

bic | string – standard format for business identifier code (also known as SWIFT code) for payer's bank

customerData | object – specifies legal identity information for the payer/customer

address | object – complete postal address of a party

city | string – name of the city as given in postal addresses of the building/area

conscriptNumber | string – special kind of house number; relates to a settlement instead of a street. Conscription numbers were introduced in the Austro-Hungarian Empire and are still in use in some parts of Europe, sometimes together with street-related house numbers, which are also called orientation numbers

country | string – nation with its own government, occupying a particular territory containing the address

district | string – defined district within the city or country containing the address

flats | string – house numbers (range or list) of flats behind a door

full | string – used for a full-text, often multi-line, address if you find the structured address fields unsuitable for denoting the address of this particular location. Examples: "Fifth house on the left after the village oak, Smalltown, Smallcountry" or "1200 West Sunset Boulevard Suite 110A". Typically, such strings cannot be parsed by software

hamlet | string – small human settlement. In different jurisdictions and geographies, a hamlet may be the size of a town, village or parish, or may be considered to be a smaller settlement or subdivision or satellite entity to a larger settlement

houseName | string – name of a house; sometimes used in countries like England instead of (or in addition to) a house number

houseNumber | string – house number (may contain letters, dashes or other characters); identifies a single building with multiple addresses

place | string – part of an address which refers to the name of some territorial zone (like an island, square) instead of a street; should not be included together with street

postCode | string – identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail

province | string – for Canada, uppercase two-letter postal abbreviations (BC, AB, ON, QC, etc.)

state | string –For the US, uppercase two-letter postal abbreviation (AK, CA, HI, NY, TX, WY, etc.)

street | string – name of the respective street in which the dwelling or business is located or where mail is received

subdistrict | string – smaller, readily identifiable part of a district

suburb | string – suburbs and localities are the names of geographic subdivisions of urban area in Australia

legal names | string array – comma-separated list of payer's registered legal identities

frequency | string – specifies ISO 20022 code for the scheduled frequency of standing order payments:  DAIL – daily; once a day; WEEK – weekly; once a week; TOWK – twice weekly/ two times a week; MNTH – monthly/once a month; TOMN – twice monthly/two times a month; QUTR – quarterly/once every 3 months; SEMI – semi-annually/two times each year; YEAR – annually/once a year

id | string – standing order ID; labelled standingOrderId in specific standing order access requests

providerStandingOrderDetails | object – specifies applicable non-standard (varied frequency and payment amount) recurring payment instructions and schedule

cma9StandingOrderDetails | object – contains the recurring payment details for standing order placed with a CMA9 bank in the UK

creditorAccount | object – specifies the payer's account with the creditor

identification | string – payer's creditor account ID/number

name | string – name of the payer listed for the creditor account

schemeName | string – creditor-defined recurring payment scheme name; e.g., "Purchase instalment plan"

finalPaymentAmount | object – specifies the currency and amount for the standing order's final payment

currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"

value | string – amount valued in currency

finalPaymentDateTime | string – due date and time for the final payment in ISO 8601 format (YYYY-MM-DDThh:mm:ssTZD or YYYYMMDDThh:mm:ssTZD)

firstPaymentAmount | object – specifies the currency and amount for the standing order's first payment

currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"

value | string – amount valued in currency

firstPaymentDateTime | string – due date and time for the first payment in ISO 8601 format (YYYY-MM-DDThh:mm:ssTZD or YYYYMMDDThh:mm:ssTZD)

frequency | string – specifies ISO 20022 code for the scheduled frequency of standing order payments occurring between the first and final payments:  DAIL – daily; once a day; WEEK – weekly; once a week; TOWK – twice weekly/ two times a week; MNTH – monthly/once a month; TOMN – twice monthly/two times a month; QUTR – quarterly/once every 3 months; SEMI – semi-annually/two times each year; YEAR – annually/once a year

nextPaymentAmount | object – specifies the currency and amount of regularly scheduled payments according to frequency

currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"

value | string – amount valued in currency

nextPaymentDateTime | string – due date and time for the next payment in ISO 8601 format (YYYY-MM-DDThh:mm:ssTZD or YYYYMMDDThh:mm:ssTZD)

numberOfPayments | integer($int32) – total number of recurring payments

reference | string – TPP/merchant reference number/code for the standing order

status | string – current status of the standing order: INVALID, ACTIVE, INACTIVE, PROCESSING, FAILED, UNKNOWN

tokenId | string – access token ID of the account information request authorized by the account holder

tokenSubmissionId | string – submission ID of the standing order information request; points to the token submission, only set for Token standing orders

status | string – status of the account information request: INVALID_REQUEST, SUCCESSFUL_REQUEST, MORE_SIGNATURES_NEEDED); default = INVALID_REQUEST

400 Bad Request | status=INVALID_ARGUMENT.withDescription(error) – client specified an invalid argument

401 Unauthorized | status=UNAUTHENTICATED.withDescription(error) – request does not have valid authentication credentials needed to perform the operation

403 Forbidden | status=PERMISSION_DENIED.withDescription(error) – caller does not have the required permission to execute the operation specified. This error message will be accompanied by the reason from the bank. Typically means the access token has expired and the TPP needs its user to re-authenticate with the bank

404 Not Found | status=NOT_FOUND.withDescription(error) – requested entity, such as a file or directory, was not found

429 Too Many Requests | status=RESOURCE_EXHAUSTED.withDescription(error) – resource, such as a per-user quota or file system, is exhausted (out of space)

500 Internal Server Error | status=INTERNAL.withDescription(error) – could refer to either an error on Token’s end or an error on the bank’s end. When the bank reports a 5xx error, Token sets token-external-error=true as a header in the HTTP response, indicating that the "internal" error originates from the bank. When one of Token's internal services fails or when the bank reports a 4xx error, this header is not populated. The absence of this response header should be interpreted as token-external-error=false.

501 Not Implemented | status=UNIMPLEMENTED.withDescription(error) – operation not implemented / supported / enabled by the bank

503 Service Unavailable | status=UNAVAILABLE.withDescription(error) – service is unavailable, likely due to a transient condition; usually corrected with a retry

504 Gateway Timeout | status=DEADLINE_EXCEEDED.withDescription(error) – deadline expired before operation could complete

accountId | string – required in path; unique bank account ID to specify the account information requested

transactionId | string – required in path; unique transaction identifier to specify the transaction requested

200 Success | status=OK – operation completed successfully

offset | string – offset of the first item in the collection returned

status | string – status of the account information request: INVALID_REQUEST, SUCCESSFUL_REQUEST, MORE_SIGNATURES_NEEDED); default = INVALID_REQUEST

transactions | object – information about the requested transaction

amount | object – transaction amount valued in currency

currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"

value | string – amount valued in currency

createdAtMs | string –specifies when the transaction was created; timestamp (UTC) in milliseconds; format = yyyymmddHHMMSS.xxxxxx, where xxxxxx is the number of microseconds in the second (000000 through 999999)

creditorEndpoint | object – contains pertinent information about the payee/creditor account

account | object specifies required information about the payee account

accountFeatures | object – Open Banking features supported for this account

requiresExternalAuth | boolean – account requires external authorization

supportsInformation | boolean – account available for AIS operations

supportsPayment | boolean – account available for PIS operations

supportsRecievePayment | boolean – account can receive money transfers

supportsSendPayment | boolean – account can send money transfers

ach | object –specifies Account Clearing House account and routing information

account | string – payee's ACH-registered bank account

routing | string – payee's ACH-registered bank routing number

bank | object – specifies payee's bank information

bankId | string – unique Token bank identifier

custom | object – specifies a customized/one-off beneficiary transfer destination (creditor endpoint)

bankId | object – unique Token bank identifier

payload | string – special/custom transfer instructions

domestic | object – specifies a transfer destination/endpoint within the same country as payer

accountNumber | string – payee's bank account number

bankCode | string – domestic bank code of payee's bank

country | string – common country in which both payer and payee banks have their place of business

fasterPayments | object – specifies account information for UK banking service offering near-instant payment times

accountNumber | string – payee's UK bank account number

sortCode | string – 6-digit number identifying the payee's bank branch

guest | object – identifies transfer endpoint for a payee that is not a Token member; permission-restricted

bankId | string – unique Token bank identifier

nonce | string – time-variant arbitrary number valid for a single use only

iban | object – specifies an international bank account number for cross-border transfer

bic | string – standard format for business identifier code (also known as SWIFT code) for payee's bank

iban | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

metadata | object – additional fields returned by the bank at its option in response to your particular request. The presence and type of metadata are entirely dependent on the bank and generally comprise additional information about the account or the transaction pertinent to your specific use case. How you use this information, when included in the bank's response, is entirely up to you

bank-defined | [*] – bank-dependent fields 0 .. n; each respective data type is also bank-dependent (string, number, boolean, null/empty, object, or array)

secret | object – used for wrapping, if original account number contains a PAN

secretId | string – identifier used to mask account number if it contains a primary/principal account number

sepa | object – destination account information for Single Euro Payments Area (SEPA) transaction system

bic | string – standard format for business identifier code (also known as SWIFT code) for payee's bank

iban | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

swift | object – account information for Society of Worldwide Interbank Financial Telecommunication (SWIFT), global system EFTs

account | string – payee's account number

bic | string – standard format for business identifier code (also known as SWIFT code) for payee's bank

token | object – destination account information for a Token member

accountId | string – specifies unique Token account identifier for payee's account

memberId | string – specifies unique Token member ID for payee

tokenAuthorization | object array – contains encrypted bank authorization information

authorization | object – contains bank authorization messages for each transaction

accounts | object array – contains Token authorization messages and encryption information for each respective account

ciphertext | string – base64url encoded encrypted message

noop | object – empty object indicating no-op encryption

rsa | object – specifies RSA method information for decrypting ciphertext

algorithm | string – RSA/ECB/OAEPWithSHA-256AndMGF1Padding

keyId | string – ID of the key used for encryption

signature | string – Base64url encoded ciphertext signature

signatureKeyId | string – key-id of the signature

rsaAes | object – indicates that a session AES key is protected with RSA encryption

aesAlgorithm | string – AES/CBC/PKCS5Padding

encryptedAesKey | string – Base64url encoded RSA-encrypted AES key

rsaAlgorithm | string – RSA/ECB/OAEPWithSHA-256AndMGF1Padding

rsaKeyId | string – identifies the public key protected content from the perspective of the licence

signature | string – Base64url encoded ciphertext signature

signatureKeyId | string – key-id of the signature

bankId | string – specifies unique bank identifier for payee's bank recognized by the Token Platform

accountIdentifier | object – account numbers and other strings that identify this as a unique bank account

bangiro | object –identifier for domestic bank accounts in Sweden

bankgiroNumber | string – consists of 7 or 8 digits; clearing code is not used

bban | object – represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers.

bban | string – 10 to 30 characters comprising the bank code (including the account number) and a checksum key

gbDomestic | object – a domestic bank account in the UK

accountNumber | string – unique string of numbers identifying a deposit account

sortCode | string – number assigned to a branch of a bank, typically containing six digits in the ##-##-## format and most commonly used in the UK and Ireland

iban | object – international bank account number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders

iban | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

msisdn | object – mobile station International subscriber director number is basically the user's mobile phone number; used as a unique identity to enable routing of voice and SMS traffic to and from a specific subscription/ device on a wireless/mobile network

msisdn | string – composed of the country code and the national destination code; be sure to remove the + sign and any 0 before the mobile number

pan | object – primary account number; card identifier found on payment cards, such as credit cards and debit cards, as well as stored-value cards, gift cards and other similar card, sometimes referred to as a bank card number

pan | string – 14, 15, or 16 digit number generated as a unique identifier for a primary account

plusgiro | object – domestic transaction clearing system in Sweden

plusgiroNumber | string – bank account number (minimum 2 and maximum 8 digits); clearing code is not used

token | object – primary account number; card identifier found on payment cards, such as credit cards and debit cards, as well as stored-value cards, gift cards and other similar card, sometimes referred to as a bank card number

accountId | string – bank account identifier for a linked account used by Token's Bank Integration Account Linking Service

memberId | string – Token-generated member identifier for the user/account holder

bankId | string – unique Token Platform identifier for payer's bank

bic | string – standard format for business identifier code (also known as SWIFT code) for payer's bank

customerData | object – specifies legal identity information for the payer/customer

address | object – complete postal address of a party

city | string – name of the city as given in postal addresses of the building/area

conscriptNumber | string – special kind of house number; relates to a settlement instead of a street. Conscription numbers were introduced in the Austro-Hungarian Empire and are still in use in some parts of Europe, sometimes together with street-related house numbers, which are also called orientation numbers

country | string – nation with its own government, occupying a particular territory containing the address

district | string – defined district within the city or country containing the address

flats | string – house numbers (range or list) of flats behind a door

full | string – used for a full-text, often multi-line, address if you find the structured address fields unsuitable for denoting the address of this particular location. Examples: "Fifth house on the left after the village oak, Smalltown, Smallcountry" or "1200 West Sunset Boulevard Suite 110A". Typically, such strings cannot be parsed by software

hamlet | string – small human settlement. In different jurisdictions and geographies, a hamlet may be the size of a town, village or parish, or may be considered to be a smaller settlement or subdivision or satellite entity to a larger settlement

houseName | string – name of a house; sometimes used in countries like England instead of (or in addition to) a house number

houseNumber | string – house number (may contain letters, dashes or other characters); identifies a single building with multiple addresses

place | string – part of an address which refers to the name of some territorial zone (like an island, square) instead of a street; should not be included together with street

postCode | string – identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail

province | string – for Canada, uppercase two-letter postal abbreviations (BC, AB, ON, QC, etc.)

state | string –For the US, uppercase two-letter postal abbreviation (AK, CA, HI, NY, TX, WY, etc.)

street | string – name of the respective street in which the dwelling or business is located or where mail is received

subdistrict | string – smaller, readily identifiable part of a district

suburb | string – suburbs and localities are the names of geographic subdivisions of urban area in Australia

legal names | string array – comma-separated list of payer's registered legal identities

description | string – description of the transaction

id | string – transaction identifier; transaction ID

metadata | object – additional fields returned by the bank at its option in response to your particular request. The presence and type of metadata are entirely dependent on the bank and generally comprise additional information about the account or the transaction pertinent to your specific use case. How you use this information, when included in the bank's response, is entirely up to you

bank-defined | [*] – bank-dependent fields 0 .. n; each respective data type is also bank-dependent (string, number, boolean, null/empty, object, or array)

providerTransactionDetails | object – specific information regarding the bank required by the respective Open Banking API standard adopted (CMA9, NextGenPSD2, PolishAPI, or STET)

nextGenPsd2TransactionDetails | object – provider transaction details required under the NextGenPSD2 standard

additionalInformation | string – additional bank-provided information about the transaction

bankTransactionCode | string – Bank transaction code using the sub-elements of the structured code defined by ISO 20022; concatenates the three ISO 20022 Codes: Domain Code, Family Code, and SubFamiliy Code by hyphens, resulting in 'DomainCode'-'FamilyCode'-'SubFamilyCode'; e.g., "PMNT-RDDT-ESDD"

checkId | string – identifier of electronic check, where applicable

creditorAccount | object – destination account information of the payment; payee's bank account

bban | string – represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers.

currency | string – ISO 4217 Alpha 3 currency code

iban | string – international bank account number

maskedPan | string – masked primary account number; tokenised identification for data protection

msisdn | string – mobile phone number associated with account

pan | string – primary account number according to ISO/IEC 7812

creditorId | string – creditor/payee identifier provided by the bank

creditorName | string – name of the creditor/payee

currencyExchange | object – currency exchange rate

contractIdentification | string – identifies the forward or spot exchange contract

exchangeRate | string – rate of exchange between the sourceCurrencyand the targetCurrency

quotationDate | string – date of the FX quote in ISO 8601 YYYYMMDD or YYYY-MM-DD format

sourceCurrency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR" for the source currency

targetCurrency | sting – ISO 4217 3-letter currency code; e.g., "USD" or "EUR" for the target currency

unitCurrency | string – price of one currency expressed in terms of another currency; e.g., 1.4 to 1

debtorAccount | object – source account information for the payment; payer's bank account

bban | string – represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers.

currency | string – ISO 4217 Alpha 3 currency code

iban | string – international bank account number

maskedPan | string – masked primary account number; tokenised identification for data protection

msisdn | string – mobile phone number associated with account

pan | string – primary account number according to ISO/IEC 7812

debtorName | string – name of debtor/payer

endToEndId | string – a short reference field to share an invoice or receipt number for your records; this reference is important to the debtor (could be an internal reference ID against the transaction) but it Is NOT the reference information that will be primarily populated on the statement of the creditor (beneficiary)

entryReference | string – identification of the transaction referencing delta function on an application level; sameID used within camt.05x messages

mandateId | string – identification of mandates; e.g., a SEPA Mandate ID

proprietaryBankTransaction Code | string – used within a community or within an ASPSP; e.g., for MT94x based transaction reports

purposeCode | string – bank-provided code representing the purpose of the transaction

remittanceInformationStructured | string – structured remittance information; reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance

ultimateCreditor | string – ultimate party to which the transfer is due

valueDate | string – date in ISO 8601 YYYYMMDD or YYYY-MM-DD format when funds are posted to an account and available for immediate use

polishApiTransactionDetails | object – provider transaction details required under the Polish API standard

accountBaseCurrency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR" for the account's currency

auxData | object – bank-defined auxiliary data associated with the account

bank-defined | [*] – bank-dependent fields 0 .. n; each respective data type is also bank-dependent (string, number, boolean, null/empty, object, or array)

baseCurrency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR" for the transaction's currency

cardInfo | object – information about the card used in/for the transaction

cardHolder | string – name of the cardholder

cardNumber | string – card account number

currencyDate | string – transaction currency valuation date

holdExpirationDate | string – Date the bank hold expires in ISO 8601 YYYYMMDD or YYYY-MM-DD format

initiator | object – information about the transaction initiator

value | string – simple name and postal address (max 4 lines)

mcc | string – code for each transaction or operation performed by card

postTransactionBalance | string – account balance after transaction

recipient | object – information about the recipient

accountMassPayment | string – virtual account number of the recipient/virtual account name

accountNumber | string – recipient's account number

bank | object – information about the recipient's bank account

address | string array – up to four lines containing the simple name and postal address of the bank

bicOrSwift | string – BIC/SWIFT number

code | string – bank code for foreign transfers

countryCode | string – ISO 3166 2-alpha country code

name | string – name of the bank

nameAddress | object – information about the recipient

value | string array – up to four lines containing the simple name and postal address of the recipient

rejectionDate | string – date in ISO 8601 YYYYMMDD or YYYY-MM-DD format when the transaction was rejected

rejectionReason | string – reason the transaction was rejected

sender | object – information about the sender

accountMassPayment | string – virtual account number of the sender/virtual account name

accountNumber | string – sender's account number

bank | object – information about the sender's bank account

address | string array – up to four lines containing the simple name and postal address of the bank

bicOrSwift | string – BIC/SWIFT number

code | string – bank code for foreign transfers

countryCode | string – ISO 3166 2-alpha country code

name | string – name of the bank

nameAddress | object – information about the sender

value | string array – up to four lines containing the simple name and postal address of the sender

taxInfo | object – data for a tax transfer to the Tax Office or Customs Chamber

formCode | string – tax authority form symbol

obligationId | string – identifier of the liability from which the tax is due; e.g., decision, executive title, resolution

payerInfo | object – information about the tax payer

payerId | string – payer's tax ID

payerIdType | string – type of tax payer ID (N, P, R, 1, 2, 3)

periodId | string – tax period number

periodType | string – tax period type

year | int32 – tax year (YYYY)

tppName | string – name of the third-party provider

tppTransactionId | string – TPP's unique transaction Identifier

tradeDate | string – date of the transaction operation (YYYY-MM-DDhh:mm:ss[.mmm])

transactionRate | object array – currency conversion rate information

fromCurrency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR" for the convert-from currency

rate | number (double) – currency exchange rate

toCurrency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR" for the convert-to currency

transactionType | string – type of transaction (CREDIT, DEBIT)

usedPaymentInstrumentId | string – unique identifier of the payment instrument used to execute the transaction/payment instrument ID

zusInfo | object – data information for transfers to ZUS

contributionId | string – declaration number/contribution identifier

contributionPeriod | string – declaration period/contribution period in MMYYYY format

contributionType | string – contribution type

obligationId | string – execution title number/obligation identifier or number

payerInfo | object – information associated with payer social security; i.e., Polish Security Institution (ZUS)

additionalPayerId | string – payer's additional identification number

additionalPayerIdType | string – type of additional payer ID

nip | string – payer's tax identification number

paymentTypeId | string – payment type identifier

stetTransactionDetails | object – provider account details required under the French API standard

creditorAccount | object – information about the payee/creditor's account

iban | string – international bank account number (IBAN); consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

creditorName | string – name of creditor/payee

debtorAccount | object – information about the payer/debtor's account

iban | string – international bank account number (IBAN); consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

debtorName | string – name of the debtor/payer

entryReference | string – technical incremental identification of the transaction for reconciliation by the TPP

transactionDate | string – for card transaction: date of the commercial transaction; for credit transfer: acquiring date of the transaction; for direct debit: receiving date of the transaction

valueDate | string – value date of the transaction on the account

status | string– specifies the status of the transaction; possible values: INVALID_STATUS, INITIATED, PENDING, PROCESSING, SUCCESS, STATUS_NOT_AVAILABLE; default = INVALID_STATUS

tokenId | string – token identifier for the payment

tokenTransferId | string – transfer identifier for the payment

type | string – specifies the type of transaction (i.e., INVALID_TYPE, DEBIT, CREDIT); default = INVALID_TYPE

400 Bad Request | status=INVALID_ARGUMENT.withDescription(error) – client specified an invalid argument

401 Unauthorized | status=UNAUTHENTICATED.withDescription(error) – request does not have valid authentication credentials needed to perform the operation

403 Forbidden | status=PERMISSION_DENIED.withDescription(error) – caller does not have the required permission to execute the operation specified. This error message will be accompanied by the reason from the bank. Typically means the access token has expired and the TPP needs its user to re-authenticate with the bank

404 Not Found | status=NOT_FOUND.withDescription(error) – requested entity, such as a file or directory, was not found

429 Too Many Requests | status=RESOURCE_EXHAUSTED.withDescription(error) – resource, such as a per-user quota or file system, is exhausted (out of space)

500 Internal Server Error | status=INTERNAL.withDescription(error) – could refer to either an error on Token’s end or an error on the bank’s end. When the bank reports a 5xx error, Token sets token-external-error=true as a header in the HTTP response, indicating that the "internal" error originates from the bank. When one of Token's internal services fails or when the bank reports a 4xx error, this header is not populated. The absence of this response header should be interpreted as token-external-error=false.

501 Not Implemented | status=UNIMPLEMENTED.withDescription(error) – operation not implemented / supported / enabled by the bank

503 Service Unavailable | status=UNAVAILABLE.withDescription(error) – service is unavailable, likely due to a transient condition; usually corrected with a retry

504 Gateway Timeout | status=DEADLINE_EXCEEDED.withDescription(error) – deadline expired before operation could complete

accountId | string – required in path; unique bank account ID to specify the account information requested

page.offset | string – query parameter, optional; zero-based offset of the first item in the collection to return

page.limit | integer($int32) – mandatory query parameter specifying maximum number of records to return; must be a non-zero number.

startDate | string – query parameter, optional; earliest transaction date requested in ISO 8601 YYYYMMDD or YYYY-MM-DD format

endDate | string – query parameter, optional; latest transaction date requested in ISO 8601 YYYYMMDD or YYYY-MM-DD format

transactionHistoryDays | integer($int32) – query parameter, optional; sets the number of days previous to the current date for which to pull transaction details

200 Success | status=OK – operation completed successfully

offset | string – offset of the first item in the collection returned

status | string – status of the account information request: INVALID_REQUEST, SUCCESSFUL_REQUEST, MORE_SIGNATURES_NEEDED); default = INVALID_REQUEST

transactions | object array – information for each respective transaction record requested

amount | object – transaction amount valued in currency

currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"

value | string – amount valued in currency

createdAtMs | string – specifies when the transaction was created; timestamp (UTC) in milliseconds; format = yyyymmddHHMMSS.xxxxxx, where xxxxxx is the number of microseconds in the second (000000 through 999999)

creditorEndpoint | object – contains pertinent information about the payee/creditor account

account | object specifies required information about the payee account

accountFeatures | object – Open Banking features supported for this account

requiresExternalAuth | boolean – account requires external authorization

supportsInformation | boolean – account available for AIS operations

supportsPayment | boolean – account available for PIS operations

supportsRecievePayment | boolean – account can receive money transfers

supportsSendPayment | boolean – account can send money transfers

ach | object –specifies Account Clearing House account and routing information

account | string – payee's ACH-registered bank account

routing | string – payee's ACH-registered bank routing number

bank | object – specifies payee's bank information

bankId | string – unique Token bank identifier

custom | object – specifies a customized/one-off beneficiary transfer destination (creditor endpoint)

bankId | object – unique Token bank identifier

payload | string – special/custom transfer instructions

domestic | object – specifies a transfer destination/endpoint within the same country as payer

accountNumber | string – payee's bank account number

bankCode | string – domestic bank code of payee's bank

country | string – common country in which both payer and payee banks have their place of business

fasterPayments | object – specifies account information for UK banking service offering near-instant payment times

accountNumber | string – payee's UK bank account number

sortCode | string – 6-digit number identifying the payee's bank branch

guest | object – identifies transfer endpoint for a payee that is not a Token member; permission-restricted

bankId | string – unique Token bank identifier

nonce | string – time-variant arbitrary number valid for a single use only

iban | object – specifies an international bank account number for cross-border transfer

bic | string – standard format for business identifier code (also known as SWIFT code) for payee's bank

iban | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

metadata | object – additional fields returned by the bank at its option in response to your particular request. The presence and type of metadata are entirely dependent on the bank and generally comprise additional information about the account or the transaction pertinent to your specific use case. How you use this information, when included in the bank's response, is entirely up to you

bank-defined | [*] – bank-dependent fields 0 .. n; each respective data type is also bank-dependent (string, number, boolean, null/empty, object, or array)

secret | object – used for wrapping, if original account number contains a PAN

secretId | string – identifier used to mask account number if it contains a primary/principal account number

sepa | object – destination account information for Single Euro Payments Area (SEPA) transaction system

bic | string – standard format for business identifier code (also known as SWIFT code) for payee's bank

iban | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

swift | object – account information for Society of Worldwide Interbank Financial Telecommunication (SWIFT), global system EFTs

account | string – payee's account number

bic | string – standard format for business identifier code (also known as SWIFT code) for payee's bank

token | object – destination account information for a Token member

accountId | string – specifies unique Token account identifier for payee's account

memberId | string – specifies unique Token member ID for payee

tokenAuthorization | object array – contains encrypted bank authorization information

authorization | object – contains bank authorization messages for each transaction

accounts | object array – contains Token authorization messages and encryption information for each respective account

ciphertext | string – base64url encoded encrypted message

noop | object – empty object indicating no-op encryption

rsa | object – specifies RSA method information for decrypting ciphertext

algorithm | string – RSA/ECB/OAEPWithSHA-256AndMGF1Padding

keyId | string – ID of the key used for encryption

signature | string – Base64url encoded ciphertext signature

signatureKeyId | string – key-id of the signature

rsaAes | object – indicates that a session AES key is protected with RSA encryption

aesAlgorithm | string – AES/CBC/PKCS5Padding

encryptedAesKey | string – Base64url encoded RSA-encrypted AES key

rsaAlgorithm | string – RSA/ECB/OAEPWithSHA-256AndMGF1Padding

rsaKeyId | string – identifies the public key protected content from the perspective of the licence

signature | string – Base64url encoded ciphertext signature

signatureKeyId | string – key-id of the signature

bankId | string – specifies unique bank identifier for payee's bank recognized by the Token Platform

accountIdentifier | object – account numbers and other strings that identify this as a unique bank account

bangiro | object –identifier for domestic bank accounts in Sweden

bankgiroNumber | string – consists of 7 or 8 digits; clearing code is not used

bban | object – represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers.

bban | string – 10 to 30 characters comprising the bank code (including the account number) and a checksum key

gbDomestic | object – a domestic bank account in the UK

accountNumber | string – unique string of numbers identifying a deposit account

sortCode | string – number assigned to a branch of a bank, typically containing six digits in the ##-##-## format and most commonly used in the UK and Ireland

iban | object – international bank account number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders

iban | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

msisdn | object – mobile station International subscriber director number is basically the user's mobile phone number; used as a unique identity to enable routing of voice and SMS traffic to and from a specific subscription/ device on a wireless/mobile network

msisdn | string – composed of the country code and the national destination code; be sure to remove the + sign and any 0 before the mobile number

pan | object – primary account number; card identifier found on payment cards, such as credit cards and debit cards, as well as stored-value cards, gift cards and other similar card, sometimes referred to as a bank card number

pan | string – 14, 15, or 16 digit number generated as a unique identifier for a primary account

plusgiro | object – domestic transaction clearing system in Sweden

plusgiroNumber | string – bank account number (minimum 2 and maximum 8 digits); clearing code is not used

token | object – primary account number; card identifier found on payment cards, such as credit cards and debit cards, as well as stored-value cards, gift cards and other similar card, sometimes referred to as a bank card number

accountId | string – bank account identifier for a linked account used by Token's Bank Integration Account Linking Service

memberId | string – Token-generated member identifier for the user/account holder

bankId | string – unique Token Platform identifier for payer's bank

bic | string – standard format for business identifier code (also known as SWIFT code) for payer's bank

customerData | object – specifies legal identity information for the payer/customer

address | object – complete postal address of a party

city | string – name of the city as given in postal addresses of the building/area

conscriptNumber | string – special kind of house number; relates to a settlement instead of a street. Conscription numbers were introduced in the Austro-Hungarian Empire and are still in use in some parts of Europe, sometimes together with street-related house numbers, which are also called orientation numbers

country | string – nation with its own government, occupying a particular territory containing the address

district | string – defined district within the city or country containing the address

flats | string – house numbers (range or list) of flats behind a door

full | string – used for a full-text, often multi-line, address if you find the structured address fields unsuitable for denoting the address of this particular location. Examples: "Fifth house on the left after the village oak, Smalltown, Smallcountry" or "1200 West Sunset Boulevard Suite 110A". Typically, such strings cannot be parsed by software

hamlet | string – small human settlement. In different jurisdictions and geographies, a hamlet may be the size of a town, village or parish, or may be considered to be a smaller settlement or subdivision or satellite entity to a larger settlement

houseName | string – name of a house; sometimes used in countries like England instead of (or in addition to) a house number

houseNumber | string – house number (may contain letters, dashes or other characters); identifies a single building with multiple addresses

place | string – part of an address which refers to the name of some territorial zone (like an island, square) instead of a street; should not be included together with street

postCode | string – identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail

province | string – for Canada, uppercase two-letter postal abbreviations (BC, AB, ON, QC, etc.)

state | string –For the US, uppercase two-letter postal abbreviation (AK, CA, HI, NY, TX, WY, etc.)

street | string – name of the respective street in which the dwelling or business is located or where mail is received

subdistrict | string – smaller, readily identifiable part of a district

suburb | string – suburbs and localities are the names of geographic subdivisions of urban area in Australia

legal names | string array – comma-separated list of payer's registered legal identities

description | string – description of the transaction

id | string – transaction identifier; transaction ID

metadata | object – additional fields returned by the bank at its option in response to your particular request. The presence and type of metadata are entirely dependent on the bank and generally comprise additional information about the account or the transaction pertinent to your specific use case. How you use this information, when included in the bank's response, is entirely up to you

bank-defined | [*] – bank-dependent fields 0 .. n; each respective data type is also bank-dependent (string, number, boolean, null/empty, object, or array)

providerTransactionDetails | object – specific information regarding the bank required by the respective Open Banking API standard adopted (CMA9, NextGenPSD2, PolishAPI, or STET)

nextGenPsd2TransactionDetails | object – provider transaction details required under the NextGenPSD2 standard

additionalInformation | string – additional bank-provided information about the transaction

bankTransactionCode | string – Bank transaction code using the sub-elements of the structured code defined by ISO 20022; concatenates the three ISO 20022 Codes: Domain Code, Family Code, and SubFamiliy Code by hyphens, resulting in 'DomainCode'-'FamilyCode'-'SubFamilyCode'; e.g., "PMNT-RDDT-ESDD"

checkId | string – identifier of electronic check, where applicable

creditorAccount | object – destination account information of the payment; payee's bank account

bban | string – represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers.

currency | string – ISO 4217 Alpha 3 currency code

iban | string – international bank account number

maskedPan | string – masked primary account number; tokenised identification for data protection

msisdn | string – mobile phone number associated with account

pan | string – primary account number according to ISO/IEC 7812

creditorId | string – creditor/payee identifier provided by the bank

creditorName | string – name of the creditor/payee

currencyExchange | object – currency exchange rate

contractIdentification | string – identifies the forward or spot exchange contract

exchangeRate | string – rate of exchange between the sourceCurrencyand the targetCurrency

quotationDate | string – date of the FX quote in ISO 8601 YYYYMMDD or YYYY-MM-DD format

sourceCurrency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR" for the source currency

targetCurrency | sting – ISO 4217 3-letter currency code; e.g., "USD" or "EUR" for the target currency

unitCurrency | string – price of one currency expressed in terms of another currency; e.g., 1.4 to 1

debtorAccount | object – source account information for the payment; payer's bank account

bban | string – represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers.

currency | string – ISO 4217 Alpha 3 currency code

iban | string – international bank account number

maskedPan | string – masked primary account number; tokenised identification for data protection

msisdn | string – mobile phone number associated with account

pan | string – primary account number according to ISO/IEC 7812

debtorName | string – name of debtor/payer

endToEndId | string – a short reference field to share an invoice or receipt number for your records; this reference is important to the debtor (could be an internal reference ID against the transaction) but it Is NOT the reference information that will be primarily populated on the statement of the creditor (beneficiary)

entryReference | string – identification of the transaction referencing delta function on an application level; sameID used within camt.05x messages

mandateId | string – identification of mandates; e.g., a SEPA Mandate ID

proprietaryBankTransaction Code | string – used within a community or within an ASPSP; e.g., for MT94x based transaction reports

purposeCode | string – bank-provided code representing the purpose of the transaction

remittanceInformationStructured | string – structured remittance information; reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance

ultimateCreditor | string – ultimate party to which the transfer is due

valueDate | string – date in ISO 8601 YYYYMMDD or YYYY-MM-DD format when funds are posted to an account and available for immediate use

polishApiTransactionDetails | object – provider transaction details required under the Polish API standard

accountBaseCurrency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR" for the account's currency

auxData | object – bank-defined auxiliary data associated with the account

bank-defined | [*] – bank-dependent fields 0 .. n; each respective data type is also bank-dependent (string, number, boolean, null/empty, object, or array)

baseCurrency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR" for the transaction's currency

cardInfo | object – information about the card used in/for the transaction

cardHolder | string – name of the cardholder

cardNumber | string – card account number

currencyDate | string – transaction currency valuation date

holdExpirationDate | string – Date the bank hold expires in ISO 8601 YYYYMMDD or YYYY-MM-DD format

initiator | object – information about the transaction initiator

value | string – simple name and postal address (max 4 lines)

mcc | string – code for each transaction or operation performed by card

postTransactionBalance | string – account balance after transaction

recipient | object – information about the recipient

accountMassPayment | string – virtual account number of the recipient/virtual account name

accountNumber | string – recipient's account number

bank | object – information about the recipient's bank account

address | string array – up to four lines containing the simple name and postal address of the bank

bicOrSwift | string – BIC/SWIFT number

code | string – bank code for foreign transfers

countryCode | string – ISO 3166 2-alpha country code

name | string – name of the bank

nameAddress | object – information about the recipient

value | string array – up to four lines containing the simple name and postal address of the recipient

rejectionDate | string – date in ISO 8601 YYYYMMDD or YYYY-MM-DD format when the transaction was rejected

rejectionReason | string – reason the transaction was rejected

sender | object – information about the sender

accountMassPayment | string – virtual account number of the sender/virtual account name

accountNumber | string – sender's account number

bank | object – information about the sender's bank account

address | string array – up to four lines containing the simple name and postal address of the bank

bicOrSwift | string – BIC/SWIFT number

code | string – bank code for foreign transfers

countryCode | string – ISO 3166 2-alpha country code

name | string – name of the bank

nameAddress | object – information about the sender

value | string array – up to four lines containing the simple name and postal address of the sender

taxInfo | object – data for a tax transfer to the Tax Office or Customs Chamber

formCode | string – tax authority form symbol

obligationId | string – identifier of the liability from which the tax is due; e.g., decision, executive title, resolution

payerInfo | object – information about the tax payer

payerId | string – payer's tax ID

payerIdType | string – type of tax payer ID (N, P, R, 1, 2, 3)

periodId | string – tax period number

periodType | string – tax period type

year | int32 – tax year (YYYY)

tppName | string – name of the third-party provider

tppTransactionId | string – TPP's unique transaction Identifier

tradeDate | string – date of the transaction operation (YYYY-MM-DDhh:mm:ss[.mmm])

transactionRate | object array – currency conversion rate information

fromCurrency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR" for the convert-from currency

rate | number (double) – currency exchange rate

toCurrency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR" for the convert-to currency

transactionType | string – type of transaction (CREDIT, DEBIT)

usedPaymentInstrumentId | string – unique identifier of the payment instrument used to execute the transaction/payment instrument ID

zusInfo | object – data information for transfers to ZUS

contributionId | string – declaration number/contribution identifier

contributionPeriod | string – declaration period/contribution period in MMYYYY format

contributionType | string – contribution type

obligationId | string – execution title number/obligation identifier or number

payerInfo | object – information associated with payer social security; i.e., Polish Security Institution (ZUS)

additionalPayerId | string – payer's additional identification number

additionalPayerIdType | string – type of additional payer ID

nip | string – payer's tax identification number

paymentTypeId | string – payment type identifier

stetTransactionDetails | object – provider account details required under the French API standard

creditorAccount | object – information about the payee/creditor's account

iban | string – international bank account number (IBAN); consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

creditorName | string – name of creditor/payee

debtorAccount | object – information about the payer/debtor's account

iban | string – international bank account number (IBAN); consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

debtorName | string – name of the debtor/payer

entryReference | string – technical incremental identification of the transaction for reconciliation by the TPP

transactionDate | string – for card transaction: date of the commercial transaction; for credit transfer: acquiring date of the transaction; for direct debit: receiving date of the transaction

valueDate | string – value date of the transaction on the account

status | string– specifies the status of the transaction; possible values: INVALID_STATUS, INITIATED, PENDING, PROCESSING, SUCCESS, STATUS_NOT_AVAILABLE; default = INVALID_STATUS

tokenId | string – token identifier for the payment

tokenTransferId | string – transfer identifier for the payment

type | string – specifies the type of transaction (i.e., INVALID_TYPE, DEBIT, CREDIT); default = INVALID_TYPE

400 Bad Request | status=INVALID_ARGUMENT.withDescription(error) – client specified an invalid argument

401 Unauthorized | status=UNAUTHENTICATED.withDescription(error) – request does not have valid authentication credentials needed to perform the operation

403 Forbidden | status=PERMISSION_DENIED.withDescription(error) – caller does not have the required permission to execute the operation specified. This error message will be accompanied by the reason from the bank. Typically means the access token has expired and the TPP needs its user to re-authenticate with the bank

404 Not Found | status=NOT_FOUND.withDescription(error) – requested entity, such as a file or directory, was not found

429 Too Many Requests | status=RESOURCE_EXHAUSTED.withDescription(error) – resource, such as a per-user quota or file system, is exhausted (out of space)

500 Internal Server Error | status=INTERNAL.withDescription(error) – could refer to either an error on Token’s end or an error on the bank’s end. When the bank reports a 5xx error, Token sets token-external-error=true as a header in the HTTP response, indicating that the "internal" error originates from the bank. When one of Token's internal services fails or when the bank reports a 4xx error, this header is not populated. The absence of this response header should be interpreted as token-external-error=false.

501 Not Implemented | status=UNIMPLEMENTED.withDescription(error) – operation not implemented / supported / enabled by the bank

503 Service Unavailable | status=UNAVAILABLE.withDescription(error) – service is unavailable, likely due to a transient condition; usually corrected with a retry

504 Gateway Timeout | status=DEADLINE_EXCEEDED.withDescription(error) – deadline expired before operation could complete