Transfers

These endpoints allow you to submit new payment initiation requests and retrieve information about existing payments. Click an item below to expand/collapse its content.

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

page.limit | integer($int32) – required query parameter; maximum number of records to return; default = 1

filter.startTimeMs | string($string) – query parameter, optional; filtered list start time boundary in milliseconds; ex. 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000

filter.endTimeMs | string($string) – query parameter, optional; filtered list end time boundary in milliseconds; ex. 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000

filter.submissionStatus | string – query parameter, optional; submission status filter; available values: INVALID, PENDING, PROCESSING, SUCCESS, FAILED, INITIATED, CANCELED, SENT, or PENDING_EXTERNAL_AUTHORIZATION; default = INVALID

filter.role | string – query parameter, optional; accountholder role filter; available values: ANY, PAYER, or PAYEE; default = ANY

filter.actingAsRefId | string – query parameter, optional; 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

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

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

id | string – ID of the standing order submission (submissionId); can be used in a GET /standing-order-submissions/{submissionId} request to fetch the status of the respective standing order submission

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

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

CMA9 API standard

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)

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

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)

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

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

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

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

STET API standard
ISO 20022

name | string – name by which the party is known and which is usually used to identify that party

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

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

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

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

identification | string – alias of the account

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

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

bicFi | string – 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)"

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

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

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)

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

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

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

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

STET API standard
ISO 20022

name | string – name by which the party is known and which is usually used to identify that party

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

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

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

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

identification | string – alias of the account

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

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

bicFi | string – 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)"

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

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

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

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

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

executionRule | string – execution date-shifting rule when a recurring payment date falls on a weekend or bank holiday; payment is then executed either the "preceding" or "following" working day in accordance with bank policy

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

regulatory ReportingCode | string array – regulatory and statutory codes provided by the NCA

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

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

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 | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

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 | string – 14, 15, or 16 digit number generated as a unique identifier for a primary account

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

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

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

Restricting Beneficiary Accounts

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

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

accountNumber | string – payee's BACS-registered bank account number

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

bankgiroNumber | string – alias for the payee's bank account; consists of 7 or 8 digits; clearing code is not used

accountNumber | string – payee's AMEX card number

accountNumber | string – payee's CHAPS-registered bank account number

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

bankId | string – unique Token Platform identifier for the bank

payload | string – transfer payload

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 payee's registered legal identities

accountNumber | string – payee's Elixir-registered bank account number

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

accountNumber | string – payee's Elixir-registered bank account number

accountNumber | string – payee's FPS-registered bank account number

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

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

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

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

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

accountNumber | string – payee's Polish bank account number

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

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

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

startDate | string – date when regularly scheduled payments will start; uses YYYY-MM-DD or YYYYMMDD format

id | string – provider-specific reference ID generated upon TPP submission

status | string – status of user authentication; available values: INVALID, AUTHENTICATED, or AUTHENTICATION_FAILED; default = INVALID

standingOrderId | string – bank's standing order reference id; can be used to look up a standing order

status | string – status of the standing order; available values: INVALID, PENDING, PROCESSING, SUCCESS, FAILED, INITIATED, CANCELED, SENT, or PENDING_EXTERNAL_AUTHORIZATION; default = INVALID

statusReasonInformation | string – bank-dependent internal status code; see Payment Status: Values and Meaning for status reason mapping

tokenId | string – token identifier for standing order; can be used for lookup standing order with GET /tokens/{tokenId}

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

 

tokenId | string – identifies the authorization token for the standing order

authorizationUrl | string – content displayed from this URL prompted the user for permission to initiate the standing order

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

id | string – ID of the standing order submission (submissionId); can be used in GET /standing-order-submissions/{submissionId} request to fetch the status of the respective standing order submission

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

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

CMA9 API standard

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)

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

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)

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

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

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

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

STET API standard
ISO 20022

