# Get account transactions

The GET /accounts/{accountId}/transactions endpoint retrieves information for all transactions in a given account.

Endpoint: GET /accounts/{accountId}/transactions
Security: Bearer, BasicAuth

## Header parameters:

  - `on-behalf-of` (string, required)
    The tokenId represents the consent granted by the user (PSU).
    Example: "ta:3eYPU1BEKKunfmYgQuSKXFCeo851C5Y3XiZW3XA465TU:5zKtXEAq"

  - `token-customer-ip-address` (string)
    The user's IP address if the user is currently logged in with the TPP. If the customer  IP address is supplied (recommended), it is inferred that the user is present during the session (i.e., the request is user-initiated; adding a customer-initiated = true header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.
    Example: "172.16.254.1"

## Path parameters:

  - `accountId` (string)
    The system-generated unique bank account id, which specifies the account for which the information is requested.
    Example: "a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV"

## Query parameters:

  - `page.offset` (string)
    The offset for the current page. If the offset has been provided in the request, this offset will be equal to the provided one. But if no offset was provided in the request (i.e. this is the first page) and the page is not empty, this field will be populated with a non-empty string. This may be helpful for loading the same page again, which might not always be possible with an empty offset due to a dynamic nature of the data. The offset is not visible to a user and should not be parsed and/or understood in any way.
    Example: "LerV6Jmex"

  - `page.limit` (integer, required)
    The maximum number of records to return. This must be less than 200.
    Example: 175

  - `startDate` (string)
    The earliest transaction date requested, in ISO 8601 format.
    Example: "2022-06-15"

  - `endDate` (string)
    The latest transaction date requested, in ISO 8601 format.
    Example: "2022-11-30"

