---
title: "Get a settlement account transaction"
method: GET
path: "/virtual-accounts/{accountId}/transactions/{providerPaymentId}"
tags: ["Settlement Accounts"]
---

# Get a settlement account transaction

`GET /virtual-accounts/{accountId}/transactions/{providerPaymentId}`

The `GET /virtual-accounts/{accountId}/transactions/{providerPaymentId}` endpoint retrieves information for a specific transaction in a given settlement account.

## Path parameters

- `accountId` string, required
- `providerPaymentId` string, required

## Query parameters

- `onBehalfOfId` string

## Response `200`

Successful response

- GetVirtualAccountTransactionResponse
  - `transaction` VirtualAccountTransaction — Information about the requested transaction.
    - `amount` object — The balance currency and value.
      - `currency` string, required — The <a href="https://www.iso.org/iso-4217-currency-codes.html" target="_blank">ISO 4217</a> three letter currency code.
      - `value` string, required — The transaction amount with up to four digits after the decimal point.
    - `providerPaymentId` string — The settlement account provider-assigned unique transaction identifier.
    - `createdDateTime` string — The date and time this refund object was created (in <a href="https://www.iso.org/iso-8601-date-and-time-format.html" target="_blank">ISO 8601</a> format).
    - `description` string — The description of the transaction.
    - `transactionType` 'INVALID_TYPE' | 'DEBIT' | 'CREDIT' — Specifies the type of transaction.
    - `localInstrument` 'SEPA' | 'SEPA_INSTANT' | 'FASTER_PAYMENTS' — The bank's payment service to be used for making a payment.
    - `debtor` union — Debtor information. Provide either an Account on File OR full Debtor Account details. These two modes are mutually exclusive.
      - union
        - object — SEPA account details where the iban is required and the bic is optional.
          - `iban` string, required — 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.
          - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, is the 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 can be either 8 or 11 characters long.
          - `name` string, required — The debtor’s account owner name.
          - `ultimateDebtorName` string — The ultimate debtor’s name.
          - `address` Address — Address
            - `addressLine` string[]
            - `streetName` string — Street number
            - `buildingNumber` string — Building number
            - `postCode` string — Post Code
            - `townName` string — Town name
            - `state` string — State
            - `district` string — The district.
            - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - object — SEPA Instant account details where the iban is required and the bic is optional.
          - `iban` string, required — 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.
          - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, is the 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 can be either 8 or 11 characters long.
          - `name` string, required — The debtor’s account owner name.
          - `ultimateDebtorName` string — The ultimate debtor’s name.
          - `address` Address — Address
            - `addressLine` string[]
            - `streetName` string — Street number
            - `buildingNumber` string — Building number
            - `postCode` string — Post Code
            - `townName` string — Town name
            - `state` string — State
            - `district` string — The district.
            - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - object — A UK or Irish account where the sort code and account number are required.
          - `accountNumber` string, required — The unique identifier for the bank account in the UK or Ireland.
          - `sortCode` string, required — The number assigned to a branch of a bank, typically containing six digits and most commonly used in the UK and Ireland.
          - `name` string, required — The debtor’s account owner name.
          - `ultimateDebtorName` string — The ultimate debtor’s name.
          - `address` Address — Address
            - `addressLine` string[]
            - `streetName` string — Street number
            - `buildingNumber` string — Building number
            - `postCode` string — Post Code
            - `townName` string — Town name
            - `state` string — State
            - `district` string — The district.
            - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - object — Polish account details where the iban is required and the bic is optional.
          - `iban` string, required — 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.
          - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, 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."
          - `name` string, required — The debtor’s account owner name.
          - `ultimateDebtorName` string — The ultimate debtor’s name.
          - `address` Address — Address
            - `addressLine` string[]
            - `streetName` string — Street number
            - `buildingNumber` string — Building number
            - `postCode` string — Post Code
            - `townName` string — Town name
            - `state` string — State
            - `district` string — The district.
            - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - object — Account details where the iban is required and the bic is optional.
          - `iban` string, required — 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.
          - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, 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."
          - `name` string, required — The debtor’s account owner name.
          - `ultimateDebtorName` string — The ultimate debtor’s name.
          - `address` Address — Address
            - `addressLine` string[]
            - `streetName` string — Street number
            - `buildingNumber` string — Building number
            - `postCode` string — Post Code
            - `townName` string — Town name
            - `state` string — State
            - `district` string — The district.
            - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - object — Account details where the bban is required and the bic is optional.
          - `bban` string, required — 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.
          - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, 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."
          - `name` string, required — The debtor’s account owner name.
          - `ultimateDebtorName` string — The ultimate debtor’s name.
          - `address` Address — Address
            - `addressLine` string[]
            - `streetName` string — Street number
            - `buildingNumber` string — Building number
            - `postCode` string — Post Code
            - `townName` string — Town name
            - `state` string — State
            - `district` string — The district.
            - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - object — Account details where the bban is required and the clearing number is optional.
          - `bban` string, required — 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.
          - `clearingNumber` string — The bank clearing number or BC number is a number used for the identification of financial institutions in Switzerland and Liechtenstein. Bank clearing numbers are connected to the Swiss Interbank Clearing and the EuroSIC system.
          - `name` string, required — The debtor’s account owner name.
          - `ultimateDebtorName` string — The ultimate debtor’s name.
          - `address` Address — Address
            - `addressLine` string[]
            - `streetName` string — Street number
            - `buildingNumber` string — Building number
            - `postCode` string — Post Code
            - `townName` string — Town name
            - `state` string — State
            - `district` string — The district.
            - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - object — Account details where the iban is required and the bic is optional.
          - `iban` string, required — 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.
          - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, 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."
          - `name` string, required — The debtor’s account owner name.
          - `ultimateDebtorName` string — The ultimate debtor’s name.
          - `address` Address — Address
            - `addressLine` string[]
            - `streetName` string — Street number
            - `buildingNumber` string — Building number
            - `postCode` string — Post Code
            - `townName` string — Town name
            - `state` string — State
            - `district` string — The district.
            - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - object — Account details where the bban is required and the bic is optional.
          - `bban` string, required — 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.
          - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, 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."
          - `name` string, required — The debtor’s account owner name.
          - `ultimateDebtorName` string — The ultimate debtor’s name.
          - `address` Address — Address
            - `addressLine` string[]
            - `streetName` string — Street number
            - `buildingNumber` string — Building number
            - `postCode` string — Post Code
            - `townName` string — Town name
            - `state` string — State
            - `district` string — The district.
            - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - object — Account details where the bban is required and the clearing number is optional.
          - `bban` string, required — 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.
          - `clearingNumber` string — The bank clearing number or BC number is a number used for the identification of financial institutions in Switzerland and Liechtenstein. Bank clearing numbers are connected to the Swiss Interbank Clearing and the EuroSIC system.
          - `name` string, required — The debtor’s account owner name.
          - `ultimateDebtorName` string — The ultimate debtor’s name.
          - `address` Address — Address
            - `addressLine` string[]
            - `streetName` string — Street number
            - `buildingNumber` string — Building number
            - `postCode` string — Post Code
            - `townName` string — Town name
            - `state` string — State
            - `district` string — The district.
            - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - object — Account details where the bankgiroNumber is required and the bic is optional.
          - `bankgiroNumber` string, required — The unique identifier for the bank account in Sweden (known in Swedish as Bankgironummer), it consists of 7 or 8 digits.
          - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, is the 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 can be either 8 or 11 characters long.
          - `name` string, required — The debtor’s account owner name.
          - `ultimateDebtorName` string — The ultimate debtor’s name.
          - `address` Address — Address
            - `addressLine` string[]
            - `streetName` string — Street number
            - `buildingNumber` string — Building number
            - `postCode` string — Post Code
            - `townName` string — Town name
            - `state` string — State
            - `district` string — The district.
            - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - object — Account details where the plusgiroNumber is required and the bic is optional.
          - `plusgiroNumber` string, required — The unique identifier for the Swedish money transaction system owned by <a href="https://www.nordea.com" target="blank">Nordea</a>.
          - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, 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."
          - `name` string, required — The debtor’s account owner name.
          - `ultimateDebtorName` string — The ultimate debtor’s name.
          - `address` Address — Address
            - `addressLine` string[]
            - `streetName` string — Street number
            - `buildingNumber` string — Building number
            - `postCode` string — Post Code
            - `townName` string — Town name
            - `state` string — State
            - `district` string — The district.
            - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
      - TokenizedAccountIdentifier
        - `tokenizedAccountId` string, required — Account on File identifier.
    - `creditor` union
      - object — SEPA account details where the iban is required and the bic is optional.
        - `iban` string, required — 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.
        - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, is the 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 can be either 8 or 11 characters long.
        - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts.
        - `ultimateCreditorName` string — The ultimate creditor's name.
        - `address` Address — Address
          - `addressLine` string[]
          - `streetName` string — Street number
          - `buildingNumber` string — Building number
          - `postCode` string — Post Code
          - `townName` string — Town name
          - `state` string — State
          - `district` string — The district.
          - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - `bankName` string — The creditor's bank name.
      - object — SEPA Instant account details where the iban is required and the bic is optional.
        - `iban` string, required — 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.
        - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, is the 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 can be either 8 or 11 characters long.
        - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts.
        - `ultimateCreditorName` string — The ultimate creditor's name.
        - `address` Address — Address
          - `addressLine` string[]
          - `streetName` string — Street number
          - `buildingNumber` string — Building number
          - `postCode` string — Post Code
          - `townName` string — Town name
          - `state` string — State
          - `district` string — The district.
          - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - `bankName` string — The creditor's bank name.
      - object — A UK or Irish account where the sort code and account number are required.
        - `accountNumber` string, required — The unique identifier for the bank account in the UK or Ireland.
        - `sortCode` string, required — The number assigned to a branch of a bank, typically containing six digits and most commonly used in the UK and Ireland.
        - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts.
        - `ultimateCreditorName` string — The ultimate creditor's name.
        - `address` Address — Address
          - `addressLine` string[]
          - `streetName` string — Street number
          - `buildingNumber` string — Building number
          - `postCode` string — Post Code
          - `townName` string — Town name
          - `state` string — State
          - `district` string — The district.
          - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - `bankName` string — The creditor's bank name.
      - object — Polish account details where the account number is required and the bic is optional.
        - `accountNumber` string, required — The payee's Elixir-registered bank account number.
        - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, is the 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 can be either 8 or 11 characters long.
        - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts.
        - `ultimateCreditorName` string — The ultimate creditor's name.
        - `address` Address — Address
          - `addressLine` string[]
          - `streetName` string — Street number
          - `buildingNumber` string — Building number
          - `postCode` string — Post Code
          - `townName` string — Town name
          - `state` string — State
          - `district` string — The district.
          - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - `bankName` string — The creditor's bank name.
      - object — Polish account details where the iban is required and the bic is optional.
        - `iban` string, required — 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.
        - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, 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."
        - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts.
        - `ultimateCreditorName` string — The ultimate creditor's name.
        - `address` Address — Address
          - `addressLine` string[]
          - `streetName` string — Street number
          - `buildingNumber` string — Building number
          - `postCode` string — Post Code
          - `townName` string — Town name
          - `state` string — State
          - `district` string — The district.
          - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - `bankName` string — The creditor's bank name.
      - object — Account details where the iban is required and the bic is optional.
        - `iban` string, required — 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.
        - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, 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."
        - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts.
        - `ultimateCreditorName` string — The ultimate creditor's name.
        - `address` Address — Address
          - `addressLine` string[]
          - `streetName` string — Street number
          - `buildingNumber` string — Building number
          - `postCode` string — Post Code
          - `townName` string — Town name
          - `state` string — State
          - `district` string — The district.
          - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - `bankName` string — The creditor's bank name.
      - object — Account details where the bban is required and the bic is optional.
        - `bban` string, required — 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.
        - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, 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."
        - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts.
        - `ultimateCreditorName` string — The ultimate creditor's name.
        - `address` Address — Address
          - `addressLine` string[]
          - `streetName` string — Street number
          - `buildingNumber` string — Building number
          - `postCode` string — Post Code
          - `townName` string — Town name
          - `state` string — State
          - `district` string — The district.
          - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - `bankName` string — The creditor's bank name.
      - object — Account details where the bban is required and the clearing number is optional.
        - `bban` string, required — 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.
        - `clearingNumber` string — The bank clearing number or BC number is a number used for the identification of financial institutions in Switzerland and Liechtenstein. Bank clearing numbers are connected to the Swiss Interbank Clearing and the EuroSIC system.
        - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts.
        - `ultimateCreditorName` string — The ultimate creditor's name.
        - `address` Address — Address
          - `addressLine` string[]
          - `streetName` string — Street number
          - `buildingNumber` string — Building number
          - `postCode` string — Post Code
          - `townName` string — Town name
          - `state` string — State
          - `district` string — The district.
          - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - `bankName` string — The creditor's bank name.
      - object — Account details where the iban and bban are required and the bic and clearing number are optional. This is ONLY allowed for an HP flow if there is no `bankId` provided in the initiation AND the currency is SEK or NOK.
        - `iban` string, required — 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.
        - `bban` string, required — 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.
        - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, 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."
        - `clearingNumber` string — The bank clearing number or BC number is a number used for the identification of financial institutions in Switzerland and Liechtenstein. Bank clearing numbers are connected to the Swiss Interbank Clearing and the EuroSIC system.
        - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts.
        - `ultimateCreditorName` string — The ultimate creditor's name.
        - `address` Address — Address
          - `addressLine` string[]
          - `streetName` string — Street number
          - `buildingNumber` string — Building number
          - `postCode` string — Post Code
          - `townName` string — Town name
          - `state` string — State
          - `district` string — The district.
          - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - `bankName` string — The creditor's bank name.
      - object — Account details where the iban is required and the bic is optional.
        - `iban` string, required — 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.
        - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, 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."
        - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts.
        - `ultimateCreditorName` string — The ultimate creditor's name.
        - `address` Address — Address
          - `addressLine` string[]
          - `streetName` string — Street number
          - `buildingNumber` string — Building number
          - `postCode` string — Post Code
          - `townName` string — Town name
          - `state` string — State
          - `district` string — The district.
          - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - `bankName` string — The creditor's bank name.
      - object — Account details where the bban is required and the bic is optional.
        - `bban` string, required — 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.
        - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, 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."
        - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts.
        - `ultimateCreditorName` string — The ultimate creditor's name.
        - `address` Address — Address
          - `addressLine` string[]
          - `streetName` string — Street number
          - `buildingNumber` string — Building number
          - `postCode` string — Post Code
          - `townName` string — Town name
          - `state` string — State
          - `district` string — The district.
          - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - `bankName` string — The creditor's bank name.
      - object — Account details where the bban is required and the clearing number is optional.
        - `bban` string, required — 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.
        - `clearingNumber` string — The bank clearing number or BC number is a number used for the identification of financial institutions in Switzerland and Liechtenstein. Bank clearing numbers are connected to the Swiss Interbank Clearing and the EuroSIC system.
        - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts.
        - `ultimateCreditorName` string — The ultimate creditor's name.
        - `address` Address — Address
          - `addressLine` string[]
          - `streetName` string — Street number
          - `buildingNumber` string — Building number
          - `postCode` string — Post Code
          - `townName` string — Town name
          - `state` string — State
          - `district` string — The district.
          - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - `bankName` string — The creditor's bank name.
      - object — Account details where the iban and bban are required and the bic and clearing number are optional. This is ONLY allowed for an HP flow if there is no `bankId` provided in the initiation AND the currency is SEK or NOK.
        - `iban` string, required — 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.
        - `bban` string, required — 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.
        - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, 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."
        - `clearingNumber` string — The bank clearing number or BC number is a number used for the identification of financial institutions in Switzerland and Liechtenstein. Bank clearing numbers are connected to the Swiss Interbank Clearing and the EuroSIC system.
        - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts.
        - `ultimateCreditorName` string — The ultimate creditor's name.
        - `address` Address — Address
          - `addressLine` string[]
          - `streetName` string — Street number
          - `buildingNumber` string — Building number
          - `postCode` string — Post Code
          - `townName` string — Town name
          - `state` string — State
          - `district` string — The district.
          - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - `bankName` string — The creditor's bank name.
      - object — Account details where the bankgiroNumber is required and the bic is optional.
        - `bankgiroNumber` string, required — The unique identifier for the bank account in Sweden (known in Swedish as Bankgironummer), it consists of 7 or 8 digits.
        - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, is the 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 can be either 8 or 11 characters long.
        - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts.
        - `ultimateCreditorName` string — The ultimate creditor's name.
        - `address` Address — Address
          - `addressLine` string[]
          - `streetName` string — Street number
          - `buildingNumber` string — Building number
          - `postCode` string — Post Code
          - `townName` string — Town name
          - `state` string — State
          - `district` string — The district.
          - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - `bankName` string — The creditor's bank name.
      - object — Account details where the plusgiroNumber is required and the bic is optional.
        - `plusgiroNumber` string, required — The unique identifier for the Swedish money transaction system owned by <a href="https://www.nordea.com" target="blank">Nordea</a>.
        - `bic` string — The Business Identifier Code (BIC), <a href="https://www.iso.org/standard/84108.html" target="_blank">ISO 9362</a>, 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."
        - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts.
        - `ultimateCreditorName` string — The ultimate creditor's name.
        - `address` Address — Address
          - `addressLine` string[]
          - `streetName` string — Street number
          - `buildingNumber` string — Building number
          - `postCode` string — Post Code
          - `townName` string — Town name
          - `state` string — State
          - `district` string — The district.
          - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - `bankName` string — The creditor's bank name.
      - object — The creditor settlement account details.
        - `virtualAccountId` string, required — The unique identifier for the settlement account. This field is mandatory for unregulated TPPs.
        - `name` string, required — The owner's name for the creditor account. This parameter is not required for settlement accounts.
        - `ultimateCreditorName` string — The ultimate creditor's name.
        - `address` Address — Address
          - `addressLine` string[]
          - `streetName` string — Street number
          - `buildingNumber` string — Building number
          - `postCode` string — Post Code
          - `townName` string — Town name
          - `state` string — State
          - `district` string — The district.
          - `country` string — Two-letter country code in upper case (ISO 3166-1 alpha-2).
        - `bankName` string — The creditor's bank name.
    - `refId` string — The TPP-generated reference identifier for the token. This is not to be confused with the `requestId`. The `refId` maps to the `tppRefId` in the bank's `consentRequest`. This is needed to match/verify the originating token request with the bank's consent request. <br/>We recommend that the `refId` should not contain special characters (the allowed characters are the 26-letter Latin alphabet, the numerical digits from 0-9 and the hyphen '-'). This field should not exceed 18 characters in length.
    - `transferId` string — The transfer identifier for the transaction.
    - `paymentId` string — The V2 payment identifier for the transaction.
    - `refundId` string — The refund payment identifier for the transaction.
    - `payoutId` string — The payout identifier for the transaction.

## Other responses

- `400` — The client specified an invalid argument
- `401` — The authorization information is missing or invalid
- `403` — Permission to access this endpoint is denied
- `404` — The requested entity, such as an account, was not found
- `429` — Too many requests
- `500` — An unexpected or internal server error
- `501` — The operation was not implemented
- `503` — Service is unavailable
- `504` — Gateway has timed out

---

[API](https://skmtc.net/token/apis/token-io-s-open-banking-api-for-tpps.md) · [All operations](https://skmtc.net/token/apis/token-io-s-open-banking-api-for-tpps/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/token/token-io-s-open-banking-api-for-tpps/revisions/5e8d6d2c24a1/schema)