name | string – name by which the party is known and which is usually used to identify that party

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

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

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

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

identification | string – alias of the account

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

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

bicFi | string – 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)"

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

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

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)

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

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

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

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

STET API standard
ISO 20022

name | string – name by which the party is known and which is usually used to identify that party

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

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

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

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

identification | string – alias of the account

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

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

bicFi | string – 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)"

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

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

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

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

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

executionRule | string – execution date-shifting rule when a recurring payment date falls on a weekend or bank holiday; payment is then executed either the "preceding" or "following" working day in accordance with bank policy

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

regulatory ReportingCode | string array – regulatory and statutory codes provided by the NCA

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

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

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 | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

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 | string – 14, 15, or 16 digit number generated as a unique identifier for a primary account

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

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

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

Restricting Beneficiary Accounts

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

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

accountNumber | string – payee's BACS-registered bank account number

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

bankgiroNumber | string – alias for the payee's bank account; consists of 7 or 8 digits; clearing code is not used

accountNumber | string – payee's AMEX card number

accountNumber | string – payee's CHAPS-registered bank account number

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

bankId | string – unique Token Platform identifier for the bank

payload | string – transfer payload

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 payee's registered legal identities

accountNumber | string – payee's Elixir-registered bank account number

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

accountNumber | string – payee's Elixir-registered bank account number

accountNumber | string – payee's FPS-registered bank account number

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

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

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

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

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

accountNumber | string – payee's Polish bank account number

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

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

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

startDate | string – date when regularly scheduled payments will start; uses YYYY-MM-DD or YYYYMMDD format

id | string – provider-specific reference ID generated upon TPP submission

status | string – status of user authentication; available values: INVALID, AUTHENTICATED, or AUTHENTICATION_FAILED; default = INVALID

standingOrderId | string – bank's standing order reference id; can be used to look up a standing order

status | string – status of the standing order; available values: INVALID, PENDING, PROCESSING, SUCCESS, FAILED, INITIATED, CANCELED, SENT, or PENDING_EXTERNAL_AUTHORIZATION; default = INVALID

statusReasonInformation | string – bank-dependent internal status code; see Payment Status: Values and Meaning for status reason mapping

tokenId | string – identifies the authorization token for the standing order

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

 

submissionId | string – required in path; uniquely identifies the standing order submission

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

id | string – ID of the standing order submission; should be identical to submissionId request parameter

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

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

CMA9 API standard

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)

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

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)

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

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

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

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

STET API standard
ISO 20022

name | string – name by which the party is known and which is usually used to identify that party

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

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

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

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

identification | string – alias of the account

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

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

bicFi | string – 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)"

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

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

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)

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

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

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

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

STET API standard
ISO 20022

name | string – name by which the party is known and which is usually used to identify that party

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

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

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

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

identification | string – alias of the account

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

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

bicFi | string – 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)"

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

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

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

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

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

executionRule | string – execution date-shifting rule when a recurring payment date falls on a weekend or bank holiday; payment is then executed either the "preceding" or "following" working day in accordance with bank policy

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

regulatory ReportingCode | string array – regulatory and statutory codes provided by the NCA

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

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

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 | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

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 | string – 14, 15, or 16 digit number generated as a unique identifier for a primary account

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

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

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

Restricting Beneficiary Accounts

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

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

accountNumber | string – payee's BACS-registered bank account number

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

bankgiroNumber | string – alias for the payee's bank account; consists of 7 or 8 digits; clearing code is not used

accountNumber | string – payee's AMEX card number

accountNumber | string – payee's CHAPS-registered bank account number

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

bankId | string – unique Token Platform identifier for the bank

payload | string – transfer payload

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 payee's registered legal identities

accountNumber | string – payee's Elixir-registered bank account number

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

accountNumber | string – payee's Elixir-registered bank account number

accountNumber | string – payee's FPS-registered bank account number

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

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

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

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

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

accountNumber | string – payee's Polish bank account number

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

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

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