## Response 200 fields (application/json):

  - `offset` (string)
    The offset of the first item returned in the collection.
    Example: "LerV6Jmex"

  - `status` (string, required)
    Specifies the status of the request.
    Enum: "INVALID_REQUEST", "SUCCESSFUL_REQUEST", "MORE_SIGNATURES_NEEDED"

  - `transactions` (array)

  - `transactions.amount` (object, required)
    The transaction currency and value. The amount is only displayed if a transaction is returned.

  - `transactions.amount.currency` (string, required)
    The ISO 4217 three letter currency code.
    Example: "EUR"

  - `transactions.amount.value` (string, required)
    The transaction amount with up to four digits after the decimal point.
    Example: "10.23"

  - `transactions.bankTransactionCode` (object)
    The Bank transaction code, created using the sub-elements of the structured code defined by ISO 20022; it concatenates the three ISO 20022 Codes - Domain Code, Family Code, and SubFamiliy Code by hyphens, resulting in 'DomainCode'-'FamilyCode'-'SubFamilyCode'; e.g., "PMNT-RDDT-ESDD".

  - `transactions.bankTransactionCode.domain` (object)
    Bank transaction code using the sub-elements of the structured code defined by ISO 20022. It concatenates the three ISO 20022 Codes: Domain Code, Family Code, and SubFamiliy Code with hyphens, resulting in 'DomainCode'-'FamilyCode'-'SubFamilyCode'; e.g., "PMNT-RDDT-ESDD".

  - `transactions.bankTransactionCode.domain.code` (string)
    The domain code.
    Example: "PMNT"

  - `transactions.bankTransactionCode.domain.familyCode` (string)
    The family code.
    Example: "RCDT"

  - `transactions.bankTransactionCode.domain.subFamilyCode` (string)
    The sub-family code.
    Example: "ESCT"

  - `transactions.bankTransactionCode.proprietary` (object)
    A bank transaction code used within a community or within a bank; e.g., for MT94x based transaction reports.

  - `transactions.bankTransactionCode.proprietary.code` (string)
    The bank code.
    Example: "XXXX"

  - `transactions.bankTransactionCode.proprietary.issuer` (string)
    The issuer code.
    Example: "XXXX"

  - `transactions.bankTransactionId` (string)
    The bank-assigned unique identifier for the transaction.
    Example: "83KiRJuXmEDV5m2b8ZvLGE91ELf7PPw5BaDab98kMguu:3VMczyq7r7b6HwC"

  - `transactions.createdAtMs` (string, required)
    Specifies the time the transfer was created; timestamp (UTC) in milliseconds, 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000.
    Example: 1729212980771

  - `transactions.creditorEndpoint` (object)
    Contains information about the payee account.

  - `transactions.creditorEndpoint.accountIdentifier` (object, required)
    Account numbers and other strings that identify this as a unique bank account.

  - `transactions.creditorEndpoint.bankId` (string)
    The Token.io id of the bank where the consent is created. This field is required if the customer is not using Token.io's Hosted Pages for bank selection, i.e., API-only integration when EMBEDDED_HOSTED_PAGES is selected in flowType, or Hosted Pages embedded (modal) integration.
    Example: "ob-modelo"

  - `transactions.creditorEndpoint.bic` (string)
    The Business Identifier Code (BIC), ISO 9362, is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs are often called SWIFT Codes and can be either 8 or 11 characters long.
    Example: "BOFIIE2D"

  - `transactions.creditorEndpoint.customerData` (object)
    Specifies the legal identity information for the payee. This information is not required for settlement accounts.

  - `transactions.creditorEndpoint.customerData.address` (object)
    The complete postal address of a party.

  - `transactions.creditorEndpoint.customerData.address.city` (string)
    Name of the city as given in postal addresses of the building/area.
    Example: "Berlin"

  - `transactions.creditorEndpoint.customerData.address.conscriptionNumber` (string)
    A special kind of house number. This relates to a settlement instead of a street. Conscription numbers are in use in some parts of Europe, sometimes together with street-related house numbers, which are also called orientation numbers.
    Example: "2831"

  - `transactions.creditorEndpoint.customerData.address.country` (string)
    Two-letter country code in upper case (ISO 3166-1 alpha-2).
    Example: "DE"

  - `transactions.creditorEndpoint.customerData.address.district` (string)
    A defined district within the city or country containing the address.
    Example: "Friedrichshain"

  - `transactions.creditorEndpoint.customerData.address.flats` (string)
    House numbers (range or list) of flats behind a door.
    Example: "21A - 21C"

  - `transactions.creditorEndpoint.customerData.address.full` (string)
    This is 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. Typically such strings cannot be parsed by software.
    Example: "Fifth house on the left after the village oak, Smalltown, Smallcountry"

  - `transactions.creditorEndpoint.customerData.address.hamlet` (string)
    A small 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.
    Example: "Botzowviertel"

  - `transactions.creditorEndpoint.customerData.address.houseName` (string)
    The name of a house. Sometimes used in countries like England instead of (or in addition to) a house number.
    Example: "Grossen Blauen Haus"

  - `transactions.creditorEndpoint.customerData.address.houseNumber` (string)
    The house number (may contain letters, dashes, or other characters). This identifies a single building with multiple addresses.
    Example: "123"

  - `transactions.creditorEndpoint.customerData.address.place` (string)
    The part of an address which refers to the name of some territorial zone (like an island or square) instead of a street. It should not be included together with street.
    Example: "Arnswalder Platz"

  - `transactions.creditorEndpoint.customerData.address.postCode` (string)
    An identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
    Example: "10243"

  - `transactions.creditorEndpoint.customerData.address.province` (string)
    For Canada, uppercase two-letter postal abbreviations, e.g., BC, AB, ON, QC.
    Example: "BC"

  - `transactions.creditorEndpoint.customerData.address.state` (string)
    For the US, uppercase two-letter postal abbreviations, e.g., AK, CA, HI, NY, TX, WY.
    Example: "CA"

  - `transactions.creditorEndpoint.customerData.address.street` (string)
    the name of the respective street in which the dwelling or business is located or where mail is received.
    Example: "Hans-Otto-Strasse"

  - `transactions.creditorEndpoint.customerData.address.subdistrict` (string)
    A smaller, readily identifiable part of a district.
    Example: "Friedrichshain Nord"

  - `transactions.creditorEndpoint.customerData.address.suburb` (string)
    Suburbs and localities are the names of geographic subdivisions of urban areas in Australia.
    Example: "Altona Meadows Suburb"

  - `transactions.creditorEndpoint.customerData.legalNames` (array, required)
    The legal owner name for the creditor account.
    Example: "Mr John Arthur Smith"

  - `transactions.description` (string, required)
    The description of the transaction.
    Example: "Payment"

  - `transactions.id` (string, required)
    The transaction identifier; transaction id.
    Example: "tt:83KiRJuXmEDV5m2b8ZvLGE91ELf7PPw5BaDab98kMguu:3VMczyq7r7b6HwC"

  - `transactions.metadata` (object)
    The bank-defined data associated with the account.

  - `transactions.providerTransactionDetails` (object)
    Specific information regarding the bank required by the respective Open Banking API standard adopted.

  - `transactions.providerTransactionDetails.budapestApiTransactionDetails` (object)
    Provider transaction details required under the Budapest Bank API standards.

  - `transactions.providerTransactionDetails.budapestApiTransactionDetails.creditorAccount` (object)
    The unique provider account identifier required under the Budapest Bank API standards.

  - `transactions.providerTransactionDetails.budapestApiTransactionDetails.creditorAccount.iban` (string)
    The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters.
    Example: "GB29NWBK60161331926819"

  - `transactions.providerTransactionDetails.budapestApiTransactionDetails.creditorName` (string)
    The name of the creditor/payee.
    Example: "ACME Company"

  - `transactions.providerTransactionDetails.budapestApiTransactionDetails.debtorAccount` (object)
    The unique provider account identifier required under the Budapest Bank API standards.

  - `transactions.providerTransactionDetails.budapestApiTransactionDetails.debtorAccount.iban` (string)
    The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters.
    Example: "GB29NWBK60161331926819"

  - `transactions.providerTransactionDetails.budapestApiTransactionDetails.debtorName` (string)
    The name of the debtor/payer.
    Example: "John Smith"

  - `transactions.providerTransactionDetails.budapestApiTransactionDetails.transactionCategory` (string)
    The category for the transaction, e.g., Debit, Credit.
    Example: "Credit"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails` (object)
    Provider transaction details required under the CMA9 API standard.

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAccount` (object)
    Specifies the payee's account with the creditor.

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAccount.accountIdentification` (string)
    The payee's creditor account id or number.

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAccount.creditorName` (string)
    The name of the payee listed for the creditor account.

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAccount.schemeName` (string)
    The creditor-defined recurring payment scheme name.
    Example: "Purchase instalment plan"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAccount.secondaryIdentification` (string)
    Secondary identification required for the transaction.

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAgent` (object)
    The unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAgent.creditorAgentAddress` (object)
    Specifies the recipient's delivery address details.

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAgent.creditorAgentAddress.addressLine` (array)
    Specifies the delivery address using multiple lines, as necessary.
    Example: ["Flat 2, The Red Lodge, 1 High Street"]

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAgent.creditorAgentAddress.addressType` (string)
    Specifies the type of address.
    Enum: "INVALID_ADDRESS_TYPE", "BUSINESS", "CORRESPONDENCE", "DELIVERYTO", "MAILTO", "POBOX", "POSTAL", "RESIDENTIAL", "STATEMENT"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAgent.creditorAgentAddress.buildingNumber` (string)
    The building number within the delivery address.
    Example: "1"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAgent.creditorAgentAddress.country` (string)
    Two-letter country code in upper case (ISO 3166-1 alpha-2).
    Example: "GB"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAgent.creditorAgentAddress.countrySubDivision` (array)
    Identifies a subdivision of a country; for instance, a state, region, or county.
    Example: ["North Yorkshire"]

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAgent.creditorAgentAddress.department` (string)
    This OBIE specification maps to house number.
    Example: "1"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAgent.creditorAgentAddress.postCode` (string)
    An identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
    Example: "YO62 5JB"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAgent.creditorAgentAddress.streetName` (string)
    The name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received.
    Example: "High Street"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAgent.creditorAgentAddress.subDepartment` (string)
    This OBIE specification maps to flats.
    Example: "Flat 2"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAgent.creditorAgentAddress.townName` (string)
    The name of a built-up area with defined boundaries and a local government.
    Example: "York"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAgent.creditorAgentName` (string)
    The name of financial institution servicing an account for the creditor.
    Example: "Creditor bank"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAgent.identification` (string)
    The unique identifier for financial institution servicing an account for the creditor.
    Example: "98765432"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.creditorAgent.schemeName` (any)
    The creditor-defined recurring payment scheme name.
    Example: "Purchase instalment plan"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAccount` (object)
    The source account information for the payment, the payer's bank account.

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAccount.accountIdentification` (string)
    The payer's debtor account id or number.

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAccount.cardInstrument` (object)
    Card instrument details required under the CMA9 API standard.

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAccount.cardInstrument.accountIdentification` (string)
    Example: "a:J72REftaRoiaDYRDU7M9FDgf8jeh3eqek9DvKeyBWbuA:3VMczyq7r7b6HwC"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAccount.cardInstrument.authorizationType` (string)

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAccount.cardInstrument.cardSchemeName` (string)

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAccount.cardInstrument.name` (string)

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAccount.debtorName` (string)
    The name of the payee listed for the creditor account.

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAccount.schemeName` (string)
    The creditor-defined recurring payment scheme name.
    Example: "Purchase instalment plan"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAccount.secondaryIdentification` (string)
    Additional identification required.

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAgent` (object)
    The unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme.

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAgent.debtorAgentAddress` (object)
    Specifies the recipient's delivery address details.

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAgent.debtorAgentAddress.addressLine` (array)
    Specifies the delivery address using multiple lines, as necessary.
    Example: ["Flat 2, The Red Lodge, 1 High Street"]

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAgent.debtorAgentAddress.addressType` (string)
    Specifies the type of address.
    Enum: "INVALID_ADDRESS_TYPE", "BUSINESS", "CORRESPONDENCE", "DELIVERYTO", "MAILTO", "POBOX", "POSTAL", "RESIDENTIAL", "STATEMENT"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAgent.debtorAgentAddress.buildingNumber` (string)
    The building number within the delivery address.
    Example: "1"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAgent.debtorAgentAddress.country` (string)
    Two-letter country code in upper case (ISO 3166-1 alpha-2).
    Example: "GB"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAgent.debtorAgentAddress.countrySubDivision` (array)
    Identifies a subdivision of a country; for instance, a state, region, or county.
    Example: ["North Yorkshire"]

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAgent.debtorAgentAddress.department` (string)
    This OBIE specification maps to house number.
    Example: "1"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAgent.debtorAgentAddress.postCode` (string)
    An identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
    Example: "YO62 5JB"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAgent.debtorAgentAddress.streetName` (string)
    The name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received.
    Example: "High Street"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAgent.debtorAgentAddress.subDepartment` (string)
    This OBIE specification maps to flats.
    Example: "Flat 2"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAgent.debtorAgentAddress.townName` (string)
    The name of a built-up area with defined boundaries and a local government.
    Example: "York"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAgent.debtorAgentName` (string)
    The name of financial institution servicing an account for the debtor.
    Example: "Debtor bank."

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAgent.identification` (string)
    The unique identifier for financial institution servicing an account for the debtor.

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.debtorAgent.schemeName` (string)
    The creditor-defined recurring payment scheme name.
    Example: "Purchase instalment plan"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.merchantDetails` (object)

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.merchantDetails.merchantCategoryCode` (string)
    The category code conforming to ISO 18245, relating to the type of services or goods provided by the merchant. A list of codes can be purchased here."
    Example: "5699-V"

  - `transactions.providerTransactionDetails.cma9ApiTransactionDetails.merchantDetails.merchantName` (string)
    The name of the merchant.
    Example: "Merchants R US"

  - `transactions.providerTransactionDetails.czechApiTransactionDetails` (object)
    Provider transaction details required under the Czech Standard for Open Banking.

  - `transactions.providerTransactionDetails.czechApiTransactionDetails.creditorAccount` (object)
    The unique provider account identifier required under the Czech Standard for Open Banking.

  - `transactions.providerTransactionDetails.czechApiTransactionDetails.creditorAccount.iban` (string)
    The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters.
    Example: "GB29NWBK60161331926819"

  - `transactions.providerTransactionDetails.czechApiTransactionDetails.creditorAccount.bban` (string)
    Represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers.
    Example: "NWBK60161331926819"

  - `transactions.providerTransactionDetails.czechApiTransactionDetails.creditorName` (string)
    The name of the creditor/payee.

  - `transactions.providerTransactionDetails.czechApiTransactionDetails.debtorAccount` (object)
    The unique provider account identifier required under the Czech Standard for Open Banking.

  - `transactions.providerTransactionDetails.czechApiTransactionDetails.debtorAccount.iban` (string)
    The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters.
    Example: "GB29NWBK60161331926819"

  - `transactions.providerTransactionDetails.czechApiTransactionDetails.debtorAccount.bban` (string)
    Represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers.
    Example: "NWBK60161331926819"

  - `transactions.providerTransactionDetails.czechApiTransactionDetails.debtorName` (string)
    The name of the debtor/payer.

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails` (object)
    Provider transaction details required under the NextGenPSD2 standard.

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.additionalInformation` (string)
    Additional bank-provided information about the transaction.
    Example: "Additional bank information"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.domain` (object)
    Bank transaction code using the sub-elements of the structured code defined by ISO 20022. It concatenates the three ISO 20022 Codes: Domain Code, Family Code, and SubFamiliy Code with hyphens, resulting in 'DomainCode'-'FamilyCode'-'SubFamilyCode'; e.g., "PMNT-RDDT-ESDD".

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.domain.code` (string)
    The domain code.
    Example: "PMNT"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.domain.familyCode` (string)
    The family code.
    Example: "RCDT"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.domain.subFamilyCode` (string)
    The sub-family code.
    Example: "ESCT"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.checkId` (string)
    The identifier for the electronic check, where applicable.
    Example: "4vn6aDyMiwBYbP"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.creditorAccount` (object)
    The unique provider account identifier required under the NextGenPSD2 standard.

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.creditorAccount.bban` (string)
    Represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length; 10 to 30 characters comprising the bank code (including the account number) and a checksum key. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers.
    Example: "NWBK60161331926819"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.creditorAccount.currency` (string)
    The ISO 4217 three letter currency code.
    Example: "EUR"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.creditorAccount.iban` (string)
    The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters.
    Example: "GB29NWBK60161331926819"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.creditorAccount.maskedPan` (string)
    The masked primary account number; tokenised identification for data protection.

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.creditorAccount.msisdn` (string)
    The Mobile Station International Subscriber Director Number (MSISDN) is the user's mobile phone number, used as a unique identifier to enable routing of voice and SMS traffic to and from a specific subscription/device on a wireless/mobile network. It's composed of the country code and the national destination code. Ensure you remove the + sign and any 0 before the mobile number.
    Example: "447949123456"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.creditorAccount.pan` (string)
    The primary account number. The card identifier found on payment cards, such as credit cards and debit cards, as well as stored-value cards, gift cards and other similar card, sometimes referred to as a bank card number.
    Example: "4658552288550023"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.creditorId` (string)
    The creditor/payee identifier provided by the bank.
    Example: "4vn6aDyMiwBYbP"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.creditorName` (string)
    The name of the creditor/payee.
    Example: "ACME Company"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.currencyExchange` (array)
    The currency exchange rate.

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.currencyExchange.contractIdentification` (string)
    Identifies the forward or spot exchange contract.

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.currencyExchange.exchangeRate` (string)
    The rate of exchange between the sourceCurrencyand the targetCurrency.

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.currencyExchange.quotationDate` (string)
    The date of the FX quote, in ISO 8601 format.
    Example: "2022-04-05T17:00:00.000Z"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.currencyExchange.sourceCurrency` (string)
    The ISO 4217 three letter currency code.
    Example: "EUR"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.currencyExchange.targetCurrency` (string)
    The ISO 4217 three letter currency code.
    Example: "EUR"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.currencyExchange.unitCurrency` (string)
    The price of one currency expressed in terms of another currency.
    Example: "1.4 to 1."

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.debtorAccount` (object)
    The unique provider account identifier required under the NextGenPSD2 standard.

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.debtorAccount.bban` (string)
    Represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length; 10 to 30 characters comprising the bank code (including the account number) and a checksum key. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers.
    Example: "NWBK60161331926819"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.debtorAccount.currency` (string)
    The ISO 4217 three letter currency code.
    Example: "EUR"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.debtorAccount.iban` (string)
    The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters.
    Example: "GB29NWBK60161331926819"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.debtorAccount.maskedPan` (string)
    The masked primary account number; tokenised identification for data protection.

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.debtorAccount.msisdn` (string)
    The Mobile Station International Subscriber Director Number (MSISDN) is the user's mobile phone number, used as a unique identifier to enable routing of voice and SMS traffic to and from a specific subscription/device on a wireless/mobile network. It's composed of the country code and the national destination code. Ensure you remove the + sign and any 0 before the mobile number.
    Example: "447949123456"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.debtorAccount.pan` (string)
    The primary account number. The card identifier found on payment cards, such as credit cards and debit cards, as well as stored-value cards, gift cards and other similar card, sometimes referred to as a bank card number.
    Example: "4658552288550023"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.debtorName` (string)
    The name of the debtor/payer.
    Example: "John Smith"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.endToEndId` (string)
    A short reference field to share an invoice or receipt number for your records; this reference is important to the debtor (could be an internal reference ID against the transaction) but it Is NOT the reference information that will be primarily populated on the statement of the creditor (beneficiary).
    Example: "6aDyMiwB"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.entryReference` (string)
    The identification of the transaction referencing delta function on an application level; same id used within camt.05x messages.
    Example: "72REftaRoiaDYRDU"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.mandateId` (string)
    The identifier for mandates; e.g., a SEPA Mandate id.
    Example: "DE452399865089"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.purposeCode` (string)
    The ISO 20022 external purpose code. Purpose Codes are four letter codes which are carried across the payment chain, providing information to all users in the payments chain to indicate the reason a payment is being made. Purpose Codes are one of the policy areas of Enhanced Data that can deliver the benefits of the ISO 20022 payment messaging standard. CASH - CashManagementTransferCORT - TradeSettlementPaymentDVPM - DeliveryAgainstPaymentINTC - IntraCompanyPaymentTREA - TreasuryPaymentSUPP - SupplierPayment"
    Enum: "CASH", "CORT", "DVPM", "INTC", "TREA", "SUPP"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.remittanceInformationStructured` (string)
    Structured remittance information; a reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance.
    Example: "REf:taRoiaDY34DU"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.ultimateCreditor` (string)
    The ultimate party to which the transfer is due.
    Example: "ACME GmbH"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.ultimateDebtor` (string)
    The ultimate party that owes that owes money to the (ultimate) creditor.
    Example: "John Smith"

  - `transactions.providerTransactionDetails.nextGenPsd2TransactionDetails.valueDate` (string)
    The date, in ISO 8601 format, when funds are posted to an account and available for immediate use.
    Example: "2022-03-27T17:00:00.000Z"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails` (object)
    The provider transaction details required under the Polish API standard.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.accountBaseCurrency` (string)
    The ISO 4217 three letter currency code for the account's currency.
    Example: "EUR"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.auxData` (object)
    The bank-defined auxiliary data associated with the account.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.baseCurrency` (string)
    The ISO 4217 three letter currency code for the transaction's currency.
    Example: "EUR"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.cardInfo` (object)
    The information about the card used in/for the transaction.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.cardInfo.cardHolder` (string)
    The name of the cardholder.
    Example: "Piotr Brama"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.cardInfo.cardNumber` (string)
    The card account number.
    Example: "5687243201834817"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.currencyDate` (string)
    The transaction currency valuation date.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.holdExpirationDate` (string)
    The date the bank hold expires, in ISO 8601 format.
    Example: "2022-11-12T17:00:00.000Z"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.initiator` (object)
    Doing Business As (DBA) and/or other names and addresses of the company.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.initiator.value` (array)
    The bank-defined name and postal address.
    Example: ["ACME Business Ltd, 299 Zywiecka, Gdansk"]

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.mcc` (string)
    The code for each transaction or operation performed by card.
    Example: "5699-V"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.postTransactionBalance` (string)
    The account balance after the transaction.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.recipient` (object)
    Information about the recipient.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.recipient.accountMassPayment` (string)
    The settlement account number of the recipient/settlement account name.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.recipient.accountNumber` (string)
    The recipient's account number.
    Example: 87654321

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.recipient.bank` (object)
    Specifies information about the bank itself.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.recipient.bank.address` (array)
    The physical/mailing address of the bank.
    Example: "45, Torunska, Gdansk"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.recipient.bank.bicOrSwift` (string)
    The standard format for business identifier codes (BIC), used to identify banks and financial institutions globally.
    Example: "HBUKGB7F261"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.recipient.bank.code` (string)
    The bank code for foreign transfers.
    Example: "BKAFEWFK564"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.recipient.bank.countryCode` (string)
    Two-letter country code in upper case (ISO 3166-1 alpha-2).
    Example: "PL"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.recipient.bank.name` (string)
    The official name of the bank corresponding to its SWIFT/BIC code.
    Example: "Polska Bank"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.recipient.nameAddress` (object)
    Doing Business As (DBA) and/or other names and addresses of the company.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.recipient.nameAddress.value` (array)
    The bank-defined name and postal address.
    Example: ["ACME Business Ltd, 299 Zywiecka, Gdansk"]

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.rejectionDate` (string)
    The date, in ISO 8601 format, when the transaction was rejected.
    Example: "2022-10-23T17:00:00.000Z"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.rejectionReason` (string)
    The reason the transaction was rejected.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.sender` (object)
    Information about the recipient.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.sender.accountMassPayment` (string)
    The settlement account number of the recipient/settlement account name.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.sender.accountNumber` (string)
    The recipient's account number.
    Example: 87654321

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.sender.bank` (object)
    Specifies information about the bank itself.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.sender.bank.address` (array)
    The physical/mailing address of the bank.
    Example: "45, Torunska, Gdansk"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.sender.bank.bicOrSwift` (string)
    The standard format for business identifier codes (BIC), used to identify banks and financial institutions globally.
    Example: "HBUKGB7F261"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.sender.bank.code` (string)
    The bank code for foreign transfers.
    Example: "BKAFEWFK564"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.sender.bank.countryCode` (string)
    Two-letter country code in upper case (ISO 3166-1 alpha-2).
    Example: "PL"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.sender.bank.name` (string)
    The official name of the bank corresponding to its SWIFT/BIC code.
    Example: "Polska Bank"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.sender.nameAddress` (object)
    Doing Business As (DBA) and/or other names and addresses of the company.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.sender.nameAddress.value` (array)
    The bank-defined name and postal address.
    Example: ["ACME Business Ltd, 299 Zywiecka, Gdansk"]

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.taxInfo` (object)
    The data for a tax transfer to the Tax Office or Customs Chamber.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.taxInfo.formCode` (string)
    The data for a tax transfer to the Tax Office or Customs Chamber.
    Example: "49DtA9CoF9qYzh77FA9nVrCn2jia:5zKtXEAq"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.taxInfo.obligationId` (string)
    The identifier of the liability from which the tax is due; e.g., decision, executive title, resolution.
    Example: "DECISION"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.taxInfo.payerInfo` (object)
    Information about the tax payer.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.taxInfo.payerInfo.payerId` (string)
    The payer's tax id.
    Example: "444433332211"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.taxInfo.payerInfo.payerIdType` (string)
    The type of tax payer id.
    Enum: "N", "P", "R", "1", "2", "3"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.taxInfo.periodId` (string)
    The tax period number.
    Example: "11"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.taxInfo.periodType` (string)
    The tax period type.
    Example: "Month"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.taxInfo.year` (integer)
    The tax year (YYYY).
    Example: 2022

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.tppName` (string)
    The name of the third-party provider.
    Example: "Mario's Pizzas"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.tppTransactionId` (string)
    The TPP's unique transaction Identifier.
    Example: "esaWvvr4l32iaDRqvrekkfwe212vsfvkcddEaVFaVR:4DVLaMVWER4VC6b"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.tradeDate` (string)
    The date of the transaction operation, in ISO 8601 format.
    Example: "2022-11-30T17:00:00.000Z"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.transactionRate` (array)

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.transactionRate.fromCurrency` (string)
    The ISO 4217 three letter currency code for the convert-from currency.
    Example: "EUR"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.transactionRate.rate` (number)
    The currency exchange rate.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.transactionRate.toCurrency` (string)
    The ISO 4217 three letter currency code for the convert-to currency.
    Example: "EUR"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.transactionType` (string)
    The type of transaction.
    Enum: "CREDIT", "DEBIT"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.usedPaymentInstrumentId` (string)
    The unique identifier of the payment instrument used to execute the transaction/payment instrument id.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.zusInfo` (object)
    Data information for transfers to ZUS.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.zusInfo.contributionId` (string)
    The declaration number/contribution identifier.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.zusInfo.contributionPeriod` (string)
    The declaration period/contribution period in MMYYYY format.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.zusInfo.contributionType` (string)
    The contribution type.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.zusInfo.obligationId` (string)
    The execution title number/obligation identifier or number.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.zusInfo.payerInfo` (object)
    The information associated with payer social security; i.e., Polish Security Institution (ZUS).

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.zusInfo.payerInfo.additionalPayerId` (string)
    The payer's additional identification number.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.zusInfo.payerInfo.additionalPayerIdType` (string)
    The type of additional payer id.

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.zusInfo.payerInfo.nip` (string)
    The payer's tax identification number.
    Example: "444433332211"

  - `transactions.providerTransactionDetails.polishApiTransactionDetails.zusInfo.paymentTypeId` (string)
    The payment type identifier.

  - `transactions.providerTransactionDetails.slovakApiTransactionDetails` (object)
    Provider transaction details required under the Slovak Banking API Standard.

  - `transactions.providerTransactionDetails.slovakApiTransactionDetails.creditorAccount` (object)
    Information about the payee/creditor's account.

  - `transactions.providerTransactionDetails.slovakApiTransactionDetails.creditorAccount.iban` (string)
    The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters.
    Example: "GB29NWBK60161331926819"

  - `transactions.providerTransactionDetails.slovakApiTransactionDetails.creditorAccount.bban` (string)
    Represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers.
    Example: "NWBK60161331926819"

  - `transactions.providerTransactionDetails.slovakApiTransactionDetails.creditorName` (string)
    The name of creditor/payee.

  - `transactions.providerTransactionDetails.slovakApiTransactionDetails.debtorAccount` (object)
    Information about the payer/debtor's account.

  - `transactions.providerTransactionDetails.slovakApiTransactionDetails.debtorAccount.iban` (string)
    The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters.
    Example: "GB29NWBK60161331926819"

  - `transactions.providerTransactionDetails.slovakApiTransactionDetails.debtorAccount.bban` (string)
    Represents a country-specific bank account number. The BBAN is the last part of the IBAN when used for international funds transfers. Every country has its own specific BBAN format and length. At present, there is no common EU or other standard unifying the BBAN. This is why IBAN was introduced to standardise international bank transfers.
    Example: "NWBK60161331926819"

  - `transactions.providerTransactionDetails.slovakApiTransactionDetails.debtorName` (string)
    The name of the debtor/payer.

  - `transactions.providerTransactionDetails.stetTransactionDetails` (object)
    The provider account details required under the French PSD2 API standard.

  - `transactions.providerTransactionDetails.stetTransactionDetails.creditorAccount` (object)
    Information about the payee/creditor's account.

  - `transactions.providerTransactionDetails.stetTransactionDetails.creditorAccount.iban` (string)
    The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters.
    Example: "GB29NWBK60161331926819"

  - `transactions.providerTransactionDetails.stetTransactionDetails.creditorName` (string)
    The name of creditor/payee.

  - `transactions.providerTransactionDetails.stetTransactionDetails.debtorAccount` (object)
    Information about the payer/debtor's account.

  - `transactions.providerTransactionDetails.stetTransactionDetails.debtorAccount.iban` (string)
    The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. It consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters.
    Example: "GB29NWBK60161331926819"

  - `transactions.providerTransactionDetails.stetTransactionDetails.debtorName` (string)
    The name of the debtor/payer.

  - `transactions.providerTransactionDetails.stetTransactionDetails.entryReference` (string)
    The technical incremental identification of the transaction for reconciliation by the TPP.

  - `transactions.providerTransactionDetails.stetTransactionDetails.transactionDate` (string)
    For card transaction - date of the commercial transactionfor credit transfer - acquiring date of the transactionfor direct debit - receiving date of the transaction

  - `transactions.providerTransactionDetails.stetTransactionDetails.valueDate` (string)
    The value date of the transaction on the account.
    Example: "2023-08-11"

  - `transactions.status` (string, required)
    Filters by transaction status.  PROCESSING – This status indicates that the transaction is in process and that the final status has not been received from the bank. SUCCESS – This status indicates that successful payment initiation has been received from the bank. Settlement might not be complete. INITIATED – This status is set when the previous status has remained as PROCESSING for 30 days and cannot be updated. The transaction has been initiated but the result is unknown. This is the final status and will not get updated later because Token.io has stopped polling the bank. This status is also returned in a two-step payment flow in the event that a user’s request has been authorized at the bank but the payment confirmation has subsequently failed. PENDING – This status indicates that the user has successfully completed the authorization process at the bank and the transfer is pending redemption. This status is only relevant for two-step payment flows. PENDING_EXTERNAL_AUTHORIZATION – This status indicates that the user has been sent to the bank to complete the authorization process. If not completed within the allowed timeframe (usually around 15 mins, but there are variations between banks) the transaction will expire and transition to FAILURE_EXPIRED. This status is only relevant for 1-step payment flows. FAILURE_GENERIC – This status usually indicates a technical failure. Possibly, a failure callback was received from the bank, with no transaction status and no further information. FAILURE_PERMISSION_DENIED – This status indicates that the user has been denied authorization at the bank This status is only relevant for two-step payment flows. FAILURE_CANCELED – This status indicates that the payment initiation has been cancelled before execution. FAILURE_EXPIRED – This status indicates that the user did not complete the authorization process within the allowed timeframe (usually around 15 mins, but there are variations between banks) and the payment has expired. FAILURE_INSUFFICIENT_FUNDS – This status indicates that the payment initiation request has been rejected due to insufficient funds. FAILURE_DECLINED – This status indicates that the payment initiation has been rejected by the bank. SETTLEMENT_IN_PROGRESS – This status is provided when a Token.io settlement account is used as the beneficiary for the payment, and replaces the payment initiation status. Token.io is waiting for the payment to reach the payee bank. No action is required; await the next step, e.g., Token.io sends a webhook with the status update, or a polling call. The status will change to SETTLEMENT_IN_PROGRESS soon after Token.io receives the final status from the debtor bank. SETTLEMENT_COMPLETED – This status is provided when a Token.io settlement account is used as the beneficiary for the payment, and replaces the payment initiation status. The payment has reached the payee bank and Token.io has matched the transaction in the TPP’s settlement account to the initiated payment. For instant payments, SETTLEMENT_COMPLETED will be achieved within 30-45 minutes from payment initiation, at the latest. For non-instant payments, the time to reach SETTLEMENT_COMPLETED will depend on the clearing period for the payment. SETTLEMENT_INCOMPLETE – This status is provided when a Token.io settlement account is used as the beneficiary for the payment, and replaces the payment initiation status. Reconciliation has failed. This happens when Token.io doesn't find the corresponding transaction in the TPP’s settlement account automatically.During settlement of a settlement accounts payment, the status update job will run first for up to 30 days. Payment will then enter into a 'final' status, normally SUCCESS.Once the status update job has run, the reconciliation job looks for matching inbound payments.For SEPA payments:if a matching inbound payment is found within 15 days of the final payment status update -> SETTLEMENT_COMPLETEDif no matching inbound payment is found within 15 days of the final payment status update -> SETTLEMENT_INCOMPLETEFor SEPA Instant payments:if a matching inbound payment is found within 1 day of the final payment status update -> SETTLEMENT_COMPLETEDif no matching inbound payment is found within 1 day of the final payment status update -> SETTLEMENT_INCOMPLETE
    Enum: "PROCESSING", "SUCCESS", "INITIATED", "PENDING", "PENDING_EXTERNAL_AUTHORIZATION", "FAILURE_GENERIC", "FAILURE_PERMISSION_DENIED", "FAILURE_CANCELED", "FAILURE_EXPIRED", "FAILURE_INSUFFICIENT_FUNDS", "FAILURE_DECLINED", "SETTLEMENT_IN_PROGRESS", "SETTLEMENT_COMPLETED", "SETTLEMENT_INCOMPLETE"

  - `transactions.tokenId` (string, required)
    Identifies the authorization token for the transfer.
    Example: "tt:8zK1dic95omjWb72gvc3z3ELKbTNfnGd89MbDnM73er4:ZhBVAJSH8DeU1"

  - `transactions.tokenTransferId` (string)
    The transfer identifier for the payment.
    Example: "t:2UhwCZ3BMaEcAUK8bZdukor7NL4tH6TBuu6aJMp5KKfX:5zKcENpV"

  - `transactions.type` (string, required)
    Specifies the type of transaction.
    Enum: "INVALID_TYPE", "DEBIT", "CREDIT"

## Response 400 fields (application/json):

  - `error` (object)
    The request does not have valid authentication credentials needed to perform the operation.

  - `error.message` (string)
    A description of the error.
    Example: "This is a description of the error."

  - `error.tokenTraceId` (string)
    The trace identifier for the given call.
    Example: "5678912345"

## Response 401 fields (application/json):

  - `error` (object)
    The request does not have valid authentication credentials needed to perform the operation.

  - `error.message` (string)
    A description of the error.
    Example: "This is a description of the error."

  - `error.tokenTraceId` (string)
    The trace identifier for the given call.
    Example: "5678912345"

## Response 403 fields (application/json):

  - `error` (object, required)
    The error returned when the member is not authorized to perform the given operation: PermissionDenied. This error message will be accompanied by the reason from the bank. Typically this means the access token has expired and the user must re-authenticate with the bank.

  - `error.errorCode` (string, required)
    A textual error code categorising the error.
    Example: "InternalServerError"

  - `error.message` (string, required)
    A description of the error that occurred and a possible way to fix it.
    Example: "This is a description of the error."

  - `error.tokenTraceId` (string)
    The trace identifier for the given call.
    Example: "5678912345"

## Response 404 fields (application/json):

  - `error` (object, required)
    The error object returned when given payment cannot be found: ResourceNotFound.

  - `error.errorCode` (string, required)
    A textual error code categorising the error.
    Example: "InternalServerError"

  - `error.paymentId` (string, required)
    The requested entity, the paymentID, was not found.
    Example: "pm2:12345abcd:abcde"

  - `error.message` (string, required)
    A description of the error that occurred and a possible way to fix it.
    Example: "This is a description of the error."

  - `error.tokenTraceId` (string)
    The trace identifier for the given call.
    Example: "5678912345"

## Response 429 fields (application/json):

  - `error` (object, required)
    Resource exhausted. Too many requests.

  - `error.errorCode` (string, required)
    A textual error code categorising the error.
    Example: "InternalServerError"

  - `error.paymentId` (string, required)
    The maximum number of requests has been reached.
    Example: "Resource exhausted. Check quota."

  - `error.message` (string, required)
    A description of the error that occurred and a possible way to fix it.
    Example: "This is a description of the error."

  - `error.tokenTraceId` (string)
    The trace identifier for the given call.
    Example: "5678912345"

## Response 500 fields (application/json):

  - `error` (object)
    This could refer to either an error by the payment service provider or the bank. When the bank reports a 5xx error, "token-external-error": "true" is set as a header in the HTTP response, indicating that the "internal" error originates from the bank. When one of the payment service providers 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".

  - `error.errorCode` (string, required)
    This is a textual error code categorising the error.
    Example: "InternalServerError"

  - `error.message` (string, required)
    A description of the error.
    Example: "This is a description of the error."

  - `error.tokenTraceId` (string)
    The trace identifier for the given call.
    Example: "5678912345"

## Response 501 fields (application/json):

  - `error` (object, required)
    The operation was not implemented, supported or enabled by the bank.

  - `error.errorCode` (string, required)
    A textual error code categorising the error.
    Example: "InternalServerError"

  - `error.paymentId` (string, required)
    The operation was not implemented,supported or enabled by the bank.
    Example: "Not implemented."

  - `error.message` (string, required)
    A description of the error that occurred and a possible way to fix it.
    Example: "This is a description of the error."

  - `error.tokenTraceId` (string)
    The trace identifier for the given call.
    Example: "5678912345"

## Response 503 fields (application/json):

  - `error` (object, required)
    Service is unavailable, likely due to a transient condition; this is usually corrected with a retry.

  - `error.errorCode` (string, required)
    A textual error code categorising the error.
    Example: "InternalServerError"

  - `error.paymentId` (string, required)
    The service is unavailable, likely due to a transient condition; this is usually corrected with a retry.
    Example: "Unavailable"

  - `error.message` (string, required)
    A description of the error that occurred and a possible way to fix it.
    Example: "This is a description of the error."

  - `error.tokenTraceId` (string)
    The trace identifier for the given call.
    Example: "5678912345"

## Response 504 fields (application/json):

  - `error` (object, required)
    The deadline expired before the operation could complete.

  - `error.errorCode` (string, required)
    A textual error code categorising the error.
    Example: "InternalServerError"

  - `error.paymentId` (string, required)
    The deadline expired before the operation could complete.
    Example: "Deadline exceeded."

  - `error.message` (string, required)
    A description of the error that occurred and a possible way to fix it.
    Example: "This is a description of the error."

  - `error.tokenTraceId` (string)
    The trace identifier for the given call.
    Example: "5678912345"