Requests
These endpoints allow you to submit new Token requests, retrieve information about existing token requests, and create a customization for a white-label Web App. Click an item below to expand/collapse its content.
POST /customization Creates request to customize the Token Web App
Request Parameters
body | object – required request body; specifies the customization parameters to add your brand to Token's white label Web App
appName | string – specifies the name for your app
colors | object – when allowed, maps the default color scheme for UI elements — primary text, secondary text, and borders — to your custom color scheme
additionalProp1 | string – color 1 (ex. #FF1A262C)
additionalProp1 | string – color 2 (ex. #FF05A5F0)
additionalProp3 | string – color 3 (ex. #FFE9EAF0)
consentText | string – custom UI text that prompts user to grant consent
logo | object – contains logo blob payload
accessMode | string – specifies whether access is public; available values: DEFAULT or PUBLIC; default = DEFAULT
data | string($byte) – byte array converted to a string; represents dimensions of the logo
name | string – name of the file containing the logo
ownerId | string – memberId of logo owner
type | string – MIME type in accordance with IETF RFC 6368
name | string – name of the customization
Responses
200 Success | status=OK – operation completed successfully
customizationId | string – deprecated; Token-generated identifier for the customization to be used in subsequent , , and requests
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
POST /token-requests Creates a token request, persisting information required to complete a subsequent AIS, PIS or CBPII request
Request Parameters
body | object – required request body; specifies the information needed to request a transfer or access token
requestOptions | object – specifies optional request parameters
bankId | string – unique Token Platform identifier for the bank to which the request is being submitted
psuId | string – unique identifier for the bank customer(account holder) providing consent to initiate the request; recommended to identify group payments initiated by the same PSU
from | object – contains information identifying the requesting Token member
alias | object – alternate/additional TPP identification information
realmId | string – verified memberId of existing Token member
type | string – the type of alias; available values: INVALID, UNKNOWN, EMAIL, PHONE, DOMAIN, USERNAME, BANK, CUSTOM, or EIDAS; default = INVALID
value | string – the alias string representing the type; e.g., "elvis.lives@whatif.com" or "e-sales.token.io"
id | string – Token-assigned memberId of the TPP
receiptRequested | boolean($boolean) – requests email confirmation of the token request
sourceIban | string – specified if the user provided the IBAN rather than the TPP
requestPayload | object – contains the details for obtaining the requested token
accessBody | object – contains the request payload for a token representing account information access permissions
accountResourceList | object – body case seeking access to one or more resources for a single account
resources | object array – specifies the account and resource for which access is being requested
accountIdentifier | object – account number and associated information that identify a unique bank account
bankgiro | 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
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 Austrio-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
legalnames | string array – comma-separated list of payer's registered legal identities
type | string – specifies the type of account resource requested; available values: ACCOUNT_INVALID, ACCOUNT_INFO, ACCOUNT_BALANCE, ACCOUNT_TRANSACTIONS, ACCOUNT_TRANSFER_DESTINATIONS, ACCOUNT_FUNDS_CONFIRMATION, ACCOUNT_STANDING_ORDERS; default = ACCOUNT_INVALID
resourceTypeList | object – contains the account resources being requested for access related to multiple accounts
resources | string array – specifies the account resources included in the request; available values: INVALID, ACCOUNTS, BALANCES, TRANSACTIONS, TRANSFER_DESTINATIONS, FUNDS_CONFIRMATIONS, STANDING_ORDERS; default = INVALID
actingAs | object – specifies another party for whom the token is being requested "on behalf of" — a Sub-TPP or merchant
displayName | string – name of recipient shown to user; required when specifying actingAs, optional otherwise
logoUrl | string – URL pointing to recipient's logo
refId | string – TPP's discretionary reference identification of the recipient, opaque to Token; can be used by a "gateway" business member to (uniquely) define a merchant that is acting through it.The uniqueness of refId should be handled by the gateway member; typically a reseller requiring separate reports for each participating merchant it is representing
secondaryName | string – domain or email address of recipient shown to user along with displayName
bulkTransferBody | object – specifies the source account and transfer destinations for a bulk transfer request
source | object – debtor/payer's bank account
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 Austrio-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
legalNames | string array – comma-separated list of payer's registered legal identities
totalAmount | string – specifies the total amount of funds being distributed
transfers | object array – contains information for each transfer requested from the source
amount | string – transaction amount valued in currency
currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"
description | string – description of the transaction
destination | object – the beneficiary account specifying the transfer destination; i.e., TPP/merchant/creditor bank account. See Restricting Beneficiary Accounts for guidance on adding, modifying, and deleting accounts.
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
bacs | object – (Banker's Automated Clearing Services) electronic payment made directly from one UK bank account to another, taking up to three working days to arrive. There are two main types: Direct Credit, which is a bank transfer; and Direct Debit, where one party automatically takes payment from another party’s account with their authorization
accountNumber | string – payee's BACS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
bangiro | object – identifier for domestic bank accounts in Sweden
bankgiroNumber | string – alias for the payee's bank account; consists of 7 or 8 digits; clearing code is not used
blueCash | object – American Express FX clearing and settlement system
accountNumber | string – payee's AMEX card nmber
chaps | object – Clearing House Automated Payments System; UK same-day system used to settle high-value wholesale payments as well as time-critical, lower-value payments like buying or paying a deposit on a property
accountNumber | string – payee's CHAPS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
custom | object – custom transfer destination
bankId | string – unique Token Platform identifier for the bank
payload | string – transfer payload
customerData | object – contains the address and name of the payer
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 Austrio-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
legalNames | string array – comma-separated list of payer's registered legal identities
elixir | object – interbank payment system in Poland
accountNumber | string – payee's Elixir-registered bank account number
euDomesticNonEuro | object – payment system within a country using that country's non-euro domestic currency
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
expressElixir | object – instant payment clearing system in Poland
accountNumber | string – payee's Elixir-registered bank account number
fasterPayments | object – interbank payment system in the UK
accountNumber | string – payee's FPS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
hsvp | object – real-time gross settlement system (RTGS) for large and time-sensitive transactions, as well as multilateral netting for small value payments. HSVP is owned and operated by the Croatian central bank (Hrvatska narodna banka, or HNB)
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
plusgiro | object – domestic transaction clearing system in Sweden; credit transfer function, which is part of Nordea, and used for mediating payments
between accounts held by companies and individuals
plusgiroNumber | string – bank account number (minimum 2 and maximum 8 digits); clearing code is not used
sepa | object – Single Euro Payments Area; for bank transfers denominated in euro; consists of the 27 member states of the European Union, the four member states of the European Free Trade Association (Iceland, Liechtenstein, Norway and Switzerland), and the United Kingdom
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
sepaInstant | object – SEPA Instant Credit Transfer; instant payment processing system with funds made available immediately for the recipient
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
sorbnet | object – real-time gross settlement system provided by the National Bank of Poland (NBP)
accountNumber | string – payee's Polish bank account number
swift | object – Society for Worldwide Interbank Financial Telecommunication; messaging network used by banks and other financial institutions to quickly, accurately, and securely send and receive information, such as money transfer instructions
account | string – payee's bank account number
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
target2 | object – real-time gross settlement (RTGS) system owned and operated by the Eurosystem
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
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
type | string –specifies the type of transfer destination; available values: UNKNOWN, BUSINESS, or PERSONAL; default = UNKNOWN
callBackState | string – sets the callback state of the request; used for the signature in a GET /token-requests/{tokenRequestId}/token-request-result call, in which the signing payload for the signature is a combination of the state and tokenId to verify whether or not the tokenId is related to the state sent by the TPP
countries | string array – specifies the destination country or countries in ISO 3166 alpha-2 format (ex. DE, IT, GB, etc.); used to limit the number of countries displayed in the Token Web App for user selection
credentials | object – omit unless required by bank; specifies bank-dependent user credentials; see credentialFields in GET /banks response. See also Decoupled Flow for Credentials and authorization Models for additional guidance
credential1 | string – bank-defined user credential 1
credential2 | string – bank-defined user credential 2
credential3 | string – bank-defined user credential 3
customizationId | string – deprecated; specifies the TPP's custom Web App UI configuration returned in the response to the respective POST /customization request; required if not pre-configured using the dashboard (see )
description | string – Description of the payment with the following qualifiers: (i) must not contain special characters; (ii) length must be no greater than 255 characters; (iii) description in a subsequent call must match description in originating request; (iv) description omitted in originating request must also be omitted in subsequent calls; (v) description omitted in subsequent call will be replaced with refId. This field maps to description in the bank's consentRequest presented to the user. Warning: If description in a subsequent token request for lookups/changes/updates (retrieve, redeem, or cancel) doesn't match the description in the originating token request, an exception will be thrown.
redirectUrl | string – specifies the bank's callback URL with which your server initiates token redemption
refId | string – TPP-generated reference identifier for the token; not to be confused with requestId. RefId is typically used by the TPP to reconcile transactions against payments received. RefId maps to tppRefId in the bank's consentRequest. It is needed to match/verify the originating token request with the bank's consent request. Warning: If the description in subsequent token lookups/changes/updates (retrieve, redeem, or cancel) doesn't match the description in the originating token request, an exception will be thrown.
standingOrderBody | object – contains the request payload for a token representing a standing order/recurring payment
amount | string – specifies the value (in currency) of payments scheduled according to frequency
currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"
endDate | string – date when regularly scheduled payments end; uses YYYY-MM-DD or YYYYMMDD format
frequency | string – specifies ISO 20022 code for the scheduled frequency of standing order payments occurring between the startDate and endDate: 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
instructions | object – contains the transfer instructions each payment
metadata | object – information governing or otherwise related to the transfer instructions
chargeBearer | string – bearer of the charges, if any, for international transfers; available values: INVALID_CHARGE_BEARER, CRED (all charges are borne by the creditor), DEBT (all charges are borne by the debtor), SHAR (the parties share the charges), or SLEV (each party bears its own charges; recommended on SEPA payments); default = INVALID_CHARGE_BEARER
purposeCode | string – ISO 20022 external purpose code
ultimateCreditor | string – ultimate party to which an amount of money is due
ultimateDebtor | string – ultimate party that owes that owes money to the [ultimate] creditor
providerStandingOrderMetadata | object – standing order metadata required under the Open Banking API standard adopted by the bank
cma9StandingOrderMetadata | object – standing order metadata required under the CMA9 API standard
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
numberOfPayments | int32 – total number of recurring payments
recurringPaymentAmount | object – specifies currency and amount of each recurring payment
currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"
value | string – amount valued in currency
recurringPaymentDateTime | string – due date and time for each recurring payment in ISO 8601 format (YYYY-MM-DDThh:mm:ssTZD or YYYYMMDDThh:mm:ssTZD)
risk | object – used to specify additional details for risk scoring of paymentsdeliveryAddress | object – specifies the recipient's delivery address detailsaddressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
deliveryAddress | object – specifies the recipient's delivery address details
addressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
nextGenPsd2StandingOrderMetadata | object – standing order metadata required under the NextGenPSD2 API standard
creditorAgentName | string – name of financial institution servicing an account for the creditor
endToEndIdentification | string – unique identification assigned by the initiating party to unambiguously identify the transaction; this identification is passed on, unchanged, throughout the entire end-to-end chain
polishApiStandingOrderMetadata | object – standing order metadata required under the Polish API standard
deliveryMode | string – urgency classification for delivery; available values: INVALID_DELIVERY_MODE, STANDARD_D2, STANDARD_D1, URGENT_D1, EXPRESS_D0; default = INVALID_DELIVERY_MODE
hold | boolean – indicates whether payment should be held until confirmation of delivery
stetStandingOrderMetadata | object – standing order metadata required under the STET API standard
beneficiary | object – the creditor or payee receiving the transfer
creditor | object – ISO 20022 information about the party; can be either a person or an organisation
name | string – name by which the party is known and which is usually used to identify that party
organisationId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
postalAddress | object – contains the mailing address of the creditor
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
privateId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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 clien; (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
creditorAccount | object – unique and unambiguous identification for the account recognised by both the account owner and the account servicer
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 – unique identification of an account, a person, or an organisation assigned by an issuer
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 clien; (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
creditorAgent | object – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
bicFi | string – code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)"
clearingSystemMemberId | object – identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank
clearingSystemId | string – specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed
memberId | string – identification of a member of a clearing system
name | string – name by which the party is known and which is usually used to identify that party
postalAddress | object – contains the mailing address of the creditor agent
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
id | string – identifier of the beneficiary
endToEndId | string – unique identification assigned by the initiating party to unambiguously identify the transaction, which is passed on, unchanged, throughout the entire end-to-end chain
providerTransferMetadata | object – transfer metadata required under the Open Banking API standard adopted by the bank
cma9TransferMetadata | object – transfer metadata required under the CMA9 API standard
endToEndIdentification | 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)
instructionIdentification | string – TPP-generated, unique transaction Id passed to the bank (mandatory) but does not have to go any further in the payment flow. Expectation is that this is unique indefinitely across all time periods by including a date or date time element to the field, or by inserting a unique Id
remittanceInformation | object – reference information that the creditor (or beneficiary) uses to reconcile (e.g., Invoice 123)
risk | object – used to specify additional details for risk scoring of paymentsdeliveryAddress | object – specifies the recipient's delivery address detailsaddressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
deliveryAddress | object – specifies the recipient's delivery address details
addressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
nextGenPsd2TransferMetadata | object – transfer metadata required under the NextGenPSD2 API standard
creditorAgent | string – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
creditorAgentName | string – name of financial institution servicing an account for the creditor
endToEndIdentification | string – unique identification assigned by the initiating party to unambiguously identify the transaction; this identification is passed on, unchanged, throughout the entire end-to-end chain
remittanceInformation | string – information supplied to enable matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts receivable system
polishApiTransferMetadata | object – transfer metadata required under the Polish API standard
deliveryMode | string – urgency classification for delivery; available values: INVALID_DELIVERY_MODE, STANDARD_D2, STANDARD_D1, URGENT_D1, EXPRESS_D0; default = INVALID_DELIVERY_MODE
hold | boolean – indicates whether payment should be held until confirmation of delivery
stetTransferMetadata | object – transfer metadata required under the STET API standard
beneficiary | object – the creditor or payee receiving the transfer
creditor | object – ISO 20022 information about the party; can be either a person or an organisation
name | string – name by which the party is known and which is usually used to identify that party
organisationId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
postalAddress | object – contains the mailing address of the creditor
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
privateId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAccount | object – unique and unambiguous identification for the account recognised by both the account owner and the account servicer
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 – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAgent | object – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
bicFi | string – code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)"
clearingSystemMemberId | object – identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank
clearingSystemId | string – specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed
memberId | string – identification of a member of a clearing system
name | string – name by which the party is known and which is usually used to identify that party
postalAddress | object – contains the mailing address of the creditor agent
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
debtorAgent | object – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
bicFi | string – code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)"
clearingSystemMemberId | object – identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank
clearingSystemId | string – specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed
memberId | string – identification of a member of a clearing system
name | string – name by which the party is known and which is usually used to identify that party
postalAddress | object – contains the mailing address of the creditor agent
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
endToEndId | string – unique identification assigned by the initiating party to unambiguously identify the transaction, which is passed on, unchanged, throughout the entire end-to-end chain
paymentTypeInformation | object – set of elements used to further specify the type of transaction
categoryPurpose | string – specifies the high level purpose of the instruction based on a set of pre-defined categories; used by the initiating party to provide information concerning the processing of the payment and is likely to trigger special processing by any of the agents involved in the payment chain. Available values: CASH (general cash management instruction), CORT (transaction is related to settlement of a trade — e.g., FX or securities), or DVPM (pre-advises account servicer of a forthcoming deliver-against-payment instruction); default = CASH
instructionPriority | string – indicates the urgency or order of importance the instructing party would like to apply to processing; van be ignored for SCTInst (SEPA Instant)
localInstrument | string – used to specify a local instrument, local clearing option and/or further qualify the service or service level. INST value is used to ask for SEPA instant Payment (SCTInst). For International payments, this field may be valued with one of the ISO 20022 external codes to specify which payment instrument should be used by the creditor's bank
serviceLevel | string – only SEPA is allowed
regulatoryReportingCodes | object – contains the list of needed regulatory reporting codes for international payments
regulatory ReportingCode | string array – regulatory and statutory codes provided by the NCA
source | object – debtor/payer's bank account
account | object specifies required information about the payer 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 – payer's ACH-registered bank account
routing | string – payer's ACH-registered bank routing number
bank | object – specifies payer'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 – payer'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 – payer's UK bank account number
sortCode | string – 6-digit number identifying the payer's bank branch
guest | object – identifies transfer endpoint for a payer 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 payer'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 – payer's account number
bic | string – standard format for business identifier code (also known as SWIFT code) for payer's bank
token | object – destination account information for a Token member
accountId | string – specifies unique Token account identifier for payer's account
memberId | string – specifies unique Token member ID for payer
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 payer'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 Austrio-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
legalNames | string array – comma-separated list of payer's registered legal identities
transferDestinations | object array – the beneficiary account specifying the transfer destination; i.e., TPP/merchant/creditor bank account. See Restricting Beneficiary Accounts for guidance on adding, modifying, and deleting accounts.
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
bacs | object – (Banker's Automated Clearing Services) electronic payment made directly from one UK bank account to another, taking up to three working days to arrive. There are two main types: Direct Credit, which is a bank transfer; and Direct Debit, where one party automatically takes payment from another party’s account with their authorization
accountNumber | string – payee's BACS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
bangiro | object – identifier for domestic bank accounts in Sweden
bankgiroNumber | string – alias for the payee's bank account; consists of 7 or 8 digits; clearing code is not used
blueCash | object – American Express FX clearing and settlement system
accountNumber | string – payee's AMEX card number
chaps | object – Clearing House Automated Payments System; UK same-day system used to settle high-value wholesale payments as well as time-critical, lower-value payments like buying or paying a deposit on a property
accountNumber | string – payee's CHAPS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
custom | object – custom transfer destination
bankId | string – unique Token Platform identifier for the bank
payload | string – transfer payload
customerData | object – contains the address and name of the payer
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 Austrio-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
legalNames | string array – comma-separated list of payer's registered legal identities
elixir | object – interbank payment system in Poland
accountNumber | string – payee's Elixir-registered bank account number
euDomesticNonEuro | object – payment system within a country using that country's non-euro domestic currency
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
expressElixir | object – instant payment clearing system in Poland
accountNumber | string – payee's Elixir-registered bank account number
fasterPayments | object – interbank payment system in the UK
accountNumber | string – payee's FPS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
hsvp | object – real-time gross settlement system (RTGS) for large and time-sensitive transactions, as well as multilateral netting for small value payments. HSVP is owned and operated by the Croatian central bank (Hrvatska narodna banka, or HNB)
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
plusgiro | object – domestic transaction clearing system in Sweden; credit transfer function, which is part of Nordea, and used for mediating payments
between accounts held by companies and individuals
plusgiroNumber | string – bank account number (minimum 2 and maximum 8 digits); clearing code is not used
sepa | object – Single Euro Payments Area; for bank transfers denominated in euro; consists of the 27 member states of the European Union, the four member states of the European Free Trade Association (Iceland, Liechtenstein, Norway and Switzerland), and the United Kingdom
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
sepaInstant | object – SEPA Instant Credit Transfer; instant payment processing system with funds made available immediately for the recipient
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
sorbnet | object – real-time gross settlement system provided by the National Bank of Poland (NBP)
accountNumber | string – payee's Polish bank account number
swift | object – Society for Worldwide Interbank Financial Telecommunication; messaging network used by banks and other financial institutions to quickly, accurately, and securely send and receive information, such as money transfer instructions
account | string – payee's bank account number
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
target2 | object – real-time gross settlement (RTGS) system owned and operated by the Eurosystem
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
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
type | string –specifies the type of transfer destination; available values: UNKNOWN, BUSINESS, or PERSONAL; default = UNKNOWN
remittanceReference | string – creditor's reference for matching an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts receivable system
returnRefundAccount | boolean($boolean) – requests that a refund account be returned in a callback for any amounts refunded
startDate | string – date when regularly scheduled payments will start; uses YYYY-MM-DD or YYYYMMDD format
to | object – identified by the member initiating the request
alias | object – human-readable proxy for the member identifier that contains your realmId or alias type (DOMAIN, EMAIL, or other) and a value string
realmId | string – identifies a member created under the realm of a specific bank
type | string – specifies the type of alias; available values: INVALID, UNKNOWN, EMAIL, PHONE, DOMAIN, USERNAME, BANK, CUSTOM, or EIDAS; default = INVALID
value | string – specifies the alias in type-appropriate format (ex. DOMAIN ® www.yourCompany.com)
id | string – Member ID of the TPP, a constant value in all requests; see Member Information
tokenExpiration | string($string) – TPP-requested expiration in milliseconds
transferBody | object – contains the request payload for a transfer token representing a one-time payment
amount | string – transaction amount valued in currency
confirmFunds | boolean($boolean) – if true, sufficient funds available for transfer are confirmed
currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"
instructions | object – contains the transfer instructions each payment
metadata | object – information governing or otherwise related to the transfer instructions
chargeBearer | string – bearer of the charges, if any, for international transfers; available values: INVALID_CHARGE_BEARER, CRED (all charges are borne by the creditor), DEBT (all charges are borne by the debtor), SHAR (the parties share the charges), or SLEV (each party bears its own charges; recommended on SEPA payments); default = INVALID_CHARGE_BEARER
purposeCode | string – ISO 20022 external purpose code
ultimateCreditor | string – ultimate party to which an amount of money is due
ultimateDebtor | string – ultimate party that owes that owes money to the [ultimate] creditor
providerStandingOrderMetadata | object – standing order metadata required under the Open Banking API standard adopted by the bank
cma9StandingOrderMetadata | object – standing order metadata required under the CMA9 API standard
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
numberOfPayments | int32 – total number of recurring payments
recurringPaymentAmount | object – specifies currency and amount of each recurring payment
currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"
value | string – amount valued in currency
recurringPaymentDateTime | string – due date and time for each recurring payment in ISO 8601 format (YYYY-MM-DDThh:mm:ssTZD or YYYYMMDDThh:mm:ssTZD)
risk | object – used to specify additional details for risk scoring of paymentsdeliveryAddress | object – specifies the recipient's delivery address detailsaddressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
deliveryAddress | object – specifies the recipient's delivery address details
addressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
nextGenPsd2StandingOrderMetadata | object – standing order metadata required under the NextGenPSD2 API standard
creditorAgentName | string – name of financial institution servicing an account for the creditor
endToEndIdentification | string – unique identification assigned by the initiating party to unambiguously identify the transaction; this identification is passed on, unchanged, throughout the entire end-to-end chain
polishApiStandingOrderMetadata | object – standing order metadata required under the Polish API standard
deliveryMode | string – urgency classification for delivery; available values: INVALID_DELIVERY_MODE, STANDARD_D2, STANDARD_D1, URGENT_D1, EXPRESS_D0; default = INVALID_DELIVERY_MODE
hold | boolean – indicates whether payment should be held until confirmation of delivery
stetStandingOrderMetadata | object – standing order metadata required under the STET API standard
beneficiary | object – the creditor or payee receiving the transfer
creditor | object – ISO 20022 information about the party; can be either a person or an organisation
name | string – name by which the party is known and which is usually used to identify that party
organisationId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
postalAddress | object – contains the mailing address of the creditor
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
privateId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAccount | object – unique and unambiguous identification for the account recognised by both the account owner and the account servicer
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 – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAgent | object – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
bicFi | string – code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)"
clearingSystemMemberId | object – identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank
clearingSystemId | string – specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed
memberId | string – identification of a member of a clearing system
name | string – name by which the party is known and which is usually used to identify that party
postalAddress | object – contains the mailing address of the creditor agent
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
id | string – identifier of the beneficiary
endToEndId | string – unique identification assigned by the initiating party to unambiguously identify the transaction, which is passed on, unchanged, throughout the entire end-to-end chain
providerTransferMetadata | object – transfer metadata required under the Open Banking API standard adopted by the bank
cma9TransferMetadata | object – transfer metadata required under the CMA9 API standard
endToEndIdentification | 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)
instructionIdentification | string – TPP-generated, unique transaction Id passed to the bank (mandatory) but does not have to go any further in the payment flow. Expectation is that this is unique indefinitely across all time periods by including a date or date time element to the field, or by inserting a unique Id
remittanceInformation | object – reference information that the creditor (or beneficiary) uses to reconcile (e.g., Invoice 123)
risk | object – used to specify additional details for risk scoring of paymentsdeliveryAddress | object – specifies the recipient's delivery address detailsaddressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
deliveryAddress | object – specifies the recipient's delivery address details
addressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
nextGenPsd2TransferMetadata | object – transfer metadata required under the NextGenPSD2 API standard
creditorAgent | string – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
creditorAgentName | string – name of financial institution servicing an account for the creditor
endToEndIdentification | string – unique identification assigned by the initiating party to unambiguously identify the transaction; this identification is passed on, unchanged, throughout the entire end-to-end chain
remittanceInformation | string – information supplied to enable matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts receivable system
polishApiTransferMetadata | object – transfer metadata required under the Polish API standard
deliveryMode | string – urgency classification for delivery; available values: INVALID_DELIVERY_MODE, STANDARD_D2, STANDARD_D1, URGENT_D1, EXPRESS_D0; default = INVALID_DELIVERY_MODE
hold | boolean – indicates whether payment should be held until confirmation of delivery
stetTransferMetadata | object – transfer metadata required under the STET API standard
beneficiary | object – the creditor or payee receiving the transfer
creditor | object – ISO 20022 information about the party; can be either a person or an organisation
name | string – name by which the party is known and which is usually used to identify that party
organisationId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
postalAddress | object – contains the mailing address of the creditor
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
privateId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAccount | object – unique and unambiguous identification for the account recognised by both the account owner and the account servicer
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 – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAgent | object – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
bicFi | string – code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)"
clearingSystemMemberId | object – identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank
clearingSystemId | string – specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed
memberId | string – identification of a member of a clearing system
name | string – name by which the party is known and which is usually used to identify that party
postalAddress | object – contains the mailing address of the creditor agent
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
debtorAgent | object – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
bicFi | string – code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)"
clearingSystemMemberId | object – identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank
clearingSystemId | string – specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed
memberId | string – identification of a member of a clearing system
name | string – name by which the party is known and which is usually used to identify that party
postalAddress | object – contains the mailing address of the creditor agent
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
endToEndId | string – unique identification assigned by the initiating party to unambiguously identify the transaction, which is passed on, unchanged, throughout the entire end-to-end chain
paymentTypeInformation | object – set of elements used to further specify the type of transaction
categoryPurpose | string – specifies the high level purpose of the instruction based on a set of pre-defined categories; used by the initiating party to provide information concerning the processing of the payment and is likely to trigger special processing by any of the agents involved in the payment chain. Available values: CASH (general cash management instruction), CORT (transaction is related to settlement of a trade — e.g., FX or securities), or DVPM (pre-advises account servicer of a forthcoming deliver-against-payment instruction); default = CASH
instructionPriority | string – indicates the urgency or order of importance the instructing party would like to apply to processing; van be ignored for SCTInst (SEPA Instant)
localInstrument | string – used to specify a local instrument, local clearing option and/or further qualify the service or service level. INST value is used to ask for SEPA instant Payment (SCTInst). For International payments, this field may be valued with one of the ISO 20022 external codes to specify which payment instrument should be used by the creditor's bank
serviceLevel | string – only SEPA is allowed
regulatoryReportingCodes | object – contains the list of needed regulatory reporting codes for international payments
regulatory ReportingCode | string array – regulatory and statutory codes provided by the NCA
source | object – debtor/payer's bank account
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
legalNames | string array – comma-separated list of payer's registered legal identities
transferDestinations | object array – the beneficiary account specifying the transfer destination; i.e., TPP/merchant/creditor bank account. See Restricting Beneficiary Accounts for guidance on adding, modifying, and deleting accounts.
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
bacs | object – (Banker's Automated Clearing Services) electronic payment made directly from one UK bank account to another, taking up to three working days to arrive. There are two main types: Direct Credit, which is a bank transfer; and Direct Debit, where one party automatically takes payment from another party’s account with their authorization
accountNumber | string – payee's BACS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
bangiro | object – identifier for domestic bank accounts in Sweden
bankgiroNumber | string – alias for the payee's bank account; consists of 7 or 8 digits; clearing code is not used
blueCash | object – American Express FX clearing and settlement system
accountNumber | string – payee's AMEX card number
chaps | object – Clearing House Automated Payments System; UK same-day system used to settle high-value wholesale payments as well as time-critical, lower-value payments like buying or paying a deposit on a property
accountNumber | string – payee's CHAPS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
custom | object – custom transfer destination
bankId | string – unique Token Platform identifier for the bank
payload | string – transfer payload
customerData | object – contains the address and name of the payer
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
legalNames | string array – comma-separated list of payer's registered legal identities
elixir | object – interbank payment system in Poland
accountNumber | string – payee's Elixir-registered bank account number
euDomesticNonEuro | object – payment system within a country using that country's non-euro domestic currency
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
expressElixir | object – instant payment clearing system in Poland
accountNumber | string – payee's Elixir-registered bank account number
fasterPayments | object – interbank payment system in the UK
accountNumber | string – payee's FPS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
hsvp | object – real-time gross settlement system (RTGS) for large and time-sensitive transactions, as well as multilateral netting for small value payments. HSVP is owned and operated by the Croatian central bank (Hrvatska narodna banka, or HNB)
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
plusgiro | object – domestic transaction clearing system in Sweden; credit transfer function, which is part of Nordea, and used for mediating payments
between accounts held by companies and individuals
plusgiroNumber | string – bank account number (minimum 2 and maximum 8 digits); clearing code is not used
sepa | object – Single Euro Payments Area; for bank transfers denominated in euro; consists of the 27 member states of the European Union, the four member states of the European Free Trade Association (Iceland, Liechtenstein, Norway and Switzerland), and the United Kingdom
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
sepaInstant | object – SEPA Instant Credit Transfer; instant payment processing system with funds made available immediately for the recipient
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
sorbnet | object – real-time gross settlement system provided by the National Bank of Poland (NBP)
accountNumber | string – payee's Polish bank account number
swift | object – Society for Worldwide Interbank Financial Telecommunication; messaging network used by banks and other financial institutions to quickly, accurately, and securely send and receive information, such as money transfer instructions
account | string – payee's bank account number
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
target2 | object – real-time gross settlement (RTGS) system owned and operated by the Eurosystem
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
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
type | string –specifies the type of transfer destination; available values: UNKNOWN, BUSINESS, or PERSONAL; default = UNKNOWN
lifetimeAmount | string – total amount of the transfer over the life of the token
remittanceReference | string – creditor's reference for matching an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts receivable system
returnRefundAccount | boolean($boolean) – requests that a refund account be returned in a callback for any amounts refunded
setTransferDestinationsUrl | string – sets the URL (CDN) where transfer destinations are stored
useCredentialFlow | boolean($boolean) – deprecated; determines if bank-defined user credentials were required for initial authentication of the token request. Note: useCredentialFlow and credentials mapping only need to be set in initiate bank authorization (see the POST /token-requests/{tokenRequestId}/authorization endpoint)
userRefId | string – user-provided reference identifier
Responses
200 Success | status=OK – operation completed successfully
tokenRequest | object – contains the response to the submitted request
id | string – identifies the token request and is used by TPP as requestId; add to the base URL to define the endpoint for subsequent requests. Note: This is NOT the tokenId.
requestOptions | object – specifies optional request parameters
bankId | string – unique Token Platform identifier for the bank to which the request is being submitted
psuId | string – unique identifier for the bank customer(account holder) providing consent to initiate the request; recommended to identify group payments initiated by the same PSU
from | object – contains information identifying the requesting Token member
alias | object – alternate/additional TPP identification information
realmId | string – verified memberId of existing Token member
type | string – the type of alias; available values: INVALID, UNKNOWN, EMAIL, PHONE, DOMAIN, USERNAME, BANK, CUSTOM, or EIDAS; default = INVALID
value | string – the alias string representing the type; e.g., "elvis.lives@whatif.com" or "e-sales.token.io"
id | string – Token-assigned memberId of the TPP
receiptRequested | boolean($boolean) – requests email confirmation of the token request
sourceIban | string – specified if the user provided the IBAN rather than the TPP
requestPayload | object – contains the details for obtaining the requested token
accessBody | object – contains the request payload for a token representing account information access permissions
accountResourceList | object – body case seeking access to one or more resources for a single account
resources | object array – specifies the account and resource for which access is being requested
accountIdentifier | object – account number and associated information that identify 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
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 Austrio-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
legalNames | string array – comma-separated list of payer's registered legal identities
type | string – specifies the type of account resource requested; available values: ACCOUNT_INVALID, ACCOUNT_INFO, ACCOUNT_BALANCE, ACCOUNT_TRANSACTIONS, ACCOUNT_TRANSFER_DESTINATIONS, ACCOUNT_FUNDS_CONFIRMATION, ACCOUNT_STANDING_ORDERS; default = ACCOUNT_INVALID
resourceTypeList | object – contains the account resources being requested for access related to multiple accounts
resources | string array – specifies the account resources included in the request; available values: INVALID, ACCOUNTS, BALANCES, TRANSACTIONS, TRANSFER_DESTINATIONS, FUNDS_CONFIRMATIONS, STANDING_ORDERS; default = INVALID
actingAs | object – specifies another party for whom the token is being requested "on behalf of" — a Sub-TPP or merchant
displayName | string – name of recipient shown to user; required when specifying actingAs, optional otherwise
logoUrl | string – URL pointing to recipient's logo
refId | string – TPP's discretionary reference identification of the recipient, opaque to Token; can be used by a "gateway" business member to (uniquely) define a merchant that is acting through it.The uniqueness of refId should be handled by the gateway member; typically a reseller requiring separate reports for each participating merchant it is representing
secondaryName | string – domain or email address of recipient shown to user along with displayName
bulkTransferBody | object – specifies the source account and transfer destinations for a bulk transfer request
source | object – debtor/payer's bank account
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
legalNames | string array – comma-separated list of payer's registered legal identities
totalAmount | string – specifies the total amount of funds being distributed
transfers | object array – contains information for each transfer requested from the source
amount | string – transaction amount valued in currency
currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"
description | string – description of the transaction
destination | object – the beneficiary account specifying the transfer destination; i.e., TPP/merchant/creditor bank account. See Restricting Beneficiary Accounts for guidance on adding, modifying, and deleting accounts.
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
bacs | object – (Banker's Automated Clearing Services) electronic payment made directly from one UK bank account to another, taking up to three working days to arrive. There are two main types: Direct Credit, which is a bank transfer; and Direct Debit, where one party automatically takes payment from another party’s account with their authorization
accountNumber | string – payee's BACS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
bangiro | object – identifier for domestic bank accounts in Sweden
bankgiroNumber | string – alias for the payee's bank account; consists of 7 or 8 digits; clearing code is not used
blueCash | object – American Express FX clearing and settlement system
accountNumber | string – payee's AMEX card number
chaps | object – Clearing House Automated Payments System; UK same-day system used to settle high-value wholesale payments as well as time-critical, lower-value payments like buying or paying a deposit on a property
accountNumber | string – payee's CHAPS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
custom | object – custom transfer destination
bankId | string – unique Token Platform identifier for the bank
payload | string – transfer payload
customerData | object – contains the address and name of the payer
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 Austrio-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
legalNames | string array – comma-separated list of payer's registered legal identities
elixir | object – interbank payment system in Poland
accountNumber | string – payee's Elixir-registered bank account number
euDomesticNonEuro | object – payment system within a country using that country's non-euro domestic currency
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
expressElixir | object – instant payment clearing system in Poland
accountNumber | string – payee's Elixir-registered bank account number
fasterPayments | object – interbank payment system in the UK
accountNumber | string – payee's FPS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
hsvp | object – real-time gross settlement system (RTGS) for large and time-sensitive transactions, as well as multilateral netting for small value payments. HSVP is owned and operated by the Croatian central bank (Hrvatska narodna banka, or HNB)
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
plusgiro | object – domestic transaction clearing system in Sweden; credit transfer function, which is part of Nordea, and used for mediating payments
between accounts held by companies and individuals
plusgiroNumber | string – bank account number (minimum 2 and maximum 8 digits); clearing code is not used
sepa | object – Single Euro Payments Area; for bank transfers denominated in euro; consists of the 27 member states of the European Union, the four member states of the European Free Trade Association (Iceland, Liechtenstein, Norway and Switzerland), and the United Kingdom
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
sepaInstant | object – SEPA Instant Credit Transfer; instant payment processing system with funds made available immediately for the recipient
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
sorbnet | object – real-time gross settlement system provided by the National Bank of Poland (NBP)
accountNumber | string – payee's Polish bank account number
swift | object – Society for Worldwide Interbank Financial Telecommunication; messaging network used by banks and other financial institutions to quickly, accurately, and securely send and receive information, such as money transfer instructions
account | string – payee's bank account number
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
target2 | object – real-time gross settlement (RTGS) system owned and operated by the Eurosystem
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
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
type | string –specifies the type of transfer destination; available values: UNKNOWN, BUSINESS, or PERSONAL; default = UNKNOWN
callBackState | string – sets the callback state of the request; used for the signature in a GET /token-requests/{tokenRequestId}/token-request-result call, in which the signing payload for the signature is a combination of the state and tokenId to verify whether or not the tokenId is related to the state sent by the TPP
countries | string array – specifies the destination country or countries in ISO 3166 alpha-2 format (ex. DE, IT, GB, etc.); used to limit the number of countries displayed in the Token Web App for user selection
credentials | object – omitted unless required by bank; specifies bank-dependent user credentials; see credentialFields in GET /banks response. See also Decoupled Flow for Credentials and authorization Models for additional guidance
credential1 | string – bank-defined user credential 1
credential2 | string – bank-defined user credential 2
credential3 | string – bank-defined user credential 3
customizationId | string – deprecated; identifies the TPP's custom Web App UI configuration
description | string – Description of the payment with the following qualifiers: (ii) length must be no greater than 255 characters; (iii) description in a subsequent call must match description in originating request; (iv) description omitted in originating request must also be omitted in subsequent calls; (v) description omitted in subsequent call will be replaced with refId. This field maps to description in the bank's consentRequest presented to the user. Warning: If description in a subsequent token request for lookups/changes/updates (retrieve, redeem, or cancel) doesn't match the description in the originating token request, an exception will be thrown.
redirectUrl | string – specifies the bank's callback URL with which your server initiates token redemption
refId | string – TPP-generated reference identifier for the token; not to be confused with requestId. RefId is typically used by the TPP to reconcile transactions against payments received. RefId maps to tppRefId in the bank's consentRequest. It is needed to match/verify the originating token request with the bank's consent request. Warning: If the description in subsequent token lookups/changes/updates (retrieve, redeem, or cancel) doesn't match the description in the originating token request, an exception will be thrown.
standingOrderBody | object – contains the request payload for a token representing a standing order/recurring payment
amount | string – specifies the value (in currency) of payments scheduled according to frequency
currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"
endDate | string – date when regularly scheduled payments end; uses YYYY-MM-DD or YYYYMMDD format
frequency | string – specifies ISO 20022 code for the scheduled frequency of standing order payments occurring between the startDate and endDate: 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
instructions | object – contains the transfer instructions each payment
metadata | object – information governing or otherwise related to the transfer instructions
chargeBearer | string – bearer of the charges, if any, for international transfers; available values: INVALID_CHARGE_BEARER, CRED (all charges are borne by the creditor), DEBT (all charges are borne by the debtor), SHAR (the parties share the charges), or SLEV (each party bears its own charges; recommended on SEPA payments); default = INVALID_CHARGE_BEARER
purposeCode | string – ISO 20022 external purpose code
ultimateCreditor | string – ultimate party to which an amount of money is due
ultimateDebtor | string – ultimate party that owes that owes money to the [ultimate] creditor
providerStandingOrderMetadata | object – standing order metadata required under the Open Banking API standard adopted by the bank
cma9StandingOrderMetadata | object – standing order metadata required under the CMA9 API standard
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
numberOfPayments | int32 – total number of recurring payments
recurringPaymentAmount | object – specifies currency and amount of each recurring payment
currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"
value | string – amount valued in currency
recurringPaymentDateTime | string – due date and time for each recurring payment in ISO 8601 format (YYYY-MM-DDThh:mm:ssTZD or YYYYMMDDThh:mm:ssTZD)
risk | object – used to specify additional details for risk scoring of paymentsdeliveryAddress | object – specifies the recipient's delivery address detailsaddressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
deliveryAddress | object – specifies the recipient's delivery address details
addressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
nextGenPsd2StandingOrderMetadata | object – standing order metadata required under the NextGenPSD2 API standard
creditorAgentName | string – name of financial institution servicing an account for the creditor
endToEndIdentification | string – unique identification assigned by the initiating party to unambiguously identify the transaction; this identification is passed on, unchanged, throughout the entire end-to-end chain
polishApiStandingOrderMetadata | object – standing order metadata required under the Polish API standard
deliveryMode | string – urgency classification for delivery; available values: INVALID_DELIVERY_MODE, STANDARD_D2, STANDARD_D1, URGENT_D1, EXPRESS_D0; default = INVALID_DELIVERY_MODE
hold | boolean – indicates whether payment should be held until confirmation of delivery
stetStandingOrderMetadata | object – standing order metadata required under the STET API standard
beneficiary | object – the creditor or payee receiving the transfer
creditor | object – ISO 20022 information about the party; can be either a person or an organisation
name | string – name by which the party is known and which is usually used to identify that party
organisationId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
postalAddress | object – contains the mailing address of the creditor
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
privateId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAccount | object – unique and unambiguous identification for the account recognised by both the account owner and the account servicer
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 – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAgent | object – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
bicFi | string – code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)"
clearingSystemMemberId | object – identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank
clearingSystemId | string – specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed
memberId | string – identification of a member of a clearing system
name | string – name by which the party is known and which is usually used to identify that party
postalAddress | object – contains the mailing address of the creditor agent
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
id | string – identifier of the beneficiary
endToEndId | string – unique identification assigned by the initiating party to unambiguously identify the transaction, which is passed on, unchanged, throughout the entire end-to-end chain
providerTransferMetadata | object – transfer metadata required under the Open Banking API standard adopted by the bank
cma9TransferMetadata | object – transfer metadata required under the CMA9 API standard
endToEndIdentification | 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)
instructionIdentification | string – TPP-generated, unique transaction Id passed to the bank (mandatory) but does not have to go any further in the payment flow. Expectation is that this is unique indefinitely across all time periods by including a date or date time element to the field, or by inserting a unique Id
remittanceInformation | object – reference information that the creditor (or beneficiary) uses to reconcile (e.g., Invoice 123)
risk | object – used to specify additional details for risk scoring of paymentsdeliveryAddress | object – specifies the recipient's delivery address detailsaddressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
deliveryAddress | object – specifies the recipient's delivery address details
addressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
nextGenPsd2TransferMetadata | object – transfer metadata required under the NextGenPSD2 API standard
creditorAgent | string – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
creditorAgentName | string – name of financial institution servicing an account for the creditor
endToEndIdentification | string – unique identification assigned by the initiating party to unambiguously identify the transaction; this identification is passed on, unchanged, throughout the entire end-to-end chain
remittanceInformation | string – information supplied to enable matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts receivable system
polishApiTransferMetadata | object – transfer metadata required under the Polish API standard
deliveryMode | string – urgency classification for delivery; available values: INVALID_DELIVERY_MODE, STANDARD_D2, STANDARD_D1, URGENT_D1, EXPRESS_D0; default = INVALID_DELIVERY_MODE
hold | boolean – indicates whether payment should be held until confirmation of delivery
stetTransferMetadata | object – transfer metadata required under the STET API standard
beneficiary | object – the creditor or payee receiving the transfer
creditor | object – ISO 20022 information about the party; can be either a person or an organisation
name | string – name by which the party is known and which is usually used to identify that party
organisationId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
postalAddress | object – contains the mailing address of the creditor
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
privateId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAccount | object – unique and unambiguous identification for the account recognised by both the account owner and the account servicer
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 – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAgent | object – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
bicFi | string – code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)"
clearingSystemMemberId | object – identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank
clearingSystemId | string – specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed
memberId | string – identification of a member of a clearing system
name | string – name by which the party is known and which is usually used to identify that party
postalAddress | object – contains the mailing address of the creditor agent
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
debtorAgent | object – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
bicFi | string – code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)"
clearingSystemMemberId | object – identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank
clearingSystemId | string – specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed
memberId | string – identification of a member of a clearing system
name | string – name by which the party is known and which is usually used to identify that party
postalAddress | object – contains the mailing address of the creditor agent
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
endToEndId | string – unique identification assigned by the initiating party to unambiguously identify the transaction, which is passed on, unchanged, throughout the entire end-to-end chain
paymentTypeInformation | object – set of elements used to further specify the type of transaction
categoryPurpose | string – specifies the high level purpose of the instruction based on a set of pre-defined categories; used by the initiating party to provide information concerning the processing of the payment and is likely to trigger special processing by any of the agents involved in the payment chain. Available values: CASH (general cash management instruction), CORT (transaction is related to settlement of a trade — e.g., FX or securities), or DVPM (pre-advises account servicer of a forthcoming deliver-against-payment instruction); default = CASH
instructionPriority | string – indicates the urgency or order of importance the instructing party would like to apply to processing; van be ignored for SCTInst (SEPA Instant)
localInstrument | string – used to specify a local instrument, local clearing option and/or further qualify the service or service level. INST value is used to ask for SEPA instant Payment (SCTInst). For International payments, this field may be valued with one of the ISO 20022 external codes to specify which payment instrument should be used by the creditor's bank
serviceLevel | string – only SEPA is allowed
regulatoryReportingCodes | object – contains the list of needed regulatory reporting codes for international payments
regulatory ReportingCode | string array – regulatory and statutory codes provided by the NCA
source | object – debtor/payer's bank account
account | object specifies required information about the payer 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 – payer's ACH-registered bank account
routing | string – payer's ACH-registered bank routing number
bank | object – specifies payer'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 – payer'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 – payer's UK bank account number
sortCode | string – 6-digit number identifying the payer's bank branch
guest | object – identifies transfer endpoint for a payer 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 payer'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 – payer's account number
bic | string – standard format for business identifier code (also known as SWIFT code) for payer's bank
token | object – destination account information for a Token member
accountId | string – specifies unique Token account identifier for payer's account
memberId | string – specifies unique Token member ID for payer
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 payer'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
legalNames | string array – comma-separated list of payer's registered legal identities
transferDestinations | object array – the beneficiary account specifying the transfer destination; i.e., TPP/merchant/creditor bank account. See Restricting Beneficiary Accounts for guidance on adding, modifying, and deleting accounts.
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
bacs | object – (Banker's Automated Clearing Services) electronic payment made directly from one UK bank account to another, taking up to three working days to arrive. There are two main types: Direct Credit, which is a bank transfer; and Direct Debit, where one party automatically takes payment from another party’s account with their authorization
accountNumber | string – payee's BACS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
bangiro | object – identifier for domestic bank accounts in Sweden
bankgiroNumber | string – alias for the payee's bank account; consists of 7 or 8 digits; clearing code is not used
blueCash | object – American Express FX clearing and settlement system
accountNumber | string – payee's AMEX card number
chaps | object – Clearing House Automated Payments System; UK same-day system used to settle high-value wholesale payments as well as time-critical, lower-value payments like buying or paying a deposit on a property
accountNumber | string – payee's CHAPS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
custom | object – custom transfer destination
bankId | string – unique Token Platform identifier for the bank
payload | string – transfer payload
customerData | object – contains the address and name of the payer
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
legalNames | string array – comma-separated list of payer's registered legal identities
elixir | object – interbank payment system in Poland
accountNumber | string – payee's Elixir-registered bank account number
euDomesticNonEuro | object – payment system within a country using that country's non-euro domestic currency
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
expressElixir | object – instant payment clearing system in Poland
accountNumber | string – payee's Elixir-registered bank account number
fasterPayments | object – interbank payment system in the UK
accountNumber | string – payee's FPS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
hsvp | object – real-time gross settlement system (RTGS) for large and time-sensitive transactions, as well as multilateral netting for small value payments. HSVP is owned and operated by the Croatian central bank (Hrvatska narodna banka, or HNB)
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
plusgiro | object – domestic transaction clearing system in Sweden; credit transfer function, which is part of Nordea, and used for mediating payments
between accounts held by companies and individuals
plusgiroNumber | string – bank account number (minimum 2 and maximum 8 digits); clearing code is not used
sepa | object – Single Euro Payments Area; for bank transfers denominated in euro; consists of the 27 member states of the European Union, the four member states of the European Free Trade Association (Iceland, Liechtenstein, Norway and Switzerland), and the United Kingdom
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
sepaInstant | object – SEPA Instant Credit Transfer; instant payment processing system with funds made available immediately for the recipient
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
sorbnet | object – real-time gross settlement system provided by the National Bank of Poland (NBP)
accountNumber | string – payee's Polish bank account number
swift | object – Society for Worldwide Interbank Financial Telecommunication; messaging network used by banks and other financial institutions to quickly, accurately, and securely send and receive information, such as money transfer instructions
account | string – payee's bank account number
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
target2 | object – real-time gross settlement (RTGS) system owned and operated by the Eurosystem
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
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
type | string –specifies the type of transfer destination; available values: UNKNOWN, BUSINESS, or PERSONAL; default = UNKNOWN
remittanceReference | string – creditor's reference for matching an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts receivable system
returnRefundAccount | boolean($boolean) – requests that a refund account be returned in a callback for any amounts refunded
startDate | string – date when regularly scheduled payments will start; uses YYYY-MM-DD or YYYYMMDD format
to | object – recipient identified by the member initiating the request
alias | object – human-readable proxy for the member identifier that contains your realmId or alias type (DOMAIN, EMAIL, or other) and a value string
realmId | string – identifies a member created under the realm of a specific bank
type | string – specifies the type of alias; available values: INVALID, UNKNOWN, EMAIL, PHONE, DOMAIN, USERNAME, BANK, CUSTOM, or EIDAS; default = INVALID
value | string – specifies the alias in type-appropriate format (ex. DOMAIN ® www.yourCompany.com)
id | string – memberId of the TPP, a constant value in all requests; see Member Information
tokenExpiration | string($string) – TPP-requested expiration in milliseconds
transferBody | object – contains the request payload for a transfer token representing a one-time payment
amount | string – transaction amount valued in currency
confirmFunds | boolean($boolean) – if true, sufficient funds available for transfer are confirmed
currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"
instructions | object – contains the transfer instructions each payment
metadata | object – information governing or otherwise related to the transfer instructions
chargeBearer | string – bearer of the charges, if any, for international transfers; available values: INVALID_CHARGE_BEARER, CRED (all charges are borne by the creditor), DEBT (all charges are borne by the debtor), SHAR (the parties share the charges), or SLEV (each party bears its own charges; recommended on SEPA payments); default = INVALID_CHARGE_BEARER
purposeCode | string – ISO 20022 external purpose code
ultimateCreditor | string – ultimate party to which an amount of money is due
ultimateDebtor | string – ultimate party that owes that owes money to the [ultimate] creditor
providerStandingOrderMetadata | object – standing order metadata required under the Open Banking API standard adopted by the bank
cma9StandingOrderMetadata | object – standing order metadata required under the CMA9 API standard
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
numberOfPayments | int32 – total number of recurring payments
recurringPaymentAmount | object – specifies currency and amount of each recurring payment
currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"
value | string – amount valued in currency
recurringPaymentDateTime | string – due date and time for each recurring payment in ISO 8601 format (YYYY-MM-DDThh:mm:ssTZD or YYYYMMDDThh:mm:ssTZD)
risk | object – used to specify additional details for risk scoring of paymentsdeliveryAddress | object – specifies the recipient's delivery address detailsaddressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
deliveryAddress | object – specifies the recipient's delivery address details
addressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
nextGenPsd2StandingOrderMetadata | object – standing order metadata required under the NextGenPSD2 API standard
creditorAgentName | string – name of financial institution servicing an account for the creditor
endToEndIdentification | string – unique identification assigned by the initiating party to unambiguously identify the transaction; this identification is passed on, unchanged, throughout the entire end-to-end chain
polishApiStandingOrderMetadata | object – standing order metadata required under the Polish API standard
deliveryMode | string – urgency classification for delivery; available values: INVALID_DELIVERY_MODE, STANDARD_D2, STANDARD_D1, URGENT_D1, EXPRESS_D0; default = INVALID_DELIVERY_MODE
hold | boolean – indicates whether payment should be held until confirmation of delivery
stetStandingOrderMetadata | object – standing order metadata required under the STET API standard
beneficiary | object – the creditor or payee receiving the transfer
creditor | object – ISO 20022 information about the party; can be either a person or an organisation
name | string – name by which the party is known and which is usually used to identify that party
organisationId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
postalAddress | object – contains the mailing address of the creditor
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
privateId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAccount | object – unique and unambiguous identification for the account recognised by both the account owner and the account servicer
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 – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAgent | object – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
bicFi | string – code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)"
clearingSystemMemberId | object – identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank
clearingSystemId | string – specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed
memberId | string – identification of a member of a clearing system
name | string – name by which the party is known and which is usually used to identify that party
postalAddress | object – contains the mailing address of the creditor agent
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
id | string – identifier of the beneficiary
endToEndId | string – unique identification assigned by the initiating party to unambiguously identify the transaction, which is passed on, unchanged, throughout the entire end-to-end chain
providerTransferMetadata | object – transfer metadata required under the Open Banking API standard adopted by the bank
cma9TransferMetadata | object – transfer metadata required under the CMA9 API standard
endToEndIdentification | 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)
instructionIdentification | string – TPP-generated, unique transaction Id passed to the bank (mandatory) but does not have to go any further in the payment flow. Expectation is that this is unique indefinitely across all time periods by including a date or date time element to the field, or by inserting a unique Id
remittanceInformation | object – reference information that the creditor (or beneficiary) uses to reconcile (e.g., Invoice 123)
risk | object – used to specify additional details for risk scoring of paymentsdeliveryAddress | object – specifies the recipient's delivery address detailsaddressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
deliveryAddress | object – specifies the recipient's delivery address details
addressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
nextGenPsd2TransferMetadata | object – transfer metadata required under the NextGenPSD2 API standard
creditorAgent | string – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
creditorAgentName | string – name of financial institution servicing an account for the creditor
endToEndIdentification | string – unique identification assigned by the initiating party to unambiguously identify the transaction; this identification is passed on, unchanged, throughout the entire end-to-end chain
remittanceInformation | string – information supplied to enable matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts receivable system
polishApiTransferMetadata | object – transfer metadata required under the Polish API standard
deliveryMode | string – urgency classification for delivery; available values: INVALID_DELIVERY_MODE, STANDARD_D2, STANDARD_D1, URGENT_D1, EXPRESS_D0; default = INVALID_DELIVERY_MODE
hold | boolean – indicates whether payment should be held until confirmation of delivery
stetTransferMetadata | object – transfer metadata required under the STET API standard
beneficiary | object – the creditor or payee receiving the transfer
creditor | object – ISO 20022 information about the party; can be either a person or an organisation
name | string – name by which the party is known and which is usually used to identify that party
organisationId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
postalAddress | object – contains the mailing address of the creditor
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
privateId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAccount | object – unique and unambiguous identification for the account recognised by both the account owner and the account servicer
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 – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAgent | object – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
bicFi | string – code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)"
clearingSystemMemberId | object – identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank
clearingSystemId | string – specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed
memberId | string – identification of a member of a clearing system
name | string – name by which the party is known and which is usually used to identify that party
postalAddress | object – contains the mailing address of the creditor agent
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
debtorAgent | object – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
bicFi | string – code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)"
clearingSystemMemberId | object – identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank
clearingSystemId | string – specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed
memberId | string – identification of a member of a clearing system
name | string – name by which the party is known and which is usually used to identify that party
postalAddress | object – contains the mailing address of the creditor agent
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
endToEndId | string – unique identification assigned by the initiating party to unambiguously identify the transaction, which is passed on, unchanged, throughout the entire end-to-end chain
paymentTypeInformation | object – set of elements used to further specify the type of transaction
categoryPurpose | string – specifies the high level purpose of the instruction based on a set of pre-defined categories; used by the initiating party to provide information concerning the processing of the payment and is likely to trigger special processing by any of the agents involved in the payment chain. Available values: CASH (general cash management instruction), CORT (transaction is related to settlement of a trade — e.g., FX or securities), or DVPM (pre-advises account servicer of a forthcoming deliver-against-payment instruction); default = CASH
instructionPriority | string – indicates the urgency or order of importance the instructing party would like to apply to processing; van be ignored for SCTInst (SEPA Instant)
localInstrument | string – used to specify a local instrument, local clearing option and/or further qualify the service or service level. INST value is used to ask for SEPA instant Payment (SCTInst). For International payments, this field may be valued with one of the ISO 20022 external codes to specify which payment instrument should be used by the creditor's bank
serviceLevel | string – only SEPA is allowed
regulatoryReportingCodes | object – contains the list of needed regulatory reporting codes for international payments
regulatory ReportingCode | string array – regulatory and statutory codes provided by the NCA
source | object – debtor/payer's bank account
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
legalNames | string array – comma-separated list of payer's registered legal identities
transferDestinations | object array – the beneficiary account specifying the transfer destination; i.e., TPP/merchant/creditor bank account. See Restricting Beneficiary Accounts for guidance on adding, modifying, and deleting accounts.
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
bacs | object – (Banker's Automated Clearing Services) electronic payment made directly from one UK bank account to another, taking up to three working days to arrive. There are two main types: Direct Credit, which is a bank transfer; and Direct Debit, where one party automatically takes payment from another party’s account with their authorization
accountNumber | string – payee's BACS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
bangiro | object – identifier for domestic bank accounts in Sweden
bankgiroNumber | string – alias for the payee's bank account; consists of 7 or 8 digits; clearing code is not used
blueCash | object – American Express FX clearing and settlement system
accountNumber | string – payee's AMEX card number
chaps | object – Clearing House Automated Payments System; UK same-day system used to settle high-value wholesale payments as well as time-critical, lower-value payments like buying or paying a deposit on a property
accountNumber | string – payee's CHAPS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
custom | object – custom transfer destination
bankId | string – unique Token Platform identifier for the bank
payload | string – transfer payload
customerData | object – contains the address and name of the payer
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
legalNames | string array – comma-separated list of payer's registered legal identities
elixir | object – interbank payment system in Poland
accountNumber | string – payee's Elixir-registered bank account number
euDomesticNonEuro | object – payment system within a country using that country's non-euro domestic currency
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
expressElixir | object – instant payment clearing system in Poland
accountNumber | string – payee's Elixir-registered bank account number
fasterPayments | object – interbank payment system in the UK
accountNumber | string – payee's FPS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
hsvp | object – real-time gross settlement system (RTGS) for large and time-sensitive transactions, as well as multilateral netting for small value payments. HSVP is owned and operated by the Croatian central bank (Hrvatska narodna banka, or HNB)
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
plusgiro | object – domestic transaction clearing system in Sweden; credit transfer function, which is part of Nordea, and used for mediating payments
between accounts held by companies and individuals
plusgiroNumber | string – bank account number (minimum 2 and maximum 8 digits); clearing code is not used
sepa | object – Single Euro Payments Area; for bank transfers denominated in euro; consists of the 27 member states of the European Union, the four member states of the European Free Trade Association (Iceland, Liechtenstein, Norway and Switzerland), and the United Kingdom
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
sepaInstant | object – SEPA Instant Credit Transfer; instant payment processing system with funds made available immediately for the recipient
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
sorbnet | object – real-time gross settlement system provided by the National Bank of Poland (NBP)
accountNumber | string – payee's Polish bank account number
swift | object – Society for Worldwide Interbank Financial Telecommunication; messaging network used by banks and other financial institutions to quickly, accurately, and securely send and receive information, such as money transfer instructions
account | string – payee's bank account number
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
target2 | object – real-time gross settlement (RTGS) system owned and operated by the Eurosystem
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
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
type | string –specifies the type of transfer destination; available values: UNKNOWN, BUSINESS, or PERSONAL; default = UNKNOWN
useCredentialFlow | boolean($boolean) – deprecated; determines if bank-defined user credentials were required for initial authentication of the token request. Note: useCredentialFlow and credentials mapping only need to be set in initiate bank authorization (see the POST /token-requests/{tokenRequestId}/authorization endpoint)
userRefId | string – user-provided reference identifier
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
GET /token-requests/{requestId} Retrieves a specific token request by requestId
Request Parameters
requestId | string – required in path, identifies a unique token request; value was returned in the response to the original token request
Responses
200 Success | status=OK – operation completed successfully
customization | object – contains the customization parameters added to brand Token's white label Web App
appName | string – specifies the name for your app
colors | object – when allowed, maps the default color scheme for UI elements — primary text, secondary text, and borders — to your custom color scheme
additionalProp1 | string – color 1 (ex. #FF1A262C)
additionalProp1 | string – color 2 (ex. #FF05A5F0)
additionalProp3 | string – color 3 (ex. #FFE9EAF0)
consentText | string – custom UI text that prompts user to grant consent
customizationId | string – deprecated; identifies the TPP's custom Web App UI configuration
logoBlobId | string – identifies the immutable blob URL pointing to the logo to be displayed within the custom UI
name | string – name of the customization
hideConsent | boolean($boolean) – turns off display of the user's consent
tokenRequest | object – contains the information specified in the original token request
id | string – identifies thee token request; same value as requestId specified in the endpoint path
requestOptions | object – specifies optional request parameters
bankId | string – unique Token Platform identifier for the bank to which the request is being submitted
psuId | string – unique identifier for the bank customer(account holder) providing consent to initiate the request; recommended to identify group payments initiated by the same PSU
from | object – contains information identifying the requesting Token member
alias | object – alternate/additional TPP identification information
realmId | string – verified memberId of existing Token member
type | string – the type of alias; available values: INVALID, UNKNOWN, EMAIL, PHONE, DOMAIN, USERNAME, BANK, CUSTOM, or EIDAS; default = INVALID
value | string – the alias string representing the type; e.g., "elvis.lives@whatif.com" or "e-sales.token.io"
id | string – Token-assigned memberId of the TPP
receiptRequested | boolean($boolean) – requests email confirmation of the token request
sourceIban | string – specified if the user provided the IBAN rather than the TPP
requestPayload | object – contains the details of the requested token
accessBody | object – contains the request payload for a token representing account information access permissions
accountResourceList | object – body case seeking access to one or more resources for a single account
resources | object array – specifies the account and resource for which access is being requested
accountIdentifier | object – account number and associated information that identify 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
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 Austrio-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
type | string – specifies the type of account resource requested; available values: ACCOUNT_INVALID, ACCOUNT_INFO, ACCOUNT_BALANCE, ACCOUNT_TRANSACTIONS, ACCOUNT_TRANSFER_DESTINATIONS, ACCOUNT_FUNDS_CONFIRMATION, ACCOUNT_STANDING_ORDERS; default = ACCOUNT_INVALID
resourceTypeList | object – contains the account resources being requested for access related to multiple accounts
resources | string array – specifies the account resources included in the request; available values: INVALID, ACCOUNTS, BALANCES, TRANSACTIONS, TRANSFER_DESTINATIONS, FUNDS_CONFIRMATIONS, STANDING_ORDERS; default = INVALID
actingAs | object – specifies another party for whom the token is being requested "on behalf of" — a Sub-TPP or merchant
displayName | string – name of recipient shown to user; required when specifying actingAs, optional otherwise
logoUrl | string – URL pointing to recipient's logo
refId | string – TPP's discretionary reference identification of the recipient, opaque to Token; can be used by a "gateway" business member to (uniquely) define a merchant that is acting through it.The uniqueness of refId should be handled by the gateway member; typically a reseller requiring separate reports for each participating merchant it is representing
secondaryName | string – domain or email address of recipient shown to user along with displayName
bulkTransferBody | object – specifies the source account and transfer destinations for a bulk transfer request
source | object – debtor/payer's bank account
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
totalAmount | string – specifies the total amount of funds being distributed
transfers | object array – contains information for each transfer requested from the source
amount | string – transaction amount valued in currency
currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"
description | string – description of the transaction
destination | object – the beneficiary account specifying the transfer destination; i.e., TPP/merchant/creditor bank account. See Restricting Beneficiary Accounts for guidance on adding, modifying, and deleting accounts.
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
bacs | object – (Banker's Automated Clearing Services) electronic payment made directly from one UK bank account to another, taking up to three working days to arrive. There are two main types: Direct Credit, which is a bank transfer; and Direct Debit, where one party automatically takes payment from another party’s account with their authorization
accountNumber | string – payee's BACS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
bangiro | object – identifier for domestic bank accounts in Sweden
bankgiroNumber | string – alias for the payee's bank account; consists of 7 or 8 digits; clearing code is not used
blueCash | object – American Express FX clearing and settlement system
accountNumber | string – payee's AMEX card number
chaps | object – Clearing House Automated Payments System; UK same-day system used to settle high-value wholesale payments as well as time-critical, lower-value payments like buying or paying a deposit on a property
accountNumber | string – payee's CHAPS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
custom | object – custom transfer destination
bankId | string – unique Token Platform identifier for the bank
payload | string – transfer payload
customerData | object – contains the address and name of the payer
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 Austrio-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
legalNames | string array – comma-separated list of payer's registered legal identities
elixir | object – interbank payment system in Poland
accountNumber | string – payee's Elixir-registered bank account number
euDomesticNonEuro | object – payment system within a country using that country's non-euro domestic currency
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
expressElixir | object – instant payment clearing system in Poland
accountNumber | string – payee's Elixir-registered bank account number
fasterPayments | object – interbank payment system in the UK
accountNumber | string – payee's FPS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
hsvp | object – real-time gross settlement system (RTGS) for large and time-sensitive transactions, as well as multilateral netting for small value payments. HSVP is owned and operated by the Croatian central bank (Hrvatska narodna banka, or HNB)
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
plusgiro | object – domestic transaction clearing system in Sweden; credit transfer function, which is part of Nordea, and used for mediating payments
between accounts held by companies and individuals
plusgiroNumber | string – bank account number (minimum 2 and maximum 8 digits); clearing code is not used
sepa | object – Single Euro Payments Area; for bank transfers denominated in euro; consists of the 27 member states of the European Union, the four member states of the European Free Trade Association (Iceland, Liechtenstein, Norway and Switzerland), and the United Kingdom
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
sepaInstant | object – SEPA Instant Credit Transfer; instant payment processing system with funds made available immediately for the recipient
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
sorbnet | object – real-time gross settlement system provided by the National Bank of Poland (NBP)
accountNumber | string – payee's Polish bank account number
swift | object – Society for Worldwide Interbank Financial Telecommunication; messaging network used by banks and other financial institutions to quickly, accurately, and securely send and receive information, such as money transfer instructions
account | string – payee's bank account number
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
target2 | object – real-time gross settlement (RTGS) system owned and operated by the Eurosystem
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
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
type | string –specifies the type of transfer destination; available values: UNKNOWN, BUSINESS, or PERSONAL; default = UNKNOWN
callBackState | string – sets the callback state of the request; used for the signature in a GET /token-requests/{tokenRequestId}/token-request-result call, in which the signing payload for the signature is a combination of the state and tokenId to verify whether or not the tokenId is related to the state sent by the TPP
countries | string array – specifies the destination country or countries in ISO 3166 alpha-2 format (ex. DE, IT, GB, etc.); used to limit the number of countries displayed in the Token Web App for user selection
credentials | object – omitted unless required by bank; specifies bank-dependent user credentials; see credentialFields in GET /banks response. See also Decoupled Flow for Credentials and authorization Models for additional guidance
credential1 | string – bank-defined user credential 1
credential2 | string – bank-defined user credential 2
credential3 | string – bank-defined user credential 3
customizationId | string – deprecated; specifies the TPP's custom Web App UI configuration; not required if pre-configured using the dashboard (see )
description | string – Description of the payment with the following qualifiers: (i) must not contain special characters; (ii) length must be no greater than 255 characters; (iii) description in a subsequent call must match description in originating request; (iv) description omitted in originating request must also be omitted in subsequent calls; (v) description omitted in subsequent call will be replaced with refId. This field maps to description in the bank's consentRequest presented to the user. Warning: If description in a subsequent token request for lookups/changes/updates (retrieve, redeem, or cancel) doesn't match the description in the originating token request, an exception will be thrown.
redirectUrl | string – specifies the bank's callback URL with which your server initiates token redemption
refId | string – TPP-generated reference identifier for the token; not to be confused with requestId. RefId is typically used by the TPP to reconcile transactions against payments received. RefId maps to tppRefId in the bank's consentRequest. It is needed to match/verify the originating token request with the bank's consent request. Warning: If the description in subsequent token lookups/changes/updates (retrieve, redeem, or cancel) doesn't match the description in the originating token request, an exception will be thrown.
standingOrderBody | object – contains the request payload for a token representing a standing order/recurring payment
amount | string – specifies the value (in currency) of payments scheduled according to frequency
currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"
endDate | string – date when regularly scheduled payments end; uses YYYY-MM-DD or YYYYMMDD format
frequency | string – specifies ISO 20022 code for the scheduled frequency of standing order payments occurring between the startDate and endDate: 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
instructions | object – contains the transfer instructions each payment
metadata | object – information governing or otherwise related to the transfer instructions
chargeBearer | string – bearer of the charges, if any, for international transfers; available values: INVALID_CHARGE_BEARER, CRED (all charges are borne by the creditor), DEBT (all charges are borne by the debtor), SHAR (the parties share the charges), or SLEV (each party bears its own charges; recommended on SEPA payments); default = INVALID_CHARGE_BEARER
purposeCode | string – ISO 20022 external purpose code
ultimateCreditor | string – ultimate party to which an amount of money is due
ultimateDebtor | string – ultimate party that owes that owes money to the [ultimate] creditor
providerStandingOrderMetadata | object – standing order metadata required under the Open Banking API standard adopted by the bank
cma9StandingOrderMetadata | object – standing order metadata required under the CMA9 API standard
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
numberOfPayments | int32 – total number of recurring payments
recurringPaymentAmount | object – specifies currency and amount of each recurring payment
currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"
value | string – amount valued in currency
recurringPaymentDateTime | string – due date and time for each recurring payment in ISO 8601 format (YYYY-MM-DDThh:mm:ssTZD or YYYYMMDDThh:mm:ssTZD)
risk | object – used to specify additional details for risk scoring of paymentsdeliveryAddress | object – specifies the recipient's delivery address detailsaddressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
deliveryAddress | object – specifies the recipient's delivery address details
addressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
nextGenPsd2StandingOrderMetadata | object – standing order metadata required under the NextGenPSD2 API standard
creditorAgentName | string – name of financial institution servicing an account for the creditor
endToEndIdentification | string – unique identification assigned by the initiating party to unambiguously identify the transaction; this identification is passed on, unchanged, throughout the entire end-to-end chain
polishApiStandingOrderMetadata | object – standing order metadata required under the Polish API standard
deliveryMode | string – urgency classification for delivery; available values: INVALID_DELIVERY_MODE, STANDARD_D2, STANDARD_D1, URGENT_D1, EXPRESS_D0; default = INVALID_DELIVERY_MODE
hold | boolean – indicates whether payment should be held until confirmation of delivery
stetStandingOrderMetadata | object – standing order metadata required under the STET API standard
beneficiary | object – the creditor or payee receiving the transfer
creditor | object – ISO 20022 information about the party; can be either a person or an organisation
name | string – name by which the party is known and which is usually used to identify that party
organisationId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
postalAddress | object – contains the mailing address of the creditor
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
privateId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAccount | object – unique and unambiguous identification for the account recognised by both the account owner and the account servicer
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 – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAgent | object – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
bicFi | string – code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)"
clearingSystemMemberId | object – identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank
clearingSystemId | string – specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed
memberId | string – identification of a member of a clearing system
name | string – name by which the party is known and which is usually used to identify that party
postalAddress | object – contains the mailing address of the creditor agent
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
id | string – identifier of the beneficiary
endToEndId | string – unique identification assigned by the initiating party to unambiguously identify the transaction, which is passed on, unchanged, throughout the entire end-to-end chain
providerTransferMetadata | object – transfer metadata required under the Open Banking API standard adopted by the bank
cma9TransferMetadata | object – transfer metadata required under the CMA9 API standard
endToEndIdentification | 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)
instructionIdentification | string – TPP-generated, unique transaction Id passed to the bank (mandatory) but does not have to go any further in the payment flow. Expectation is that this is unique indefinitely across all time periods by including a date or date time element to the field, or by inserting a unique Id
remittanceInformation | object – reference information that the creditor (or beneficiary) uses to reconcile (e.g., Invoice 123)
risk | object – used to specify additional details for risk scoring of paymentsdeliveryAddress | object – specifies the recipient's delivery address detailsaddressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
deliveryAddress | object – specifies the recipient's delivery address details
addressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
nextGenPsd2TransferMetadata | object – transfer metadata required under the NextGenPSD2 API standard
creditorAgent | string – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
creditorAgentName | string – name of financial institution servicing an account for the creditor
endToEndIdentification | string – unique identification assigned by the initiating party to unambiguously identify the transaction; this identification is passed on, unchanged, throughout the entire end-to-end chain
remittanceInformation | string – information supplied to enable matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts receivable system
polishApiTransferMetadata | object – transfer metadata required under the Polish API standard
deliveryMode | string – urgency classification for delivery; available values: INVALID_DELIVERY_MODE, STANDARD_D2, STANDARD_D1, URGENT_D1, EXPRESS_D0; default = INVALID_DELIVERY_MODE
hold | boolean – indicates whether payment should be held until confirmation of delivery
stetTransferMetadata | object – transfer metadata required under the STET API standard
beneficiary | object – the creditor or payee receiving the transfer
creditor | object – ISO 20022 information about the party; can be either a person or an organisation
name | string – name by which the party is known and which is usually used to identify that party
organisationId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
postalAddress | object – contains the mailing address of the creditor
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
privateId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAccount | object – unique and unambiguous identification for the account recognised by both the account owner and the account servicer
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 – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAgent | object – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
bicFi | string – code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)"
clearingSystemMemberId | object – identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank
clearingSystemId | string – specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed
memberId | string – identification of a member of a clearing system
name | string – name by which the party is known and which is usually used to identify that party
postalAddress | object – contains the mailing address of the creditor agent
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
debtorAgent | object – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
bicFi | string – code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)"
clearingSystemMemberId | object – identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank
clearingSystemId | string – specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed
memberId | string – identification of a member of a clearing system
name | string – name by which the party is known and which is usually used to identify that party
postalAddress | object – contains the mailing address of the creditor agent
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
endToEndId | string – unique identification assigned by the initiating party to unambiguously identify the transaction, which is passed on, unchanged, throughout the entire end-to-end chain
paymentTypeInformation | object – set of elements used to further specify the type of transaction
categoryPurpose | string – specifies the high level purpose of the instruction based on a set of pre-defined categories; used by the initiating party to provide information concerning the processing of the payment and is likely to trigger special processing by any of the agents involved in the payment chain. Available values: CASH (general cash management instruction), CORT (transaction is related to settlement of a trade — e.g., FX or securities), or DVPM (pre-advises account servicer of a forthcoming deliver-against-payment instruction); default = CASH
instructionPriority | string – indicates the urgency or order of importance the instructing party would like to apply to processing; van be ignored for SCTInst (SEPA Instant)
localInstrument | string – used to specify a local instrument, local clearing option and/or further qualify the service or service level. INST value is used to ask for SEPA instant Payment (SCTInst). For International payments, this field may be valued with one of the ISO 20022 external codes to specify which payment instrument should be used by the creditor's bank
serviceLevel | string – only SEPA is allowed
regulatoryReportingCodes | object – contains the list of needed regulatory reporting codes for international payments
regulatory ReportingCode | string array – regulatory and statutory codes provided by the NCA
source | object – debtor/payer's bank account
account | object specifies required information about the payer 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 – payer's ACH-registered bank account
routing | string – payer's ACH-registered bank routing number
bank | object – specifies payer'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 – payer'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 – payer's UK bank account number
sortCode | string – 6-digit number identifying the payer's bank branch
guest | object – identifies transfer endpoint for a payer 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 payer'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 – payer's account number
bic | string – standard format for business identifier code (also known as SWIFT code) for payer's bank
token | object – destination account information for a Token member
accountId | string – specifies unique Token account identifier for payer's account
memberId | string – specifies unique Token member ID for payer
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 payer'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
legalNames | string array – comma-separated list of payer's registered legal identities
transferDestinations | object array – the beneficiary account specifying the transfer destination; i.e., TPP/merchant/creditor bank account. See Restricting Beneficiary Accounts for guidance on adding, modifying, and deleting accounts.
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
bacs | object – (Banker's Automated Clearing Services) electronic payment made directly from one UK bank account to another, taking up to three working days to arrive. There are two main types: Direct Credit, which is a bank transfer; and Direct Debit, where one party automatically takes payment from another party’s account with their authorization
accountNumber | string – payee's BACS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
bangiro | object – identifier for domestic bank accounts in Sweden
bankgiroNumber | string – alias for the payee's bank account; consists of 7 or 8 digits; clearing code is not used
blueCash | object – American Express FX clearing and settlement system
accountNumber | string – payee's AMEX card number
chaps | object – Clearing House Automated Payments System; UK same-day system used to settle high-value wholesale payments as well as time-critical, lower-value payments like buying or paying a deposit on a property
accountNumber | string – payee's CHAPS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
custom | object – custom transfer destination
bankId | string – unique Token Platform identifier for the bank
payload | string – transfer payload
customerData | object – contains the address and name of the payer
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
legalNames | string array – comma-separated list of payer's registered legal identities
elixir | object – interbank payment system in Poland
accountNumber | string – payee's Elixir-registered bank account number
euDomesticNonEuro | object – payment system within a country using that country's non-euro domestic currency
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
expressElixir | object – instant payment clearing system in Poland
accountNumber | string – payee's Elixir-registered bank account number
fasterPayments | object – interbank payment system in the UK
accountNumber | string – payee's FPS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
hsvp | object – real-time gross settlement system (RTGS) for large and time-sensitive transactions, as well as multilateral netting for small value payments. HSVP is owned and operated by the Croatian central bank (Hrvatska narodna banka, or HNB)
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
plusgiro | object – domestic transaction clearing system in Sweden; credit transfer function, which is part of Nordea, and used for mediating payments
between accounts held by companies and individuals
plusgiroNumber | string – bank account number (minimum 2 and maximum 8 digits); clearing code is not used
sepa | object – Single Euro Payments Area; for bank transfers denominated in euro; consists of the 27 member states of the European Union, the four member states of the European Free Trade Association (Iceland, Liechtenstein, Norway and Switzerland), and the United Kingdom
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
sepaInstant | object – SEPA Instant Credit Transfer; instant payment processing system with funds made available immediately for the recipient
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
sorbnet | object – real-time gross settlement system provided by the National Bank of Poland (NBP)
accountNumber | string – payee's Polish bank account number
swift | object – Society for Worldwide Interbank Financial Telecommunication; messaging network used by banks and other financial institutions to quickly, accurately, and securely send and receive information, such as money transfer instructions
account | string – payee's bank account number
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
target2 | object – real-time gross settlement (RTGS) system owned and operated by the Eurosystem
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
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
type | string –specifies the type of transfer destination; available values: UNKNOWN, BUSINESS, or PERSONAL; default = UNKNOWN
remittanceReference | string – creditor's reference for matching an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts receivable system
returnRefundAccount | boolean($boolean) – requests that a refund account be returned in a callback for any amounts refunded
startDate | string – date when regularly scheduled payments will start; uses YYYY-MM-DD or YYYYMMDD format
to | object – identified by the member initiating the request
alias | object – human-readable proxy for the member identifier that contains your realmId or alias type (DOMAIN, EMAIL, or other) and a value string
realmId | string – identifies a member created under the realm of a specific bank
type | string – specifies the type of alias; available values: INVALID, UNKNOWN, EMAIL, PHONE, DOMAIN, USERNAME, BANK, CUSTOM, or EIDAS; default = INVALID
value | string – specifies the alias in type-appropriate format (ex. DOMAIN ® www.yourCompany.com)
id | string – Member ID of the TPP, a constant value in all requests; see Member Information
tokenExpiration | string($string) – TPP-requested expiration override in number of days; default = 90
transferBody | object – contains the request payload for a transfer token representing a one-time payment
amount | string – transaction amount valued in currency
confirmFunds | boolean($boolean) – if true, sufficient funds available for transfer are confirmed
currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"
instructions | object – contains the transfer instructions each payment
metadata | object – information governing or otherwise related to the transfer instructions
chargeBearer | string – bearer of the charges, if any, for international transfers; available values: INVALID_CHARGE_BEARER, CRED (all charges are borne by the creditor), DEBT (all charges are borne by the debtor), SHAR (the parties share the charges), or SLEV (each party bears its own charges; recommended on SEPA payments); default = INVALID_CHARGE_BEARER
purposeCode | string – ISO 20022 external purpose code
ultimateCreditor | string – ultimate party to which an amount of money is due
ultimateDebtor | string – ultimate party that owes that owes money to the [ultimate] creditor
providerStandingOrderMetadata | object – standing order metadata required under the Open Banking API standard adopted by the bank
cma9StandingOrderMetadata | object – standing order metadata required under the CMA9 API standard
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
numberOfPayments | int32 – total number of recurring payments
recurringPaymentAmount | object – specifies currency and amount of each recurring payment
currency | string – ISO 4217 3-letter currency code; e.g., "USD" or "EUR"
value | string – amount valued in currency
recurringPaymentDateTime | string – due date and time for each recurring payment in ISO 8601 format (YYYY-MM-DDThh:mm:ssTZD or YYYYMMDDThh:mm:ssTZD)
risk | object – used to specify additional details for risk scoring of paymentsdeliveryAddress | object – specifies the recipient's delivery address detailsaddressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
deliveryAddress | object – specifies the recipient's delivery address details
addressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
nextGenPsd2StandingOrderMetadata | object – standing order metadata required under the NextGenPSD2 API standard
creditorAgentName | string – name of financial institution servicing an account for the creditor
endToEndIdentification | string – unique identification assigned by the initiating party to unambiguously identify the transaction; this identification is passed on, unchanged, throughout the entire end-to-end chain
polishApiStandingOrderMetadata | object – standing order metadata required under the Polish API standard
deliveryMode | string – urgency classification for delivery; available values: INVALID_DELIVERY_MODE, STANDARD_D2, STANDARD_D1, URGENT_D1, EXPRESS_D0; default = INVALID_DELIVERY_MODE
hold | boolean – indicates whether payment should be held until confirmation of delivery
stetStandingOrderMetadata | object – standing order metadata required under the STET API standard
beneficiary | object – the creditor or payee receiving the transfer
creditor | object – ISO 20022 information about the party; can be either a person or an organisation
name | string – name by which the party is known and which is usually used to identify that party
organisationId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
postalAddress | object – contains the mailing address of the creditor
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
privateId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAccount | object – unique and unambiguous identification for the account recognised by both the account owner and the account servicer
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 – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAgent | object – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
bicFi | string – code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)"
clearingSystemMemberId | object – identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank
clearingSystemId | string – specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed
memberId | string – identification of a member of a clearing system
name | string – name by which the party is known and which is usually used to identify that party
postalAddress | object – contains the mailing address of the creditor agent
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
id | string – identifier of the beneficiary
endToEndId | string – unique identification assigned by the initiating party to unambiguously identify the transaction, which is passed on, unchanged, throughout the entire end-to-end chain
providerTransferMetadata | object – transfer metadata required under the Open Banking API standard adopted by the bank
cma9TransferMetadata | object – transfer metadata required under the CMA9 API standard
endToEndIdentification | 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)
instructionIdentification | string – TPP-generated, unique transaction Id passed to the bank (mandatory) but does not have to go any further in the payment flow. Expectation is that this is unique indefinitely across all time periods by including a date or date time element to the field, or by inserting a unique Id
remittanceInformation | object – reference information that the creditor (or beneficiary) uses to reconcile (e.g., Invoice 123)
risk | object – used to specify additional details for risk scoring of paymentsdeliveryAddress | object – specifies the recipient's delivery address detailsaddressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
deliveryAddress | object – specifies the recipient's delivery address details
addressLine | string array – specifies the delivery address using multiple lines, as necessary
buildingNumber | string – building number within the delivery address
country | string – nation with its own government, occupying a particular territory containing the address
countrySubdivision | string array – identifies a subdivision of a country; for instance, a state, region, or county
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
streetName | string – name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received
townName | string – name of a built-up area with defined boundaries and a local government
merchantCategoryCode | string – Category code conforming to ISO 18245 related to the type of services or goods the merchant provides as a result of this transaction
merchantCustomerIdentification | string – unique customer identifier of the PSU with the merchant
paymentContextCode | string – specifies the payment context; available values: INVALID_PAYMENT_CONTEXT_CODE, BILL_PAYMENT, ECOMMERCE_GOODS, ECOMMERCE_SERVICES, OTHER, or PARTY_TO_PARTY; default = INVALID_PAYMENT_CONTEXT_CODE
nextGenPsd2TransferMetadata | object – transfer metadata required under the NextGenPSD2 API standard
creditorAgent | string – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
creditorAgentName | string – name of financial institution servicing an account for the creditor
endToEndIdentification | string – unique identification assigned by the initiating party to unambiguously identify the transaction; this identification is passed on, unchanged, throughout the entire end-to-end chain
remittanceInformation | string – information supplied to enable matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts receivable system
polishApiTransferMetadata | object – transfer metadata required under the Polish API standard
deliveryMode | string – urgency classification for delivery; available values: INVALID_DELIVERY_MODE, STANDARD_D2, STANDARD_D1, URGENT_D1, EXPRESS_D0; default = INVALID_DELIVERY_MODE
hold | boolean – indicates whether payment should be held until confirmation of delivery
stetTransferMetadata | object – transfer metadata required under the STET API standard
beneficiary | object – the creditor or payee receiving the transfer
creditor | object – ISO 20022 information about the party; can be either a person or an organisation
name | string – name by which the party is known and which is usually used to identify that party
organisationId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
postalAddress | object – contains the mailing address of the creditor
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
privateId | object – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAccount | object – unique and unambiguous identification for the account recognised by both the account owner and the account servicer
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 – unique identification of an account, a person, or an organisation assigned by an issuer
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
creditorAgent | object – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
bicFi | string – code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)"
clearingSystemMemberId | object – identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank
clearingSystemId | string – specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed
memberId | string – identification of a member of a clearing system
name | string – name by which the party is known and which is usually used to identify that party
postalAddress | object – contains the mailing address of the creditor agent
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
debtorAgent | object – unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
bicFi | string – code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)"
clearingSystemMemberId | object – identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank
clearingSystemId | string – specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed
memberId | string – identification of a member of a clearing system
name | string – name by which the party is known and which is usually used to identify that party
postalAddress | object – contains the mailing address of the creditor agent
addressLine | string array – up to 4 lines that capture the mailing address
country | string – nation with its own government, occupying a particular territory containing the address
endToEndId | string – unique identification assigned by the initiating party to unambiguously identify the transaction, which is passed on, unchanged, throughout the entire end-to-end chain
paymentTypeInformation | object – set of elements used to further specify the type of transaction
categoryPurpose | string – specifies the high level purpose of the instruction based on a set of pre-defined categories; used by the initiating party to provide information concerning the processing of the payment and is likely to trigger special processing by any of the agents involved in the payment chain. Available values: CASH (general cash management instruction), CORT (transaction is related to settlement of a trade — e.g., FX or securities), or DVPM (pre-advises account servicer of a forthcoming deliver-against-payment instruction); default = CASH
instructionPriority | string – indicates the urgency or order of importance the instructing party would like to apply to processing; van be ignored for SCTInst (SEPA Instant)
localInstrument | string – used to specify a local instrument, local clearing option and/or further qualify the service or service level. INST value is used to ask for SEPA instant Payment (SCTInst). For International payments, this field may be valued with one of the ISO 20022 external codes to specify which payment instrument should be used by the creditor's bank
serviceLevel | string – only SEPA is allowed
regulatoryReportingCodes | object – contains the list of needed regulatory reporting codes for international payments
regulatory ReportingCode | string array – regulatory and statutory codes provided by the NCA
source | object – debtor/payer's bank account
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
legalNames | string array – comma-separated list of payer's registered legal identities
transferDestinations | object array – the beneficiary account specifying the transfer destination; i.e., TPP/merchant/creditor bank account. See Restricting Beneficiary Accounts for guidance on adding, modifying, and deleting accounts.
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
bacs | object – (Banker's Automated Clearing Services) electronic payment made directly from one UK bank account to another, taking up to three working days to arrive. There are two main types: Direct Credit, which is a bank transfer; and Direct Debit, where one party automatically takes payment from another party’s account with their authorization
accountNumber | string – payee's BACS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
bangiro | object – identifier for domestic bank accounts in Sweden
bankgiroNumber | string – alias for the payee's bank account; consists of 7 or 8 digits; clearing code is not used
blueCash | object – American Express FX clearing and settlement system
accountNumber | string – payee's AMEX card number
chaps | object – Clearing House Automated Payments System; UK same-day system used to settle high-value wholesale payments as well as time-critical, lower-value payments like buying or paying a deposit on a property
accountNumber | string – payee's CHAPS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
custom | object – custom transfer destination
bankId | string – unique Token Platform identifier for the bank
payload | string – transfer payload
customerData | object – contains the address and name of the payer
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
legalNames | string array – comma-separated list of payer's registered legal identities
elixir | object – interbank payment system in Poland
accountNumber | string – payee's Elixir-registered bank account number
euDomesticNonEuro | object – payment system within a country using that country's non-euro domestic currency
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
expressElixir | object – instant payment clearing system in Poland
accountNumber | string – payee's Elixir-registered bank account number
fasterPayments | object – interbank payment system in the UK
accountNumber | string – payee's FPS-registered bank account number
sortCode | string – 6-digit number identifying the payee's bank branch
hsvp | object – real-time gross settlement system (RTGS) for large and time-sensitive transactions, as well as multilateral netting for small value payments. HSVP is owned and operated by the Croatian central bank (Hrvatska narodna banka, or HNB)
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
plusgiro | object – domestic transaction clearing system in Sweden; credit transfer function, which is part of Nordea, and used for mediating payments
between accounts held by companies and individuals
plusgiroNumber | string – bank account number (minimum 2 and maximum 8 digits); clearing code is not used
sepa | object – Single Euro Payments Area; for bank transfers denominated in euro; consists of the 27 member states of the European Union, the four member states of the European Free Trade Association (Iceland, Liechtenstein, Norway and Switzerland), and the United Kingdom
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
sepaInstant | object – SEPA Instant Credit Transfer; instant payment processing system with funds made available immediately for the recipient
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
sorbnet | object – real-time gross settlement system provided by the National Bank of Poland (NBP)
accountNumber | string – payee's Polish bank account number
swift | object – Society for Worldwide Interbank Financial Telecommunication; messaging network used by banks and other financial institutions to quickly, accurately, and securely send and receive information, such as money transfer instructions
account | string – payee's bank account number
bic | string – standard format for business identifier code (also known as SWIFT code) used to identify banks and financial institutions globally
target2 | object – real-time gross settlement (RTGS) system owned and operated by the Eurosystem
iban | string – payee's international bank account number; consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters
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
type | string –specifies the type of transfer destination; available values: UNKNOWN, BUSINESS, or PERSONAL; default = UNKNOWN
lifetimeAmount | string – total amount of the transfer over the life of the token
remittanceReference | string – creditor's reference for matching an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts receivable system
returnRefundAccount | boolean($boolean) – requests that a refund account be returned in a callback for any amounts refunded
setTransferDestinationsUrl | string – sets the URL (CDN) where transfer destinations are stored
useCredentialFlow | boolean($boolean) – deprecated; determines if bank-defined user credentials were required for initial authentication of the token request. Note: useCredentialFlow and credentials mapping only need to be set in initiate bank authorization (see the POST /token-requests/{tokenRequestId}/authorization endpoint)
userRefId | string – user-provided reference identifier
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
GET /token-requests/{tokenRequestId}/result Obtains the current status and result of a token request with its status
Use this endpoint to check if the final token request result is available. It will return a PENDING status while the result is not available. The status becomes PROCESSED once the result is available. If the request is rejected by the bank, status becomes REJECTED. The status will be EXPIRED if the token request expires before a PROCESSED or REJECTED status is issued by the bank.
Request Parameters
tokenRequestId | string – required in path, identifies a unique token request; value was returned in the response to the original token request as id
Responses
200 Success | status=OK – operation completed successfully
signature | object – contains information about original request's signing
keyId | string – key-id of the signature
memberId | string – specifies the TPP's unique Token member ID
signature | string – TPP's Base64url encoded ciphertext signature
standingOrderSubmissionId | string – unique ID of the standing order submission (submissionId
status | string – current result of the token request; available values: UNKNOWN, PENDING, PROCESSED, REJECTED, or EXPIRED; default = UNKNOWN
statusReasonInformation | string – the bank's reason for the reported status of the token request
tokenId | string – identifies a unique authorization token for a transfer, standing order, or account information access
transferId | string – id of the transfer sent in POST /transfer response and/or included in a respective GET /transfers response
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
GET /token-requests/{tokenRequestId}/token_request_result Retrieves the result of a token request submission
Request Parameters
tokenRequestId | string – required in path, identifies a unique token request; value was returned in the response to the original token request as id
Responses
200 Success | status=OK – operation completed successfully
signature | object – contains information about original request's signing
keyId | string – key-id of the signature
memberId | string – specifies the TPP's unique Token member ID
signature | string – TPP's Base64url encoded ciphertext signature
standingOrderSubmissionId | string – unique ID of the standing order submission (submissionId
tokenId | string – identifies a unique authorization token for a transfer, standing order, or account information access
transferId | string – id of the transfer sent in POST /transfer response and/or included in a respective GET /transfers response
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