startDate | string – date when regularly scheduled payments will start; uses YYYY-MM-DD or YYYYMMDD format

id | string – provider-specific reference ID generated upon TPP submission

status | string – status of user authentication; available values: INVALID, AUTHENTICATED, or AUTHENTICATION_FAILED; default = INVALID

standingOrderId | string – bank's standing order reference id; can be used to look up a standing order

status | string – status of the standing order; available values: INVALID, PENDING, PROCESSING, SUCCESS, FAILED, INITIATED, CANCELED, SENT, or PENDING_EXTERNAL_AUTHORIZATION; default = INVALID

statusReasonInformation | string – bank-dependent internal status code; see Payment Status: Values and Meaning for status reason mapping

tokenId | string – identifies the authorization token for the standing order

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

 

tokenId | string – query parameter, optional; identifies the authorization token for the access request

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

page.limit | integer($int32) – required query parameter; maximum number of records to return; must be less <=200; default = 1.

filter.tokenId | string – query parameter, optional; sets filtering by token ID

filter.startTimeMs | string($string) – query parameter, optional; filtered list start time boundary in milliseconds; ex. 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000

filter.endTimeMs | string($string) – query parameter, optional; filtered list end time boundary in milliseconds; ex. 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000

filter.transactionStatus | string – query parameter, optional; filtered list transaction status; available values: INVALID_STATUS, PENDING, PROCESSING, SUCCESS, PENDING_EXTERNAL_AUTHORIZATION, FAILURE_CANCELED, FAILURE_INSUFFICIENT_FUNDS, FAILURE_INVALID_CURRENCY, FAILURE_PERMISSION_DENIED, FAILURE_QUOTE_EXPIRED, FAILURE_INVALID_AMOUNT, FAILURE_INVALID_QUOTE, FAILURE_EXPIRED, FAILURE_DECLINED, FAILURE_GENERIC, SENT, INITIATED, or STATUS_NOT_AVAILABLE; default = INVALID_STATUS

filter.role | string – query parameter, optional; filters list by accountholder role; available values: ANY, PAYER, or PAYEE; default = ANY

filter.actingAsRefId | string – query parameter, optional; filters list by on behalf of; typically the merchant identified in the transfer's refId

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

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

convertedToFuturePayment | boolean($boolean) – indicates whether a transfer is from an auto single immediate payment coinciding with the bank's out-of-operation hours was converted to a future dated payment

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

executionDate | string – specifies when the transfer was executed

id | string – transferId computed as the hash of the transfer payload

method | string – method of the transfer; available values: DEFAULT (scheduled) or INSTANT; default = DEFAULT

orderId | string – identifies the foreign exchange order

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

value | string – amount valued in currency

confirmFunds | boolean($boolean) – if true, sufficient funds available for transfer are confirmed

description | string – description of the transfer

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

CMA9 API standard

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)

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

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)

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

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

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

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

STET API standard
ISO 20022

name | string – name by which the party is known and which is usually used to identify that party

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

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

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

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

identification | string – alias of the account

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

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

bicFi | string – 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)"

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

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

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)

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

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

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

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

STET API standard
ISO 20022

name | string – name by which the party is known and which is usually used to identify that party

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

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

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

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

identification | string – alias of the account

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

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

bicFi | string – 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)"

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

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

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

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

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

executionRule | string – execution date-shifting rule when a recurring payment date falls on a weekend or bank holiday; payment is then executed either the "preceding" or "following" working day in accordance with bank policy

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

regulatory ReportingCode | string array – regulatory and statutory codes provided by the NCA

refId | string – TPP-generated reference identifier for the token included in the original request; 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.

tokenId | string – identifies the authorization token for the transfer

Restricting Beneficiary Accounts

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

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

accountNumber | string – payee's BACS-registered bank account number

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

bankgiroNumber | string – alias for the payee's bank account; consists of 7 or 8 digits; clearing code is not used

accountNumber | string – payee's AMEX card number

accountNumber | string – payee's CHAPS-registered bank account number

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

bankId | string – unique Token Platform identifier for the bank

payload | string – transfer payload

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 payee's registered legal identities

accountNumber | string – payee's Elixir-registered bank account number

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

accountNumber | string – payee's Elixir-registered bank account number

accountNumber | string – payee's FPS-registered bank account number

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

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

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

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

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

accountNumber | string – payee's Polish bank account number

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

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

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

keyId | string – ID of the public key used to verify signature

memberId | string – Token member ID of the signing member

signature | string – Base64url encoded ciphertext signature

id | string – provider-specific reference ID generated upon TPP submission

status | string – status of user authentication; available values: INVALID, AUTHENTICATED, or AUTHENTICATION_FAILED; default = INVALID

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

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

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 | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

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 | string – 14, 15, or 16 digit number generated as a unique identifier for a primary account

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

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

name | string – name of the account

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

value | string – amount valued in currency

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

value | string – amount valued in currency

transferRefundStatus | string – indicates the disposition of the initiated refund payout; available values: NONE, PARTIAL, or FULL; default = NONE

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

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

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 | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

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 | string – 14, 15, or 16 digit number generated as a unique identifier for a primary account

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

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

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

status | string – current status of the transaction; available values: INVALID_STATUS, PENDING, PROCESSING, SUCCESS, PENDING_EXTERNAL_AUTHORIZATION, FAILURE_CANCELED, FAILURE_INSUFFICIENT_FUNDS, FAILURE_INVALID_CURRENCY, FAILURE_PERMISSION_DENIED, FAILURE_QUOTE_EXPIRED, FAILURE_INVALID_AMOUNT, FAILURE_INVALID_QUOTE, FAILURE_EXPIRED, FAILURE_DECLINED, FAILURE_GENERIC, SENT, INITIATED, or STATUS_NOT_AVAILABLE; default = INVALID_STATUS

statusReasonInformation | string – bank-dependent internal status code; see Payment Status: Values and Meaning for status reason mapping

transactionId | string – unique transaction identifier; transaction ID

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

 

This endpoint is only required for banks that support 2-step payments

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

value | string – amount valued in currency

confirmFunds | boolean($boolean) – requests confirmation of sufficient funds available

description | string – description of the transfer

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

CMA9 API standard

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)

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

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)

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

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

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

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

STET API standard
ISO 20022

name | string – name by which the party is known and which is usually used to identify that party

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

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

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

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

identification | string – alias of the account

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

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

bicFi | string – 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)"

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

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

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)

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

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

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

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

STET API standard
ISO 20022

name | string – name by which the party is known and which is usually used to identify that party

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

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

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

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

identification | string – alias of the account

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

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

bicFi | string – 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)"

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

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

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

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

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

executionRule | string – execution date-shifting rule when a recurring payment date falls on a weekend or bank holiday; payment is then executed either the "preceding" or "following" working day in accordance with bank policy

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

regulatory ReportingCode | string array – regulatory and statutory codes provided by the NCA

refId | string – TPP-generated reference identifier for the token included in the original request; 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.

tokenId | string – identifies the authorization token for the transfer

Restricting Beneficiary Accounts

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

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

accountNumber | string – payee's BACS-registered bank account number

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

bankgiroNumber | string – alias for the payee's bank account; consists of 7 or 8 digits; clearing code is not used

accountNumber | string – payee's AMEX card number

accountNumber | string – payee's CHAPS-registered bank account number

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

bankId | string – unique Token Platform identifier for the bank

payload | string – transfer payload

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 payee's registered legal identities

accountNumber | string – payee's Elixir-registered bank account number

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

accountNumber | string – payee's Elixir-registered bank account number

accountNumber | string – payee's FPS-registered bank account number

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

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

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

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

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

accountNumber | string – payee's Polish bank account number

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

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

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

authorizationUrl | string – content displayed from this URL prompted the user for permission to initiate the standing order

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

executionDate | string – specifies when the transfer was executed

id | string – transferId computed as the hash of the transfer payload

method | string – method of the transfer; available values: DEFAULT (scheduled) or INSTANT; default = DEFAULT

orderId | string – identifies the foreign exchange order

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

value | string – amount valued in currency

confirmFunds | boolean($boolean) – if true, sufficient funds available for transfer are confirmed

description | string – description of the transfer

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

CMA9 API standard

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)

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

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)

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

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

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

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

STET API standard
ISO 20022

name | string – name by which the party is known and which is usually used to identify that party

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

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

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

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

identification | string – alias of the account

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

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

bicFi | string – 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)"

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

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

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)

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

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

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

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

STET API standard
ISO 20022

name | string – name by which the party is known and which is usually used to identify that party

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

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

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

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

identification | string – alias of the account

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

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

bicFi | string – 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)"

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

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

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

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

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

executionRule | string – execution date-shifting rule when a recurring payment date falls on a weekend or bank holiday; payment is then executed either the "preceding" or "following" working day in accordance with bank policy

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

regulatory ReportingCode | string array – regulatory and statutory codes provided by the NCA

refId | string – TPP-generated reference identifier for the token included in the original request; 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.

tokenId | string – identifies the authorization token for the transfer

Restricting Beneficiary Accounts

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

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

accountNumber | string – payee's BACS-registered bank account number

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

bankgiroNumber | string – alias for the payee's bank account; consists of 7 or 8 digits; clearing code is not used

accountNumber | string – payee's AMEX card number

accountNumber | string – payee's CHAPS-registered bank account number

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

bankId | string – unique Token Platform identifier for the bank

payload | string – transfer payload

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 payee's registered legal identities

accountNumber | string – payee's Elixir-registered bank account number

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

accountNumber | string – payee's Elixir-registered bank account number

accountNumber | string – payee's FPS-registered bank account number

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

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

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

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

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

accountNumber | string – payee's Polish bank account number

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

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

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

keyId | string – ID of the public key used to verify signature

memberId | string – Token member ID of the signing member

signature | string – Base64url encoded ciphertext signature

id | string – provider-specific reference ID generated upon TPP submission

status | string – status of user authentication; available values: INVALID, AUTHENTICATED, or AUTHENTICATION_FAILED; default = INVALID

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

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

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 | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

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 | string – 14, 15, or 16 digit number generated as a unique identifier for a primary account

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

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

name | string – name of the account

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

value | string – amount valued in currency

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

value | string – amount valued in currency

transferRefundStatus | string – indicates the disposition of the initiated refund payout; available values: NONE, PARTIAL, or FULL; default = NONE

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

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

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 | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

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 | string – 14, 15, or 16 digit number generated as a unique identifier for a primary account

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

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

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

status | string – current status of the transaction; available values: INVALID_STATUS, PENDING, PROCESSING, SUCCESS, PENDING_EXTERNAL_AUTHORIZATION, FAILURE_CANCELED, FAILURE_INSUFFICIENT_FUNDS, FAILURE_INVALID_CURRENCY, FAILURE_PERMISSION_DENIED, FAILURE_QUOTE_EXPIRED, FAILURE_INVALID_AMOUNT, FAILURE_INVALID_QUOTE, FAILURE_EXPIRED, FAILURE_DECLINED, FAILURE_GENERIC, SENT, INITIATED, or STATUS_NOT_AVAILABLE; default = INVALID_STATUS

statusReasonInformation | string – bank-dependent internal status code; see Payment Status: Values and Meaning for status reason mapping

transactionId | string – unique transaction identifier; transaction ID

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

 

transferId | string – required in path; unique id of the transfer sent in POST /transfer response and/or included in a respective GET /transfers response

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

convertedToFuturePayment | boolean($boolean) – indicates whether a transfer is from an auto single immediate payment coinciding with the bank's out-of-operation hours was converted to a future dated payment

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

executionDate | string – specifies when the transfer was executed

id | string – transferId computed as the hash of the transfer payload

method | string – method of the transfer; available values: DEFAULT (scheduled) or INSTANT; default = DEFAULT

orderId | string – identifies the foreign exchange order

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

value | string – amount valued in currency

confirmFunds | boolean($boolean) – if true, sufficient funds available for transfer are confirmed

description | string – description of the transfer

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

CMA9 API standard

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)

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

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)

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

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

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

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

STET API standard
ISO 20022

name | string – name by which the party is known and which is usually used to identify that party

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

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

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

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

identification | string – alias of the account

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

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

bicFi | string – 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)"

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

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

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)

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

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

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

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

STET API standard
ISO 20022

name | string – name by which the party is known and which is usually used to identify that party

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

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

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

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

identification | string – alias of the account

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

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

bicFi | string – 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)"

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

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

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

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

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

executionRule | string – execution date-shifting rule when a recurring payment date falls on a weekend or bank holiday; payment is then executed either the "preceding" or "following" working day in accordance with bank policy

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

regulatory ReportingCode | string array – regulatory and statutory codes provided by the NCA

refId | string – TPP-generated reference identifier for the token included in the original request; 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.

tokenId | string – identifies the authorization token for the transfer

Restricting Beneficiary Accounts

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

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

accountNumber | string – payee's BACS-registered bank account number

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

bankgiroNumber | string – alias for the payee's bank account; consists of 7 or 8 digits; clearing code is not used

accountNumber | string – payee's AMEX card number

accountNumber | string – payee's CHAPS-registered bank account number

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

bankId | string – unique Token Platform identifier for the bank

payload | string – transfer payload

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 payee's registered legal identities

accountNumber | string – payee's Elixir-registered bank account number

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

accountNumber | string – payee's Elixir-registered bank account number

accountNumber | string – payee's FPS-registered bank account number

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

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

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

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

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

accountNumber | string – payee's Polish bank account number

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

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

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

keyId | string – ID of the public key used to verify signature

memberId | string – Token member ID of the signing member

signature | string – Base64url encoded ciphertext signature

id | string – provider-specific reference ID generated upon TPP submission

status | string – status of user authentication; available values: INVALID, AUTHENTICATED, or AUTHENTICATION_FAILED; default = INVALID

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

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

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 | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

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 | string – 14, 15, or 16 digit number generated as a unique identifier for a primary account

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

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

name | string – name of the account

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

value | string – amount valued in currency

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

value | string – amount valued in currency

transferRefundStatus | string – indicates the disposition of the initiated refund payout; available values: NONE, PARTIAL, or FULL; default = NONE

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

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

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 | string – consists of a two-letter country code, followed by two check digits, and up to thirty-five alphanumeric characters

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 | string – 14, 15, or 16 digit number generated as a unique identifier for a primary account

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

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

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

status | string – current status of the transaction; available values: INVALID_STATUS, PENDING, PROCESSING, SUCCESS, PENDING_EXTERNAL_AUTHORIZATION, FAILURE_CANCELED, FAILURE_INSUFFICIENT_FUNDS, FAILURE_INVALID_CURRENCY, FAILURE_PERMISSION_DENIED, FAILURE_QUOTE_EXPIRED, FAILURE_INVALID_AMOUNT, FAILURE_INVALID_QUOTE, FAILURE_EXPIRED, FAILURE_DECLINED, FAILURE_GENERIC, SENT, INITIATED, or STATUS_NOT_AVAILABLE; default = INVALID_STATUS

statusReasonInformation | string – bank-dependent internal status code; see Payment Status: Values and Meaning for status reason mapping

transactionId | string – unique transaction identifier; transaction ID

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