openapi: 3.0.1 info: title: Token.io's Open Banking API for TPPs description: >- Token.io's Open Banking API

Token.io Support: support.token.io

The Token.io Open Banking API enables you to connect securely with banks for a range of services.

Using our API you can:
For more information see our developer documentation. version: v1.2.3.8 x-konfig-ignore: object-with-no-properties: true potential-incorrect-type: true servers: - url: https://api.token.io tags: - description: >- These endpoints provide authorized access to an authenticated user's virtual account information, managing settlement rules for virtual accounts and retrieving a list of payouts generated by settlement rules for virtual accounts. name: Virtual Accounts - BETA - description: These endpoints enable you to initiate Variable Recurring Payments (VRP). name: Variable Recurring Payments - description: >- These endpoints provide authorized access to an authenticated user's account information. name: Accounts - description: >- These endpoints allow you to handle registration, posting, and retrieval of refunds associated with original transaction account information. name: Refunds - BETA - description: >- These endpoints are for resellers using Token.io's licence to create, retrieve and delete sub-TPPs. name: Sub-TPPs - description: >- These endpoints enable you to make single immediate payments and future dated payments using the redirect flow, embedded flow and decoupled flow. name: Single Immediate Payments v2 - description: >- These endpoints allow you to submit new payment initiation requests and retrieve information about existing payments. name: Single Immediate Payments v1 - description: These endpoints allow you to make payouts. name: Payouts - BETA - description: >- These endpoints retrieve all tokens, a filtered list of tokens, or a specific token, as well as allowing you to cancel an existing token. name: Tokens - description: >- These endpoints configure, retrieve and remove webhooks. See Webhooks for more details. name: Webhooks - description: >- These endpoints allow you to initiate a v1 payment request or an AIS request, and retrieve the status of the request. name: Requests - description: >- These endpoints filter and fetch the list of Token.io-connected banks, get information on specific banks, and initiate authorization with user-selected banks. name: Banks v1 - description: >- These endpoints retrieve the current AIS and PIS status of Token.io-connected banks. name: Reports - description: >- This endpoint filters and fetches the list of Token.io-connected banks, gets information on specific banks, and initiates authorization with user-selected banks. name: Banks v2 - description: >- This end point should be used when the TPP receives a callback directly from the bank after authorization is completed. This endpoint is for both v1 and v2 requests. name: TSP paths: /accounts: get: tags: - Accounts summary: Get information for all accounts operationId: Accounts_getAllAccounts security: - BasicAuth: [] - Bearer: [] description: >- The `GET /accounts` endpoint retrieves information for all bank accounts. parameters: - description: >- 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. name: token-customer-ip-address in: header schema: type: string format: ipv4 required: false example: 172.16.254.1 responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetAccountsResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/AccountsGetAllAccountsResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /accounts/{accountId}: get: tags: - Accounts summary: Get account information operationId: Accounts_getInfo security: - BasicAuth: [] - Bearer: [] description: >- The `GET /accounts/{accountId}` endpoint retrieves the information for a specific bank account. parameters: - description: >- The system-generated, unique bank account id, which specifies the account for which the information is requested. name: accountId in: path required: true style: simple explode: false schema: type: string example: a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV - description: >- 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. name: token-customer-ip-address in: header schema: type: string format: ipv4 required: false example: 172.16.254.1 responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetAccountResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/AccountsGetInfoResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /account-balance: get: tags: - Accounts summary: Get account balances operationId: Accounts_getMultipleBalances security: - BasicAuth: [] - Bearer: [] description: >- The `GET /account-balance` endpoint retrieves the balances for multiple bank accounts. parameters: - description: >- 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. name: token-customer-ip-address in: header schema: type: string format: ipv4 required: false example: 172.16.254.1 - description: >- A comma-separated list of account ids for which you wish to retrieve account balances. name: accountId in: query required: false style: form explode: true schema: type: array items: type: string example: - a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV - a:9TFpwkcQmcsMbdjQcpdjfsEBosDw28503fAAGPEMF2MVF19hfk3nc - a:rtmv254gaskGLdkadQvdNesk2Y9ferbvpaom5mvepm0mv2nfGnaix responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetBalancesResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/AccountsGetMultipleBalancesResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /accounts/{accountId}/balance: get: tags: - Accounts summary: Get an account balance operationId: Accounts_getBalance security: - BasicAuth: [] - Bearer: [] description: >- The `GET /accounts/{accountId}/balance` endpoint retrieves the balance for a given bank account. parameters: - description: >- The unique bank account id, which specifies the account for which the information is requested. name: accountId in: path required: true style: simple explode: false schema: type: string - description: >- 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. name: token-customer-ip-address in: header schema: type: string format: ipv4 required: false example: 172.16.254.1 responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetBalanceResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/AccountsGetBalanceResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /accounts/{accountId}/standing-orders: get: tags: - Accounts summary: Get information for all standing orders operationId: Accounts_getStandingOrders security: - BasicAuth: [] - Bearer: [] description: >- The `GET /accounts/{accountId}/standing-orders` endpoint retrieves information for all standing orders in a given account, once consent has been given. parameters: - description: >- The unique bank account id, which specifies the account for which the information is requested. name: accountId in: path required: true schema: type: string - description: >- 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. name: page.offset in: query required: false style: form explode: true schema: type: string example: LerV6Jmex - description: The maximum number of records to return. This must be less than 200. name: page.limit in: query required: true style: form explode: true schema: type: integer format: int32 example: 175 default: 1 responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetStandingOrdersResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/AccountsGetStandingOrdersResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /accounts/{accountId}/standing-orders/{standingOrderId}: get: tags: - Accounts summary: Get standing order information operationId: Accounts_getStandingOrder security: - BasicAuth: [] - Bearer: [] description: >- The `GET /accounts/{accountId}/standing-orders/{standingOrderId}` endpoint retrieves information for a specific standing order in a given account, once consent has been given. parameters: - description: >- The system-generated, unique bank account id, which specifies the account for which the information is requested. name: accountId in: path required: true schema: type: string example: a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV - name: standingOrderId in: path required: true schema: description: >- The unique standing order identifier, which specifies the standing order requested. type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetStandingOrderResponse' deprecated: false x-hideTryItPanel: true /accounts/{accountId}/transactions: get: tags: - Accounts summary: Get account transactions operationId: Accounts_getTransactions security: - BasicAuth: [] - Bearer: [] description: >- The `GET /accounts/{accountId}/transactions` endpoint retrieves information for all transactions in a given account. parameters: - description: >- The system-generated unique bank account id, which specifies the account for which the information is requested. name: accountId in: path required: true style: simple explode: false schema: type: string example: a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV - description: >- 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. name: token-customer-ip-address in: header schema: type: string format: ipv4 required: false example: 172.16.254.1 - description: >- 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. name: page.offset in: query required: false style: form explode: true schema: type: string example: LerV6Jmex - description: The maximum number of records to return. This must be less than 200. name: page.limit in: query required: true style: form explode: true schema: type: integer format: int32 example: 175 default: 1 - description: >- The earliest transaction date requested, in ISO 8601 format. name: startDate in: query required: false style: form explode: true schema: type: string example: '2022-06-15' - description: >- The latest transaction date requested, in ISO 8601 format. name: endDate in: query required: false style: form explode: true schema: type: string example: '2022-11-30' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetTransactionsResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/AccountsGetTransactionsResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /accounts/{accountId}/transaction/{transactionId}: get: tags: - Accounts summary: Get transaction information operationId: Accounts_getTransactionDetails security: - BasicAuth: [] - Bearer: [] description: >- The `GET /accounts/{accountId}/transaction/{transactionId}` endpoint retrieves information for a specific transaction in a given account. parameters: - description: >- The unique bank account id, which specifies the account for which the information is requested. name: accountId in: path required: true style: simple explode: false schema: type: string - description: >- The unique transaction identifier, which specifies the transaction requested. name: transactionId in: path required: true style: simple explode: false schema: type: string example: 42909b155d4942299c39017686b5dc36 - description: >- 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. name: token-customer-ip-address in: header schema: type: string format: ipv4 required: false example: 172.16.254.1 responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetTransactionResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/AccountsGetTransactionDetailsResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /accounts/{accountId}/funds-confirmation: put: tags: - Accounts summary: Confirm available funds operationId: Accounts_confirmFundsAvailability security: - BasicAuth: [] - Bearer: [] description: >- The `PUT /accounts/{accountId}/funds-confirmation` endpoint confirms that sufficient funds are available in the account. parameters: - description: >- The system-generated, unique bank account id, which specifies the account for which the information is requested. name: accountId in: path required: true style: simple explode: false schema: type: string example: a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfirmFundsRequest' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ConfirmFundsResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/AccountsConfirmFundsAvailabilityResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /banks: get: tags: - Banks v1 summary: Get banks v1 operationId: BanksV1_getList description: >- The `GET /banks` endpoint retrieves a list of Token.io-integrated banks matching the parameters specified. parameters: - description: The index of the page currently being retrieved. name: page in: query required: false style: form explode: true schema: type: integer format: int32 example: 1 - description: The number of records per page. name: perPage in: query required: false style: form explode: true schema: type: integer format: int32 example: 175 - description: >- The key to sort the result. This can be `name` (i.e., bank name), `provider`, or `country`. name: sort in: query required: false style: form explode: true schema: type: string example: country default: name - description: The Token.io-assigned member id of the TPP. name: memberId in: query required: false style: form explode: true schema: type: string example: m:nP4w3u5y8ddrxDJkjimgSX9e4fZ:5zKtXEAq - description: >- Filters for banks with a `bankId` (case-insensitive) matching any of the ids listed, up to a maximum of 1000. Only exact (full string) matches are returned. name: ids in: query required: false style: form explode: true schema: type: array example: - goldbank - opalbank - platinumbank items: type: string - description: >- Filters for banks with a name or identifiers containing this search string. name: search in: query required: false style: form explode: true schema: type: string example: hsbc - description: >- Filters for banks for which the TPP represented by this `tppId` has access. name: tppId in: query required: false style: form explode: true schema: type: string example: 4h27g823-g73s-07v3-l49s-prte94bf21v - description: >- Filters for banks that are accessed through any of the listed providers. name: providers in: query required: false style: form explode: true schema: type: array example: Token.io items: type: string - description: >- Filters for banks with a BIC (or BLZ, if German) that matches this `bankCode`. The BIC must have a string length of 8 or 11. The BLZ must have a string length of 8. name: bankCode in: query required: false style: form explode: true schema: type: string example: NBAGDE3E - description: >- Filters for banks that are located in the countries specified by this list of ISO 3166-1 Alpha 2 country codes, in upper case. name: countries in: query required: false style: form explode: true schema: type: array example: - IT - DE - RO items: type: string - description: Filters for banks that support payment initiation. name: bank_features.supports_send_payment.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: Filters for banks that support receiving payments. name: bank_features.supports_receive_payment.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: Filters for the banks that support retrieving balances name: bank_features.supports_balance.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: Filters for banks that support future dated scheduled payments. name: bank_features.supports_scheduled_payment.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: Filters for banks that support recurring payments/standing orders. name: bank_features.supports_standing_order.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: >- Filters for banks that only support immediate redemption of transfers. name: bank_features.requires_one_step_payment.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: Filters for the banks that support confirmation of available funds. name: bank_features.supports_funds_confirmation.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: Filters for the banks that support request of refund account. name: bank_features.supports_return_refund_account.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: >- Filters for banks that support retrieving transactions by date filter. name: bank_features.supports_transactions_date_filter.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: Filters for banks that support retrieval of account information. name: bank_features.supports_account_information.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: Filters for banks that support single immediate payments. name: bank_features.supports_single_payment.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: Filters for banks that support variable recurring payments. name: bank_features.supports_variable_recurring_payment.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: >- Filters for banks whose BIC matches any of the listed BICs (case-insensitive), up to a maximum of 1000. name: bics in: query required: false style: form explode: true schema: type: array items: type: string example: BKENGB2L, BNPAFRPH, NBAGDE3E - description: Filters for banks that support any of the listed payment networks. name: supportedPaymentNetworks in: query required: false style: form explode: true schema: type: array items: type: string - description: Filters for banks that are part of the bank group specified. name: bankGroup in: query required: false style: form explode: true schema: type: string example: - HSBC - Coop - description: Filters for banks that are part of the bank sub-group specified. name: bankSubGroup in: query required: false style: form explode: true schema: type: string example: - CMM Grand - Banque Populaire - La Banque responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetBanksResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/BanksV1GetListResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: false /bank/countries: get: tags: - Banks v1 summary: Get bank countries operationId: BanksV1_getBankCountries description: >- The `GET /banks/countries` endpoint retrieves the list of countries that have Token.io-integrated banks which match the parameters specified. parameters: - description: >- Filters for banks with bank ids that are represented in this list of ids (case-insensitive), up to a maximum of 1000. name: ids in: query required: false style: form explode: true schema: type: array items: type: string example: - goldbank - opalbank - platinumbank - description: >- Filters for banks with names or identifiers that contain this search string (case sensitive). name: search in: query required: false style: form explode: true schema: type: string example: banca - description: Filters for banks to which the TPP with this `tppId` has access. name: tppId in: query required: false style: form explode: true schema: type: string example: 9fk3m361-f12r-04b9-p39f-rio2m3pw9v8s - description: >- Filters for banks with a BIC (or BLZ, if German) that matches this `bankCode`. The BIC must have a string length of 8 or 11. The BLZ must have a string length of 8. name: bankCode in: query required: false style: form explode: true schema: type: string example: NBAGDE3E - description: >- Filters for banks that are located in the countries specified by this list of ISO 3166-1 Alpha 2 country codes, in upper case. name: countries in: query required: false style: form explode: true schema: type: array items: type: string example: GB, RO, AT - description: >- Filters for banks that are accessed through any of this list of providers. name: providers in: query required: false style: form explode: true schema: type: array example: Token.io items: type: string - description: Filters for banks that support payment initiation. name: bank_features.supports_send_payment.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: Filters for banks that support the receipt of payments. name: bank_features.supports_receive_payment.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: Filters for the banks that support retrieving account balances. name: bank_features.supports_balance.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: Filters for banks that support future dated scheduled payments. name: bank_features.supports_scheduled_payment.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: Filters for banks that support standing orders/recurring payments. name: bank_features.supports_standing_order.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: >- Filters for banks that only support immediate redemption of transfer tokens. name: bank_features.requires_one_step_payment.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: Filters for banks that support confirmation of available funds. name: bank_features.supports_funds_confirmation.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: Filters for banks that support the request of refund account. name: bank_features.supports_return_refund_account.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: >- Filters for banks that support retrieving transactions by date filter. name: bank_features.supports_transactions_date_filter.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: >- Filters for banks that support retrieving account information using Account Information Services (AIS). name: bank_features.supports_account_information.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: Filters for banks that support single immediate payments. name: bank_features.supports_single_payment.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: Filters for banks that support variable recurring payments. name: bank_features.supports_variable_recurring_payment.value in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false - description: The Token.io-assigned member id of the TPP. name: memberId in: query required: false style: form explode: true schema: type: string example: m:nP4w3u5y8ddrxDJkjimgSX9e4fZ:5zKtXEAq example: m:nP4w3u5y8ddrxDJkjimgSX9e4fZ:5zKtXEAq - description: Filters for banks that support any of the listed payment networks. name: supportedPaymentNetworks in: query required: false style: form explode: true schema: type: array items: type: string example: SEPA responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetBanksCountriesResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/BanksV1GetBankCountriesResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: false /member/sub-tpps: post: tags: - Sub-TPPs summary: Create a sub-TPP operationId: SubTpPs_createSubTpp security: - BasicAuth: [] - Bearer: [] description: >- The `POST /member/sub-tpps` endpoint creates a new sub-TPP for a reseller. requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSubTppRequest' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CreateSubTppResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a sub-tpp, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/SubTpPsCreateSubTppResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true get: tags: - Sub-TPPs summary: Get sub-TPPs operationId: SubTpPs_getList security: - BasicAuth: [] - Bearer: [] description: >- The `GET /member/sub-tpps` endpoint retrieves a list of all sub-TPPs for a reseller. parameters: - description: >- 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. name: page.offset in: query required: false style: form explode: true schema: type: string example: LerV6Jmex - description: The maximum number of records to return. This must be less than 200. name: page.limit in: query required: true style: form explode: true schema: type: integer format: int32 example: 175 default: 1 - description: Filters the sub-TPPs by the list of company names submitted. name: filter.byCompanyNames in: query required: false style: form explode: true schema: type: array items: type: string example: '["Company A","Company B","Company C"]' - description: Filters the sub-TPPs by the list of registration dates submitted. name: filter.byRegistrationDates in: query required: false style: form explode: true schema: type: array items: type: string example: '["22-03-21","19-05-21","27-07-21"]' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/RetrieveSubTppsResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a sub-tpp, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/SubTpPsGetListResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /member/sub-tpps/{subTppId}: get: tags: - Sub-TPPs summary: Get sub-TPP information operationId: SubTpPs_getSubTppInfo security: - BasicAuth: [] - Bearer: [] description: >- The `GET /member/sub-tpps/{subTppId}` endpoint retrieves the details of the specified sub-TPP for a reseller. parameters: - description: This id specifies the sub-TPP to be retrieved. name: subTppId in: path required: true style: simple explode: false schema: type: string example: 8d54f066-c14a-47c0-b58b-fec6b0ed6b4c responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/RetrieveSubTppResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a sub-tpp, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/SubTpPsGetSubTppInfoResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true delete: tags: - Sub-TPPs summary: Delete a sub-TPP operationId: SubTpPs_deleteSubTpp security: - BasicAuth: [] - Bearer: [] description: >- The `DELETE /member/sub-tpps/{subTppId}` endpoint deletes an existing sub-TPP for a reseller. parameters: - description: Specifies the sub-TPP to delete. name: subTppId in: path required: true style: simple explode: false schema: type: string example: 8d54f066-c14a-47c0-b58b-fec6b0ed6b4c responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/DeleteSubTppResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a sub-tpp, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/SubTpPsDeleteSubTppResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /member/sub-tpps/{subTppId}/children: get: tags: - Sub-TPPs summary: Get sub-TPP children operationId: SubTpPs_getChildren security: - BasicAuth: [] - Bearer: [] description: >- The `GET /member/sub-tpps/{subTppId}/children` endpoint retrieves the sub-TPP children for given sub-TPP. parameters: - description: Specifies the sub-TPP for which the children are to be retrieved. name: subTppId in: path required: true style: simple explode: false schema: type: string example: 8d54f066-c14a-47c0-b58b-fec6b0ed6b4c responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/RetrieveSubTppChildrenResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a sub-tpp, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/SubTpPsGetChildrenResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /reports/banks/status: get: tags: - Reports summary: Get bank statuses operationId: Reports_getBankStatus security: - BasicAuth: [] - Bearer: [] description: >- The `GET /reports/banks/status` endpoint returns the current AIS and PIS service status along with server status for all banks. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetBanksStatusResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/ReportsGetBankStatusResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /reports/banks/{bankId}/status: get: tags: - Reports summary: Get a bank status operationId: Reports_bankStatus security: - BasicAuth: [] - Bearer: [] description: >- The `GET /reports/banks/{bankId}/status` endpoint returns the current AIS and PIS service status for a specific bank. parameters: - description: >- The Token.io bank identifier, identical to the `id` in the repsonse to `GET /banks`. name: bankId in: path required: true style: simple explode: false schema: type: string example: goldbank responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetBankStatusResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/ReportsBankStatusResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /token-requests: post: tags: - Requests summary: Initiate a token request operationId: Requests_initiateTokenRequest security: - BasicAuth: [] - Bearer: [] description: >- The `POST /token-requests` endpoint persists the required information used by AIS requests and PIS requests using the API and the Token.io Hosted Pages. requestBody: content: application/json: schema: $ref: '#/components/schemas/StoreTokenRequestRequest' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/StoreTokenRequestResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/RequestsInitiateTokenRequestResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /token-requests/{tokenRequestId}/result: get: tags: - Requests summary: Get a token request operationId: Requests_checkTokenResult security: - BasicAuth: [] - Bearer: [] description: >- The `GET /token-requests/{tokenRequestId}/result` endpoint checks whether a token request result is available. This endpoint will return a `PENDING` status while the result is not available. The status will become `PROCESSED` once the result is available. If the request is rejected by the bank, the status will become `REJECTED`. The status will become `EXPIRED` if the request is not processed or rejected before the token request expiration. parameters: - description: >- The token request id received in response to the original token request. name: tokenRequestId in: path required: true style: simple explode: false schema: type: string example: rq:ej5ACWNwi1EcqBeuDPc4Z8C4Bgc:5zKtXEAq responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetTokenRequestResultWithStatusResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/RequestsCheckTokenResultResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /callback/initiation: post: tags: - TSP summary: Initiate a callback operationId: Tsp_processBankCallback security: - BasicAuth: [] - Bearer: [] description: >- The `POST /callback/initiation` endpoint processes a bank authorization callback notification. If you're responsible for handling callbacks, the bank will callback to your `callbackUrl` provided in the payment initiation, after the user finishes authentication at the bank. Send the query of the bank's callback url to Token.io via the `POST /callback/initiation` endpoint to process the payment. requestBody: content: application/json: schema: $ref: '#/components/schemas/OnBankAuthCallbackRequest' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/OnBankAuthCallbackResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/TspProcessBankCallbackResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /tokens: get: tags: - Tokens summary: Get tokens operationId: Tokens_getAll security: - BasicAuth: [] - Bearer: [] description: >- The `GET /tokens` endpoint retrieves a list of all tokens for the authenticated member. parameters: - description: Specifies the type of token returned. name: type in: query required: false style: form explode: true schema: type: string example: ACCESS default: INVALID enum: - INVALID - ACCESS - TRANSFER - description: >- 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. name: page.offset in: query required: false style: form explode: true schema: type: string example: LerV6Jmex - description: The maximum number of records to return. This must be less than 200. name: page.limit in: query required: true style: form explode: true schema: type: integer format: int32 example: 175 default: 1 - description: Identifies the payer's account. name: filter.sourceAccountId in: query required: false style: form explode: true schema: type: string example: a:J72REftaRoiaDYRDU7M9FDgf8jeh3eqek9DvKeyBWbuA:3VMczyq7r7b6HwC - description: Identifies the payee/beneficiary's account. name: filter.destinationAccountId in: query required: false style: form explode: true schema: type: string example: a:f34VSeqwfWGTGH23vsa2cDgecew209jdvcd5vdfv4vds:5VSWVRqicm4Csa2 - description: >- The filtered list start timestamp in milliseconds, 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000. name: filter.startTimeMs in: query required: false style: form explode: true schema: type: string format: string example: 67505 - description: >- The filtered list end timestamp in milliseconds, 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000. name: filter.endTimeMs in: query required: false style: form explode: true schema: type: string format: string example: 365650 - description: Filters by `accountHolder` role. name: filter.role in: query required: false style: form explode: true schema: type: string example: ISSUER default: ANY enum: - ANY - FROM - TO - ISSUER - description: >- Filters the list by the sub-TPP identifier generated by Token.io once a merchant has been onboarded. name: filter.actingAsRefId in: query required: false style: form explode: true schema: type: string example: 4kwl35c9sp3fwp4xq responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetTokensResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/TokensGetAllResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /tokens/{tokenId}: get: tags: - Tokens summary: Get a token operationId: Tokens_getInfo security: - BasicAuth: [] - Bearer: [] description: >- The `GET /tokens/{tokenId}` endpoint retrieves information about a specific token for the authenticated member. parameters: - description: >- Identifies a unique authorization token for a transfer, standing order, or account information access. name: tokenId in: path required: true style: simple explode: false schema: type: string example: tt:8zK1dic95omjWb72gvc3z3ELKbTNfnGd89MbDnM73er4:ZhBVAJSH8DeU1 responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetTokenResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/TokensGetInfoResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /tokens/{tokenId}/cancel: put: tags: - Tokens summary: Cancel a token operationId: Tokens_cancelToken security: - BasicAuth: [] - Bearer: [] description: The `PUT /tokens/{tokenId}/cancel` endpoint cancels a given token. parameters: - description: >- 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. name: token-customer-ip-address in: header schema: type: string format: ipv4 required: false example: 172.16.254.1 - description: >- Informs the bank that the API call was explicitly initiated by the user. This is useful in circumnavigating bank restrictions that impose a 4-times-a-day (i.e., within the same 24-hour period) access limit on the same AISP, in accordance with RTS regulations. name: customer-initiated in: header schema: type: boolean required: false example: true - description: >- Obtained by the TPP from details in the user agent information of the user. name: token-customer-device-id in: header schema: type: string required: false example: 00000000-00000000-01234567-89ABCDEF - description: >- Identifies a unique authorization token for a transfer, standing order, or account information access. name: tokenId in: path required: true style: simple explode: false schema: type: string example: ta:3eYPU1BEKKunfmYgQuSKXFCeo851C5Y3XiZW3XA465TU:5zKtXEAq responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CancelTokenResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/TokensCancelTokenResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /transfers: post: tags: - Single Immediate Payments v1 summary: Redeem a transfer token operationId: SingleImmediatePaymentsV1_createTransferRequest security: - BasicAuth: [] - Bearer: [] description: >- The `POST /transfers` endpoint creates a request to move money between accounts. This is only required for banks that support 2-step payments. requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTransferRequest' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CreateTransferResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: >- #/components/schemas/SingleImmediatePaymentsV1CreateTransferRequestResponse '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true get: tags: - Single Immediate Payments v1 summary: Get transfers operationId: SingleImmediatePaymentsV1_getTransfers security: - BasicAuth: [] - Bearer: [] description: The `GET /transfers` endpoint retrieves information for all transfers. parameters: - description: Identifies the authorization token for the request. name: tokenId in: query required: false style: form explode: true schema: type: string example: rq:ej5ACWNwi1EcqBeuDPc4Z8C4Bgc:5zKtXEAq - description: >- 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. name: page.offset in: query required: false style: form explode: true schema: type: string example: LerV6Jmex - description: The maximum number of records to return. This must be less than 200. name: page.limit in: query required: true style: form explode: true schema: type: integer format: int32 example: 175 default: 1 - description: Filters by the token id. name: filter.tokenId in: query required: false style: form explode: true schema: type: string example: tt:3kFGtpEKHu8S2fJuEkb6YPnHZ4bJ2oUrYPCsJop68vCH:5zKcENpV - description: >- Filtered list start time boundary in milliseconds, 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000. name: filter.startTimeMs in: query required: false style: form explode: true schema: type: string format: string example: 72799 - description: >- Filtered list end time boundary in milliseconds, 1 day (24 hours) = 8640000000, 1 hour = 36000000, and 1 minute = 60000. name: filter.endTimeMs in: query required: false style: form explode: true schema: type: string format: string example: 3341983424 - description: >- Filters by transaction status.
During settlement of a virtual 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:For SEPA Instant payments: name: filter.transactionStatus in: query required: false style: form explode: true schema: type: string example: SUCCESS 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 - description: Filters list by the account holder role. name: filter.role in: query required: false style: form explode: true schema: type: string example: PAYER enum: - ANY - PAYER - PAYEE - description: >- Filters the list by the sub-TPP identifier generated by Token.io once a merchant has been onboarded. name: filter.actingAsRefId in: query required: false style: form explode: true schema: type: string example: 4kwl35c9sp3fwp4xq - description: Filters list by `refID`. name: filter.refId in: query required: false style: form explode: true schema: type: string example: 9htio4a1sp2akdr1aa - description: Filters list by refund status. name: filter.transferRefundStatus in: query required: false style: form explode: true schema: type: string example: PARTIAL enum: - UNSET - NONE - PARTIAL - FULL responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetTransfersResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: >- #/components/schemas/SingleImmediatePaymentsV1GetTransfersResponse '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /token-requests/{tokenRequestId}/authorization: post: tags: - Single Immediate Payments v1 summary: Initiate bank authorization operationId: SingleImmediatePaymentsV1_initiateBankAuthorization security: - BasicAuth: [] - Bearer: [] description: >- The `POST /token-requests/{tokenRequestId}/authorization` endpoint initiates the bank authorization process with a given bank id and token request id. parameters: - description: >- The token request id received in response to the original token request. name: tokenRequestId in: path required: true style: simple explode: false schema: type: string example: rq:ej5ACWNwi1EcqBeuDPc4Z8C4Bgc:5zKtXEAq requestBody: content: application/json: schema: $ref: '#/components/schemas/InitiateBankAuthorizationRequest' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/InitiateBankAuthorizationResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: >- #/components/schemas/SingleImmediatePaymentsV1InitiateBankAuthorizationResponse '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /transfers/{transferId}: get: tags: - Single Immediate Payments v1 summary: Get a transfer operationId: SingleImmediatePaymentsV1_getTransferDetails security: - BasicAuth: [] - Bearer: [] description: >- The `GET /transfers/{transferId}` endpoint retrieves information about a specific transfer in a given account. parameters: - description: >- The unique id of the transfer sent in the `POST /transfers` response and/or included in a respective `GET /transfers` response. name: transferId in: path required: true style: simple explode: false schema: type: string - description: >- If `skipTransferUpdate` is false, the request will call the bank for a status update. If set to true, the cached result will be returned instead. name: skipTransferUpdate in: query required: false style: form explode: true schema: type: boolean format: boolean example: false default: false responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetTransferResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: >- #/components/schemas/SingleImmediatePaymentsV1GetTransferDetailsResponse '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /webhook/config: get: tags: - Webhooks summary: Get webhook config operationId: Webhooks_getConfig security: - BasicAuth: [] - Bearer: [] description: The `GET /webhook/config` endpoint retrieves the webhook configuration. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetWebhookConfigResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/WebhooksGetConfigResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true put: tags: - Webhooks summary: Set webhook config operationId: Webhooks_setConfig security: - BasicAuth: [] - Bearer: [] description: The `PUT /webhook/config` endpoint sets the webhook configuration. requestBody: content: application/json: schema: $ref: '#/components/schemas/SetWebhookConfigRequest' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/SetWebhookConfigResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/WebhooksSetConfigResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true delete: tags: - Webhooks summary: Delete webhook config operationId: Webhooks_deleteConfig security: - BasicAuth: [] - Bearer: [] description: The `GET /webhook/config` endpoint deletes the webhook configuration. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/DeleteWebhookConfigResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/WebhooksDeleteConfigResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /vrp-consents: post: tags: - Variable Recurring Payments summary: Create a VRP consent operationId: VariableRecurringPayments_createConsent security: - BasicAuth: [] - Bearer: [] description: The `POST /vrp-consents` endpoint creates a new VRP consent. requestBody: content: application/json: schema: $ref: '#/components/schemas/vrpconsents_body' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/VrpConsentResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/inline_response_400_2' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '500': description: An unexpected or internal server error content: application/json: schema: $ref: >- #/components/schemas/VariableRecurringPaymentsCreateConsentResponse deprecated: false x-hideTryItPanel: true get: tags: - Variable Recurring Payments summary: Get VRP consents operationId: VariableRecurringPayments_getConsents security: - BasicAuth: [] - Bearer: [] description: >- The `GET /vrp-consents` endpoint retrieves all VRP consents created by the calling member. parameters: - description: The maximum number of records to return. name: limit in: query required: true style: form explode: true schema: maximum: 200 minimum: 1 type: integer format: int32 example: 10 - description: The offset from the previous page. name: offset in: query required: false style: form explode: true schema: type: string example: LerV6Jmex responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/VrpConsentsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/inline_response_400_1' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '500': description: An unexpected or internal server error content: application/json: schema: $ref: >- #/components/schemas/VariableRecurringPaymentsGetConsentsResponse deprecated: false x-hideTryItPanel: true /vrp-consents/{id}: get: tags: - Variable Recurring Payments summary: Get a VRP consent operationId: VariableRecurringPayments_getConsentDetails security: - BasicAuth: [] - Bearer: [] description: >- The `GET /vrp-consents/{id}` endpoint retrieves the details for an individual VRP consent. parameters: - name: id in: path required: true style: simple explode: false schema: description: VRP consent id type: string example: vc:12345abcd:abcde responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/VrpConsentResponse' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '404': description: VRP consent not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404_1' '500': description: An unexpected or internal server error content: application/json: schema: $ref: >- #/components/schemas/VariableRecurringPaymentsGetConsentDetailsResponse deprecated: false x-hideTryItPanel: true delete: tags: - Variable Recurring Payments summary: Revoke a VRP consent operationId: VariableRecurringPayments_revokeConsent security: - BasicAuth: [] - Bearer: [] description: >- The `DELETE /vrp-consents/{id}` endpoint revokes an individual VRP consent. parameters: - name: id in: path required: true style: simple explode: false schema: description: VRP consent id type: string example: vc:12345abcd:abcde responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/VrpConsentResponse' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '404': description: VRP consent not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404_1' '500': description: An unexpected or internal server error content: application/json: schema: $ref: >- #/components/schemas/VariableRecurringPaymentsRevokeConsentResponse deprecated: false x-hideTryItPanel: true /vrp-consents/{id}/payments: get: tags: - Variable Recurring Payments summary: Get payments under a VRP consent operationId: VariableRecurringPayments_getPaymentsUnderConsent security: - BasicAuth: [] - Bearer: [] description: >- The `GET /vrp-consents/{id}/payments` endpoint retrieves the payments under a given VRP consent. parameters: - description: VRP consent id name: id in: path required: true style: simple explode: false schema: type: string example: vc:12345abcd:abcde - description: The maximum number of records to return. name: limit in: query required: true style: form explode: true schema: maximum: 200 minimum: 1 type: integer format: int32 example: 10 - description: The offset from the previous page. name: offset in: query required: false style: form explode: true schema: type: string example: LerV6Jmex responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/VrpsResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/inline_response_400_1' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '500': description: An unexpected or internal server error content: application/json: schema: $ref: >- #/components/schemas/VariableRecurringPaymentsGetPaymentsUnderConsentResponse deprecated: false x-hideTryItPanel: true /vrps: post: tags: - Variable Recurring Payments summary: Initiate a VRP payment operationId: VariableRecurringPayments_initiatePayment security: - BasicAuth: [] - Bearer: [] description: The `POST /vrps` initiates a new VRP payment. requestBody: content: application/json: schema: $ref: '#/components/schemas/vrps_body' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/VrpResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/inline_response_400_3' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: VRP consent not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404_1' '500': description: An unexpected or internal server error content: application/json: schema: $ref: >- #/components/schemas/VariableRecurringPaymentsInitiatePaymentResponse deprecated: false x-hideTryItPanel: true get: tags: - Variable Recurring Payments summary: Get VRP payments operationId: VariableRecurringPayments_listPayments security: - BasicAuth: [] - Bearer: [] description: >- The `GET /vrps` endpoint provides you with a list of vrp payments and their details. parameters: - description: The maximum number of records to return. name: limit in: query required: true style: form explode: true schema: maximum: 200 minimum: 1 type: integer format: int32 example: 10 - description: The offset from the previous page. name: offset in: query required: false style: form explode: true schema: type: string example: LerV6Jmex - description: >- Filters vrp payments by their ids - returns only payments with ids listed in this parameter. name: ids in: query required: false style: form explode: true schema: type: array items: type: string example: - vrp:4QExXrhKTxfShBdcTeqFabqJJhUF:2gFUX1NDgpN - vrp:N5cJDFsQzVca3Qvr8kQocgEnjgX:2gFUX1NEdYA - description: >- Invert ids query - returns only vrp payments with ids not listed in the ids parameter. name: invertIds in: query required: false style: form explode: true schema: type: boolean example: false - description: >- Filters vrp payments by their statuses - returns only payments with statuses listed in this parameter. name: statuses in: query required: false style: form explode: true schema: type: array items: $ref: '#/components/schemas/VrpStatus' example: - INITIATION_COMPLETED - INITIATION_REJECTED - description: >- Invert statuses query - returns only vrp payments with statuses not listed in the statuses parameter. name: invertStatuses in: query required: false style: form explode: true schema: type: boolean example: true - description: >- Returns only vrp payments created after this time (in ISO 8601 format). name: createdAfter in: query required: false style: form explode: true schema: type: string example: '2022-04-05T17:00:00.000Z' - description: >- Returns only vrp payments created before this time (in ISO 8601 format). name: createdBefore in: query required: false style: form explode: true schema: type: string example: '2022-04-05T17:00:00.000Z' - description: >- Filters vrp payments by their `refId` values - returns only payments with `refIds` listed in this parameter. name: refIds in: query required: false style: form explode: true schema: type: array items: type: string example: - ShBdcTeqFabqJJhUF - N5cJDFsQzVca3Q - description: >- Filters vrp payments by their `VRP consent id` value - returns only payments with `vrpConsentId` listed in this parameter. name: vrpConsentId in: query required: false style: form explode: true schema: type: string example: vc:12345abcd:abcde responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/VrpsResponse' '400': description: The client specified an invalid argument. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '500': description: An unexpected or internal server error content: application/json: schema: $ref: >- #/components/schemas/VariableRecurringPaymentsListPaymentsResponse deprecated: false x-hideTryItPanel: true /vrps/{id}: get: tags: - Variable Recurring Payments summary: Get a VRP payment operationId: VariableRecurringPayments_getPaymentDetails security: - BasicAuth: [] - Bearer: [] description: >- The `GET /vrps/{id}` endpoint retrieves the details for an individual VRP payment. parameters: - description: VRP id name: id in: path required: true style: simple explode: false schema: type: string example: vrp:12345abcd:abcde responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/VrpResponse' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404_2' '500': description: An unexpected or internal server error content: application/json: schema: $ref: >- #/components/schemas/VariableRecurringPaymentsGetPaymentDetailsResponse deprecated: false x-hideTryItPanel: true /vrps/{id}/confirm-funds: get: tags: - Variable Recurring Payments summary: Verify if funds are available or not operationId: VariableRecurringPayments_checkFundsAvailability security: - BasicAuth: [] - Bearer: [] description: >- The `GET /vrps/{id}/confirm-funds` endpoint confirms whether the funds are available to initiate VRP. parameters: - description: The VRP consent id. name: id in: path required: true style: simple explode: false schema: type: string example: vc:12345abcd:abcde - description: The amount to confirm availability for. name: amount in: query required: true schema: type: string example: 1 responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ConfirmFundsResponse' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404_2' '500': description: An unexpected or internal server error content: application/json: schema: $ref: >- #/components/schemas/VariableRecurringPaymentsCheckFundsAvailabilityResponse deprecated: false x-hideTryItPanel: true /refunds: post: tags: - Refunds - BETA summary: Initiate a refund operationId: RefundsBeta_initiateRefund security: - BasicAuth: [] - Bearer: [] description: >- The `POST /refunds` endpoint initiates a refund. After the refund is settled, the refund status of the original transfer will be updated.
The debtor field can be optional if you're using the debtor in registration. The creditor field can be optional if the information is available in the original payment. requestBody: content: application/json: schema: $ref: '#/components/schemas/refunds_body' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/RefundResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/RefundsBetaInitiateRefundResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true get: tags: - Refunds - BETA summary: Get refunds operationId: RefundsBeta_getList security: - BasicAuth: [] - Bearer: [] description: >- The `GET /refunds` endpoint retrieves a complete or filtered list of refunds. parameters: - description: The maximum number of records to return. name: limit in: query required: true style: form explode: true schema: maximum: 200 minimum: 1 type: integer format: int32 example: 10 - description: The offset from the previous page. name: offset in: query required: false style: form explode: true schema: type: string example: LerV6Jmex - description: >- Lower bound for a refund creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only refunds created at or after the given date will be returned. name: startDate in: query required: false style: form explode: true schema: type: string example: '2010-01-01' - description: >- Upper bound for a refund creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only refunds created at or before the given date will be returned. name: endDate in: query required: false style: form explode: true schema: type: string example: '2010-01-01' - description: >- Filters refunds by their ids - returns only refunds with ids listed in this parameter. name: ids in: query required: false style: form explode: true schema: type: array items: type: string example: - rf:4QExXrhKTxfShBdcTeqFabqJJhUF:2gFUX1NDgpN - rf:N5cJDFsQzVca3Qvr8kQocgEnjgX:2gFUX1NEdYA - description: >- Invert ids query - returns only refunds with ids not listed in the ids parameter. name: invertIds in: query required: false style: form explode: true schema: type: boolean example: false - description: >- Filters refunds by their statuses - returns only refunds with statuses listed in this parameter. name: statuses in: query required: false style: form explode: true schema: type: array items: $ref: '#/components/schemas/RefundStatus' example: - INITIATION_COMPLETED - INITIATION_REJECTED - description: >- Invert statuses query - returns only refunds with statuses not listed in the statuses parameter. name: invertStatuses in: query required: false style: form explode: true schema: type: boolean example: true - description: >- Filters refunds by their `refId` values - returns only refunds with `refIds` listed in this parameter. name: refIds in: query required: false style: form explode: true schema: type: array items: type: string example: - ShBdcTeqFabqJJhUF - N5cJDFsQzVca3Q - description: >- Returns refunds in a partial format - with only id and status fields populated. name: partial in: query required: false style: form explode: true schema: type: boolean example: true - description: The result can be filtered on the basis of multiple OnBehalfOfIds. name: onBehalfOfIds in: query required: false style: form explode: true schema: type: array items: type: string example: - c5a863bc-86f2-4418-a26f-25b24c7983c7 - 6f34h397-b29h-23b0-s30g-hkd0d2dk4k1s responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/RefundsResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/RefundsBetaGetListResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /refunds/{id}: get: tags: - Refunds - BETA summary: Get a refund operationId: RefundsBeta_getRefund security: - BasicAuth: [] - Bearer: [] description: The `GET /refunds/{id}` endpoint retrieves a given refund. parameters: - name: id in: path required: true style: simple explode: false schema: description: The refund id. type: string example: your refund id responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/RefundResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/RefundsBetaGetRefundResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' /transfers/{id}/refunds: get: tags: - Refunds - BETA summary: Get all refunds by transfer operationId: RefundsBeta_getAllRefunds security: - BasicAuth: [] - Bearer: [] description: >- The `GET /transfers/{id}/refunds` endpoint retrieves all refunds associated with a given transfer. parameters: - description: The maximum number of records to return. name: limit in: query required: true style: form explode: true schema: maximum: 200 minimum: 1 type: integer format: int32 example: 10 - description: The offset from the previous page. name: offset in: query required: false style: form explode: true schema: type: string example: LerV6Jmex - name: id in: path required: true style: simple explode: false schema: description: The transfer id. type: string example: your transfer id responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/RefundsResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/RefundsBetaGetAllRefundsResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /payouts: post: tags: - Payouts - BETA summary: Initiate a payout operationId: PayoutsBeta_initializePayout security: - BasicAuth: [] - Bearer: [] description: The `POST /payouts` endpoint initiates a payout. requestBody: content: application/json: schema: $ref: '#/components/schemas/payouts_body' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/PayoutResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/PayoutsBetaInitializePayoutResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true get: tags: - Payouts - BETA summary: Get payouts operationId: PayoutsBeta_getList security: - BasicAuth: [] - Bearer: [] description: >- The `GET /payouts` endpoint retrieves a complete or filtered list of payouts. parameters: - description: The maximum number of records to return. name: limit in: query required: true style: form explode: true schema: maximum: 200 minimum: 1 type: integer format: int32 example: 10 - description: The offset from the previous page. name: offset in: query required: false style: form explode: true schema: type: string example: LerV6Jmex - description: >- Lower bound for a payout creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only payouts created at or after the given date will be returned. name: startDate in: query required: false style: form explode: true schema: type: string example: '2010-01-01' - description: >- Upper bound for a payout creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only payouts created at or before the given date will be returned. name: endDate in: query required: false style: form explode: true schema: type: string example: '2010-01-01' - description: >- Filters payouts by their ids - returns only payouts with ids listed in this parameter. name: ids in: query required: false style: form explode: true schema: type: array items: type: string example: - po:28oivvd3iFhBrcbNj4tmtLEhxRTk:2gFUX1NE1T6 - po:3ZfdHxbpXmRZ1TVmiYNPgcwEocBy:2gFUX1NDdqr - description: >- Invert ids query - returns only payouts with ids not listed in the ids parameter. name: invertIds in: query required: false style: form explode: true schema: type: boolean example: false - description: >- Filters payouts by their statuses - returns only payouts with statuses listed in this parameter. name: statuses in: query required: false style: form explode: true schema: type: array items: $ref: '#/components/schemas/PayoutStatus' example: - INITIATION_COMPLETED - INITIATION_REJECTED - description: >- Invert statuses query - returns only payouts with statuses not listed in the statuses parameter. name: invertStatuses in: query required: false style: form explode: true schema: type: boolean example: true - description: >- Filters payouts by their `refId` values - returns only payouts with `refIds` listed in this parameter. name: refIds in: query required: false style: form explode: true schema: type: array items: type: string example: - ShBdcTeqFabqJJhUF - N5cJDFsQzVca3Q - description: >- Filters payouts by their `onBehalfOfId` value - returns only payouts with `onBehalfOfId` listed in this parameter. name: onBehalfOfId in: query required: false style: form explode: true schema: type: string example: onBahalfOfId001 responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/PayoutsResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/PayoutsBetaGetListResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /payouts/{id}: get: tags: - Payouts - BETA summary: Get a payout operationId: PayoutsBeta_getPayout security: - BasicAuth: [] - Bearer: [] description: The `GET /payouts/{id}` endpoint retrieves a given payout. parameters: - name: id in: path required: true style: simple explode: false schema: description: The payout id. type: string example: your payout id responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/PayoutResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/PayoutsBetaGetPayoutResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' /secrets/upload/key-and-certificate: post: tags: - Refunds - BETA summary: Upload a private key and certificate operationId: RefundsBeta_uploadKeyAndCertificate security: - BasicAuth: [] - Bearer: [] description: >- The `POST /secrets/upload/key-and-certificate` endpoint uploads a private key and certificate. requestBody: content: application/json: schema: $ref: '#/components/schemas/UploadKeyAndCertificate' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/UploadKeyAndCertificateResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '429': description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' '500': description: An unexpected or internal server error content: application/json: schema: $ref: >- #/components/schemas/RefundsBetaUploadKeyAndCertificateResponse '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: true /v2/banks: get: tags: - Banks v2 summary: Get banks v2 operationId: BanksV2_getList description: >- The `GET /v2/banks` endpoint retrieves a list of Token.io-integrated banks matching the parameters specified. parameters: - description: The index of the page currently being retrieved. name: page in: query required: false style: form explode: true schema: type: integer format: int32 - description: The number of records per page. name: perPage in: query required: false style: form explode: true schema: type: integer format: int32 default: 200 example: 10 - description: >- The key to sort the result. This can be `NAME` (Bank's name), `STANDARD` (OpenBankingStandard), `RANK`, or `COUNTRY`. name: sort in: query required: false style: form explode: true schema: type: string enum: - COUNTRY - STANDARD - RANK - NAME example: COUNTRY default: NAME - description: The Token.io-assigned member id of the TPP. name: memberId in: query required: false style: form explode: true schema: type: string - description: >- Filters for banks for which the TPP represented by this `tppId` has access. name: tppId in: query required: false style: form explode: true schema: type: string - description: >- Filters for banks with a `bankId` (case-insensitive) matching any of the ids listed, up to a maximum of 1000. Only exact (full string) matches are returned. name: ids in: query required: false style: form explode: true schema: type: array items: type: string - description: >- Filters for banks with a name or identifiers containing this search string. name: search in: query required: false style: form explode: true schema: type: string example: hsbc - description: Filters for banks that are members of the bank group specified. name: bankGroup in: query required: false style: form explode: true schema: type: string example: - HSBC - Coop - description: Filters for banks that are part of the bank sub-group specified. name: bankSubGroup in: query required: false style: form explode: true schema: type: string example: - CMM Grand - Banque Populaire - La Banque - description: >- Filters for banks with a BIC (or BLZ, if German) that matches this `bankCode`. The BIC must have a string length of 8 or 11. The BLZ must have a string length of 8. name: bankCode in: query required: false style: form explode: true schema: type: string - description: >- Filters for banks that are accessed through any of the listed standards. name: openBankingStandards in: query required: false style: form explode: true schema: type: array items: type: string enum: - UK_Open_Banking_Standard - Starling_Bank_API - PolishAPI - STET_PSD2_API - Citi_Handlowy_PSD2_API - NextGenPSD2 - Slovak_Banking_API_Standard - Czech_Open_Banking_Standard - American_Express_PSD2_API - Budapest_Bank_API - Token example: UK_Open_Banking_Standard default: UK_Open_Banking_Standard - description: >- Filters for banks that are located in the countries specified by this list of ISO 3166-1 Alpha 2 country codes, in upper case. name: countries in: query required: false style: form explode: true schema: type: array items: type: string - description: >- Filters for banks whose BIC matches any of the listed BICs (case-insensitive), up to a maximum of 1000. name: bics in: query required: false style: form explode: true schema: type: array items: type: string example: BKENGB2L - description: Filters for banks that support any of the listed payment networks. name: supportedLocalInstruments in: query required: false style: form explode: true schema: type: array items: type: string example: - SEPA_INSTANT - FASTER_PAYMENTS - SEPA - description: Filters for banks that support fetching accounts. name: supportsAccountList in: query required: false style: form explode: true schema: type: boolean format: boolean - description: Filters for banks that support fetching account details. name: supportsAccountDetails in: query required: false style: form explode: true schema: type: boolean format: boolean - description: Filters for banks that support fetching account balances. name: supportsAccountBalance in: query required: false style: form explode: true schema: type: boolean format: boolean - description: Filters for banks that support fetching transactions. name: supportsTransactionList in: query required: false style: form explode: true schema: type: boolean format: boolean - description: Filters for banks that support fetching transaction details. name: supportsTransactionDetails in: query required: false style: form explode: true schema: type: boolean format: boolean - description: Filters for banks that support the fetching standing orders. name: supportsStandingOrderList in: query required: false style: form explode: true schema: type: boolean format: boolean - description: >- Filters for banks that support feting transactions using a date filter. name: supportsTransactionsDateFilter in: query required: false style: form explode: true schema: type: boolean format: boolean - description: >- Filters for banks that only support immediate redemption of transfers. name: requiresOneStepPayment in: query required: false style: form explode: true schema: type: boolean format: boolean - description: Filters for banks that support single immediate payments. name: supportsSinglePayment in: query required: false style: form explode: true schema: type: boolean format: boolean example: true - description: Filters for banks that support future dated scheduled payments. name: supportsScheduledPayment in: query required: false style: form explode: true schema: type: boolean format: boolean - description: Filters for banks that support recurring payments/standing orders. name: supportsStandingOrder in: query required: false style: form explode: true schema: type: boolean format: boolean - description: Filters for the banks that support request of refund account. name: supportsReturnRefundAccount in: query required: false style: form explode: true schema: type: boolean format: boolean - description: >- Filters for banks that support returning the refund account holder name. name: supportsReturnRefundAccountHolderName in: query required: false style: form explode: true schema: type: boolean format: boolean - description: Filters for the banks that support confirmation of available funds. name: supportsFundsConfirmation in: query required: false style: form explode: true schema: type: boolean format: boolean - description: Filters for banks that support variable recurring payments. name: supportsVariableRecurringPayment in: query required: false style: form explode: true schema: type: boolean format: boolean - description: Filters for banks that are part of the bank sub-group specified. name: bankSubGroup in: query required: false style: form explode: true schema: type: string example: - CMM Grand - Banque Populaire - La Banque responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetBanksV2Response' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400_2' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '500': description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/BanksV2GetListResponse' '501': description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' '503': description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' '504': description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' deprecated: false x-hideTryItPanel: false /v2/payments: post: tags: - Single Immediate Payments v2 summary: Initiate a payment operationId: SingleImmediatePaymentsV2_initiatePayment security: - BasicAuth: [] - Bearer: [] description: >- The `POST /v2/payments` endpoint enables you to initiate a payment with a bank.

Once the payment has been initiated, the end user needs to authenticate themselves with their bank.

Check payment status:
  1. If the status in the initiation response is `INITIATION_PENDING_REDIRECT_AUTH`, redirect the user to the redirect url found in the authentication payload of the payment, to authenticate at the bank.

  2. If the status in the initiation response is `INITIATION_PENDING_EMBEDDED_AUTH`, collect the requested data listed in the authentication payload of the payment and use the `POST /v2/payments/{paymentId}/embedded-auth` endpoint to provide the requested field values.

  3. If the status in the initiation response is `INITIATION_PENDING`, Token.io needs more time to process this request with the bank. In the case of a successful scenario, the status will be updated to `INITIATION_PENDING_REDIRECT_AUTH`, `INITIATION_PENDING_EMBEDDED_AUTH` or `INITIATION_PENDING_DECOUPLED_AUTH` when the authentication details are ready. The update can be checked by the `GET /v2/payments/{paymentId}` endpoint or received via a webhook (see Webhooks).

  4. If the status is `INITIATION_PENDING_DECOUPLED_AUTH`, the bank has requested a decoupled authentication from the user and Token.io is awaiting the result. No further action is required.

  5. If the status is `PENDING_MORE_INFO` and you're not using Token.io's Hosted Payment Page (HPP), you need to populate the required information and make the payment initiation call again. Information about the missing data can be found in the `statusReasonInformation` field. If you're using Token.io's Hosted Payment Page, the required data will be collected from the user. You'll need to redirect the user to Token.io's Hosted Payment Page url constructed with the returned payment `id`.

`request-timeout` header:

Banks may take some time to respond when an initial request is made for an authorisation url. Therefore, Token.io recommends that you set a `request-timeout` header in your API-only `POST /v2/payments` requests. If this is set, Token.io sends a response when this timeout period has passed and will send a follow up response as soon as the bank has responded.
The following example demonstrates what happens when you set a timeout of 10 seconds and the call to the bank takes 15 seconds:

  1. The TPP makes a `POST /v2/payments` call.

  2. Tolen.io creates a resource with the status `INITIATION_PENDING`.

  3. Token.io starts the call to the bank.

  4. After 10 seconds from (1): Token.io returns the payment status `INITIATION_PENDING`.

  5. After 15 seconds from (3): Token.io receives a response from the bank and changes the status to, for example, `INITIATION_PENDING_REDIRECT_AUTH`.

  6. The TPP makes the `GET /v2/payments/{id}` call and receives the payment with the status `INITIATION_PENDING_REDIRECT_AUTH`.
parameters: - description: >- Sets the number of elapsed seconds until the call is aborted with a `DEADLINE_EXCEEDED` exception due to no response received. name: request-timeout in: header schema: type: integer required: false example: 10 requestBody: content: application/json: schema: $ref: '#/components/schemas/v2_payments_body' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/PaymentResponse' '400': description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400_2' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '500': description: An unexpected or internal server error content: application/json: schema: $ref: >- #/components/schemas/SingleImmediatePaymentsV2InitiatePaymentResponse deprecated: false x-hideTryItPanel: true get: tags: - Single Immediate Payments v2 summary: Get payments operationId: SingleImmediatePaymentsV2_listPayments security: - BasicAuth: [] - Bearer: [] description: >- The `GET /v2/payments` endpoint provides you with a list of payments and their details. parameters: - description: The maximum number of records to return. name: limit in: query required: true style: form explode: true schema: maximum: 200 minimum: 1 type: integer format: int32 example: 10 - description: The offset from the previous page. name: offset in: query required: false style: form explode: true schema: type: string example: LerV6Jmex - description: >- Filters payments by their ids - returns only payments with ids listed in this parameter. name: ids in: query required: false style: form explode: true schema: type: array items: type: string example: - pm2:4QExXrhKTxfShBdcTeqFabqJJhUF:2gFUX1NDgpN - pm2:N5cJDFsQzVca3Qvr8kQocgEnjgX:2gFUX1NEdYA - description: >- Invert ids query - returns only payments with ids not listed in the ids parameter. name: invertIds in: query required: false style: form explode: true schema: type: boolean example: false - description: >- Filters payments by their statuses - returns only payments with statuses listed in this parameter. name: statuses in: query required: false style: form explode: true schema: type: array items: $ref: '#/components/schemas/PaymentStatus' example: - INITIATION_COMPLETED - INITIATION_REJECTED - description: >- Invert statuses query - returns only payments with statuses not listed in the statuses parameter. name: invertStatuses in: query required: false style: form explode: true schema: type: boolean example: true - description: >- Returns only payments created after this time (in ISO 8601 format). name: createdAfter in: query required: false style: form explode: true schema: type: string example: '2022-04-05T17:00:00.000Z' - description: >- Returns only payments created before this time (in ISO 8601 format). name: createdBefore in: query required: false style: form explode: true schema: type: string example: '2022-04-05T17:00:00.000Z' - description: >- Filters payments by their `refId` values - returns only payments with `refIds` listed in this parameter. name: refIds in: query required: false style: form explode: true schema: type: array items: type: string example: - ShBdcTeqFabqJJhUF - N5cJDFsQzVca3Q - description: >- Filters payments by the `onBehalfOfId` value - returns only payments with `onBehalfOfId` specified in this parameter. name: onBehalfOfId in: query required: false style: form explode: true schema: type: string example: c5a863bc-86f2-4418-a26f-25b24c7983c7 - description: >- Filters payments by their refund status values - returns only payments with refund statuses listed in this parameter. name: refundStatuses in: query required: false style: form explode: true schema: type: array items: $ref: '#/components/schemas/PaymentRefundStatus' example: - PARTIAL - NONE - description: >- Returns payments in a partial format - with only id and status fields populated. name: partial in: query required: false style: form explode: true schema: type: boolean example: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/PaymentsResponse' '400': description: The client specified an invalid argument. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '500': description: An unexpected or internal server error content: application/json: schema: $ref: >- #/components/schemas/SingleImmediatePaymentsV2ListPaymentsResponse deprecated: false x-hideTryItPanel: true /v2/payments/{paymentId}/embedded-auth: post: tags: - Single Immediate Payments v2 summary: Provide information for embedded authentication operationId: SingleImmediatePaymentsV2_provideEmbeddedAuthInfo security: - BasicAuth: [] - Bearer: [] description: >- The `POST /v2/payments/{paymentId}/embedded-auth` endpoint provides you with the requested information when the payment status is `INITIATION_PENDING_EMBEDDED_AUTH`. The requested information can be found in the authentication field of the payment.

It's possible that some banks might request the user's input multiple times. In this case you might need to call this endpoint again for a new field set. parameters: - name: paymentId in: path required: true style: simple explode: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/paymentIdEmbeddedAuthBody' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/PaymentResponse' '400': description: The client specified an invalid argument. content: application/json: schema: $ref: '#/components/schemas/inline_response_400_4' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '403': description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '500': description: An unexpected or internal server error content: application/json: schema: $ref: >- #/components/schemas/SingleImmediatePaymentsV2ProvideEmbeddedAuthInfoResponse deprecated: false x-hideTryItPanel: true /v2/payments/{paymentId}: get: tags: - Single Immediate Payments v2 summary: Get a payment operationId: SingleImmediatePaymentsV2_getPaymentDetails security: - BasicAuth: [] - Bearer: [] description: >- The `GET /v2/payments/{paymentId}` endpoint provides you with details of an individual payment and checks the payment status for the next step, if any. parameters: - name: paymentId in: path required: true style: simple explode: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/PaymentResponse' '401': description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' '404': description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' '500': description: An unexpected or internal server error content: application/json: schema: $ref: >- #/components/schemas/SingleImmediatePaymentsV2GetPaymentDetailsResponse deprecated: false x-hideTryItPanel: true /virtual-accounts: post: tags: - Virtual Accounts - BETA summary: Create a virtual account operationId: VirtualAccountsBeta_createAccount security: - BasicAuth: [] - Bearer: [] description: The `POST /virtual-accounts` endpoint creates a virtual account. requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVirtualAccountRequest' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CreateVirtualAccountResponse' '400': $ref: '#/components/responses/InvalidArgumentRequest' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/PermissionDeniedResponse' '404': $ref: '#/components/responses/CustomerNotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' '500': $ref: '#/components/responses/UnexpectedErrorResponse' '501': $ref: '#/components/responses/NotImplementedResponse' '503': $ref: '#/components/responses/ServiceUnavailableResponse' '504': $ref: '#/components/responses/GatewayTimeoutResponse' deprecated: false x-hideTryItPanel: true get: tags: - Virtual Accounts - BETA summary: Get virtual accounts operationId: VirtualAccountsBeta_getAll security: - BasicAuth: [] - Bearer: [] description: >- The `GET /virtual-accounts` endpoint retrieves information for all virtual accounts. parameters: - description: >- The maximum number of records to return.
The maximum allowed limit is 200. If the passed limit is bigger than this, it will be set to 200. name: limit in: query required: false schema: format: int32 type: integer - description: >- The offset for the current page. The offset is not required to fetch the first page. To fetch subsequent pages, use the 'nextOffset' value from the previous page response.
The offset value should not be parsed and/or understood in any way. name: offset in: query required: false schema: type: string - description: >- The ISO 4217 three letter currency code. name: currency in: query required: false example: EUR schema: type: string - description: >- The ISO 3166-1 Alpha 2 country codes. name: country in: query required: false example: PL schema: type: string - description: The alias name that identifies the virtual account. name: nickname in: query required: false example: Account Alias schema: type: string - description: >- An id of the ultimate client on whose behalf the account is created. If the account is created on behalf of a sub-TPP, this field should contain the sub-TPP `referenceId`. name: onBehalfOfId in: query required: false example: c5a863bc-86f2-4418-a26f-25b24c7983c7 schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetVirtualAccountsResponse' '400': $ref: '#/components/responses/InvalidArgumentRequest' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/PermissionDeniedResponse' '404': $ref: '#/components/responses/CustomerNotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' '500': $ref: '#/components/responses/UnexpectedErrorResponse' '501': $ref: '#/components/responses/NotImplementedResponse' '503': $ref: '#/components/responses/ServiceUnavailableResponse' '504': $ref: '#/components/responses/GatewayTimeoutResponse' deprecated: false x-hideTryItPanel: true /virtual-accounts/{accountId}: get: tags: - Virtual Accounts - BETA summary: Get a virtual account operationId: VirtualAccountsBeta_getInfo security: - BasicAuth: [] - Bearer: [] description: >- The `GET /virtual-accounts/{accountId}` endpoint the information for a specific virtual account. parameters: - name: accountId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetVirtualAccountByIdResponse' '400': $ref: '#/components/responses/InvalidArgumentRequest' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/PermissionDeniedResponse' '404': $ref: '#/components/responses/AccountNotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' '500': $ref: '#/components/responses/UnexpectedErrorResponse' '501': $ref: '#/components/responses/NotImplementedResponse' '503': $ref: '#/components/responses/ServiceUnavailableResponse' '504': $ref: '#/components/responses/GatewayTimeoutResponse' deprecated: false x-hideTryItPanel: true /virtual-accounts/{accountId}/transactions: get: tags: - Virtual Accounts - BETA summary: Get virtual account transactions operationId: VirtualAccountsBeta_getTransactions security: - BasicAuth: [] - Bearer: [] description: >- The `GET /virtual-accounts/{accountId}/transactions` endpoint retrieves information of transactions in a given virtual account. parameters: - name: accountId in: path required: true schema: type: string - description: >- The maximum number of records to return.
The maximum allowed limit is 200. If the passed limit is bigger than this, it will be set to 200. name: limit in: query required: false schema: format: int32 type: integer - description: >- The offset for the current page. The offset is not required to fetch the first page. To fetch subsequent pages, use the 'nextOffset' value from the previous page response.
The offset value should not be parsed and/or understood in any way. name: offset in: query required: false schema: type: string - description: >- Filters transactions by their `refId` value - returns only transactions with `refId` mentioned in the reference. name: refId in: query required: false schema: type: string - description: >- Returns transactions created on or after this date, inclusive (in ISO 8601 format). name: startDate in: query required: false schema: type: string example: '2022-04-05' - description: >- Returns transactions created on or before this date, inclusive (in ISO 8601 format). name: endDate in: query required: false schema: type: string example: '2022-04-05' - description: Filters transactions by their transaction amount. name: amount in: query required: false schema: type: string - description: Filters transactions by the provider-payment-id. name: providerPaymentId in: query required: false schema: type: string - description: >- Filters transactions by type to include only CREDIT or DEBIT transactions. name: transactionType in: query required: false schema: $ref: '#/components/schemas/TransactionType' example: CREDIT responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetVirtualAccountTransactionsResponse' '400': $ref: '#/components/responses/InvalidArgumentRequest' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/PermissionDeniedResponse' '404': $ref: '#/components/responses/AccountNotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' '500': $ref: '#/components/responses/UnexpectedErrorResponse' '501': $ref: '#/components/responses/NotImplementedResponse' '503': $ref: '#/components/responses/ServiceUnavailableResponse' '504': $ref: '#/components/responses/GatewayTimeoutResponse' deprecated: false x-hideTryItPanel: true /virtual-accounts/{accountId}/transactions/{providerPaymentId}: get: tags: - Virtual Accounts - BETA summary: Get a virtual account transaction operationId: VirtualAccountsBeta_getTransaction security: - BasicAuth: [] - Bearer: [] description: >- The `GET /virtual-accounts/{accountId}/transactions/{provider-payment-id}` endpoint retrieves information for a specific transaction in a given virtual account. parameters: - name: accountId in: path required: true schema: type: string - name: providerPaymentId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetVirtualAccountTransactionResponse' '400': $ref: '#/components/responses/InvalidArgumentRequest' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/PermissionDeniedResponse' '404': $ref: '#/components/responses/AccountNotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' '500': $ref: '#/components/responses/UnexpectedErrorResponse' '501': $ref: '#/components/responses/NotImplementedResponse' '503': $ref: '#/components/responses/ServiceUnavailableResponse' '504': $ref: '#/components/responses/GatewayTimeoutResponse' deprecated: false x-hideTryItPanel: true /virtual-accounts/{account_id}/settlement-rule: post: tags: - Virtual Accounts - BETA summary: Create a settlement rule operationId: VirtualAccountsBeta_createSettlementRule security: - BasicAuth: [] - Bearer: [] description: >- The `POST /virtual-accounts/{account_id}/settlement-rule` endpoint creates a settlement rule for virtual account. parameters: - name: account_id in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVirtualAccountSettlementRuleRequest' required: true responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/CreateVirtualAccountSettlementRuleResponse '400': $ref: '#/components/responses/InvalidArgumentRequest' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/PermissionDeniedResponse' '404': $ref: '#/components/responses/AccountNotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' '500': $ref: '#/components/responses/UnexpectedErrorResponse' '501': $ref: '#/components/responses/NotImplementedResponse' '503': $ref: '#/components/responses/ServiceUnavailableResponse' '504': $ref: '#/components/responses/GatewayTimeoutResponse' deprecated: false x-hideTryItPanel: true /virtual-accounts/{account_id}/settlement-rules/{settlement_rule_id}: get: tags: - Virtual Accounts - BETA summary: Get a settlement rule operationId: VirtualAccountsBeta_getRule security: - BasicAuth: [] - Bearer: [] description: >- The `GET /virtual-accounts/{account_id}/settlement-rules/{settlement_rule_id}` endpoint retrieves information of a settlement rule for virtual account. parameters: - description: The id of the virtual account. name: account_id in: path required: true schema: type: string - description: The id of the settlement rule. name: settlement_rule_id in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetVirtualAccountSettlementRuleResponse' '400': $ref: '#/components/responses/InvalidArgumentRequest' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/PermissionDeniedResponse' '404': $ref: '#/components/responses/SettlementRuleNotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' '500': $ref: '#/components/responses/UnexpectedErrorResponse' '501': $ref: '#/components/responses/NotImplementedResponse' '503': $ref: '#/components/responses/ServiceUnavailableResponse' '504': $ref: '#/components/responses/GatewayTimeoutResponse' deprecated: false x-hideTryItPanel: true delete: tags: - Virtual Accounts - BETA summary: Delete a settlement rule operationId: VirtualAccountsBeta_deleteSettlementRule security: - BasicAuth: [] - Bearer: [] description: >- The ` DELETE /virtual-accounts/{account_id}/settlement-rules/{settlement_rule_id}` endpoint delete an active settlement rule for virtual account. parameters: - description: The id of the virtual account. name: account_id in: path required: true schema: type: string - description: The id of the settlement rule. name: settlement_rule_id in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/DeleteVirtualAccountSettlementRuleResponse '400': $ref: '#/components/responses/InvalidArgumentRequest' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/PermissionDeniedResponse' '404': $ref: '#/components/responses/SettlementRuleNotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' '500': $ref: '#/components/responses/UnexpectedErrorResponse' '501': $ref: '#/components/responses/NotImplementedResponse' '503': $ref: '#/components/responses/ServiceUnavailableResponse' '504': $ref: '#/components/responses/GatewayTimeoutResponse' deprecated: false x-hideTryItPanel: true /virtual-accounts/{account_id}/settlement-rules: get: tags: - Virtual Accounts - BETA summary: Get settlement rules operationId: VirtualAccountsBeta_getSettlementRules security: - BasicAuth: [] - Bearer: [] description: >- The `GET /virtual-accounts/{account_id}/settlement-rules` endpoint retrieves information about settlement rules for the virtual account according to the given settlement rule status in the request. If no status is provided, the endpoint retrieves all settlement rules for the virtual account. parameters: - description: The id of the virtual account. name: account_id in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GetVirtualAccountSettlementRulesRequest' required: true responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GetVirtualAccountSettlementRulesResponse' '400': $ref: '#/components/responses/InvalidArgumentRequest' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/PermissionDeniedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' '500': $ref: '#/components/responses/UnexpectedErrorResponse' '501': $ref: '#/components/responses/NotImplementedResponse' '503': $ref: '#/components/responses/ServiceUnavailableResponse' '504': $ref: '#/components/responses/GatewayTimeoutResponse' deprecated: false x-hideTryItPanel: true /virtual-accounts/{account_id}/settlement-rule-payouts: get: tags: - Virtual Accounts - BETA summary: Get virtual account settlement payouts operationId: VirtualAccountsBeta_getSettlementPayouts security: - BasicAuth: [] - Bearer: [] description: >- The `GET /virtual-accounts/{account_id}/settlement-rule-payouts` endpoint retrieves information about payouts created by a settlement rule. parameters: - description: The id of the virtual account. name: account_id in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/GetVirtualAccountSettlementPayoutsRequest' required: true responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/GetVirtualAccountSettlementPayoutsResponse '400': $ref: '#/components/responses/InvalidArgumentRequest' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/PermissionDeniedResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' '500': $ref: '#/components/responses/UnexpectedErrorResponse' '501': $ref: '#/components/responses/NotImplementedResponse' '503': $ref: '#/components/responses/ServiceUnavailableResponse' '504': $ref: '#/components/responses/GatewayTimeoutResponse' deprecated: false x-hideTryItPanel: true components: parameters: Paging-Limit: description: The maximum number of records to return. name: limit in: query required: true style: form explode: true schema: maximum: 200 minimum: 1 type: integer format: int32 example: 10 Paging-Offset: description: The offset from the previous page. name: offset in: query required: false style: form explode: true schema: type: string example: LerV6Jmex FilterRefund-StartDate: description: >- Lower bound for a refund creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only refunds created at or after the given date will be returned. name: startDate in: query required: false style: form explode: true schema: type: string example: '2010-01-01' FilterRefund-EndDate: description: >- Upper bound for a refund creation date in the format 'YYYY-MM-DD' (UTC time zone). If specified, only refunds created at or before the given date will be returned. name: endDate in: query required: false style: form explode: true schema: type: string example: '2010-01-01' Consent-ID-Header: description: The associated account info consent id. name: consentId in: header required: true style: simple explode: false schema: type: string example: acount-info-consent-1234 PSU-IP-Address: description: >- The forwarded IP Address header field consists of the corresponding http request IP Address field between user and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request. name: psuIpAddress in: header required: false style: simple explode: false schema: type: string format: ipv4 example: 192.168.8.78 PSU-User-Agent: description: >- The forwarded Agent header field of the HTTP request between user and TPP, if available. name: psuUserAgent in: header required: false style: simple explode: false schema: type: string PSU-Device-ID: description: >- The UUID (Universally Unique Identifier) for a user's device, if available. The UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device. name: psuDeviceId in: header required: false style: simple explode: false schema: type: string format: uuid example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555 PSU-Geo-Location: description: >- The forwarded Geo Location of the corresponding http request between user and TPP if available. name: psuGeoLocation in: header required: false style: simple explode: false schema: pattern: GEO:-?[0-9]{1,2}\.[0-9]{6};-?[0-9]{1,3}\.[0-9]{6} type: string example: GEO:52.506931;13.144558 Account-ID: description: >- The account id. Available account ids can be found in the account info consent. name: accountId in: path required: true style: simple explode: false schema: type: string example: '1234567890' Transaction-ID: description: >- The account id. Available account ids can be found in the account info consent. name: transactionId in: path required: true style: simple explode: false schema: type: string example: '1234567890' Payment-ID: description: The payment id. name: paymentId in: path required: true style: simple explode: false schema: type: string example: '1234567890' Standing-Order-ID: description: The standing order id. name: standingOrderId in: path required: true style: simple explode: false schema: type: string example: '1234567890' Consent-ID: description: The consent id. name: consentId in: path required: true style: simple explode: false schema: type: string example: '1234567890' Start-Date: description: >- Optional lower bound for a transaction's booking date as returned by the bank, in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only transactions whose bank booking date is equal to or later than the given date will be regarded. name: startDate in: query required: false style: form explode: true schema: type: string format: date example: '2020-12-12' End-Date: description: >- Optional upper bound for a transaction's booking date as returned by the bank (= original booking date), in the format 'YYYY-MM-DD' (e.g. '2016-01-01'). If specified, then only transactions whose bank booking date is equal to or earlier than the given date will be regarded. name: endDate in: query required: false style: form explode: true schema: type: string format: date example: '2020-12-24' Filter-Ids: description: >- Filters payments by their ids - returns only payments with ids listed in this parameter. name: ids in: query required: false style: form explode: true schema: type: array items: type: string example: - pm2:4QExXrhKTxfShBdcTeqFabqJJhUF:2gFUX1NDgpN - pm2:N5cJDFsQzVca3Qvr8kQocgEnjgX:2gFUX1NEdYA Filter-InvertIds: description: >- Invert ids query - returns only payments with ids not listed in the ids parameter. name: invertIds in: query required: false style: form explode: true schema: type: boolean example: false Filter-Statuses: description: >- Filters payments by their statuses - returns only payments with statuses listed in this parameter. name: statuses in: query required: false style: form explode: true schema: type: array items: $ref: '#/components/schemas/PaymentStatus' example: - INITIATION_COMPLETED - INITIATION_REJECTED Filter-InvertStatuses: description: >- Invert statuses query - returns only payments with statuses not listed in the statuses parameter. name: invertStatuses in: query required: false style: form explode: true schema: type: boolean example: true Filter-CreatedAfter: description: >- Returns only payments created after this time (in ISO 8601 format). name: createdAfter in: query required: false style: form explode: true schema: type: string example: '2022-04-05T17:00:00.000Z' Filter-CreatedBefore: description: >- Returns only payments created before this time (in ISO 8601 format). name: createdBefore in: query required: false style: form explode: true schema: type: string example: '2022-04-05T17:00:00.000Z' Filter-RefIds: description: >- Filters payments by their `refId` values - returns only payments with `refIds` listed in this parameter. name: refIds in: query required: false style: form explode: true schema: type: array items: type: string example: - ShBdcTeqFabqJJhUF - N5cJDFsQzVca3Q Filter-OnBehalfOfId: description: >- Filters payments by the `onBehalfOfId` value - returns only payments with `onBehalfOfId` specified in this parameter. name: onBehalfOfId in: query required: false style: form explode: true schema: type: string example: c5a863bc-86f2-4418-a26f-25b24c7983c7 Filter-RefundStatuses: description: >- Filters payments by their refund status values - returns only payments with refund statuses listed in this parameter. name: refundStatuses in: query required: false style: form explode: true schema: type: array items: $ref: '#/components/schemas/PaymentRefundStatus' example: - PARTIAL - NONE Format-Partial: description: >- Returns payments in a partial format - with only id and status fields populated. name: partial in: query required: false style: form explode: true schema: type: boolean example: true responses: BadResponse: description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' InvalidArgumentRequest: description: The client specified an invalid argument content: application/json: schema: $ref: '#/components/schemas/inline_response_400' UnauthenticatedResponse: description: The authorization information is missing or invalid content: application/json: schema: $ref: '#/components/schemas/inline_response_401' UnexpectedErrorResponse: description: An unexpected or internal server error content: application/json: schema: $ref: '#/components/schemas/VirtualAccountsBetaGetAllResponse' PermissionDeniedResponse: description: Permission to access this endpoint is denied content: application/json: schema: $ref: '#/components/schemas/inline_response_403' CustomerNotFoundResponse: description: The requested entity, such as a TPP, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' AccountNotFoundResponse: description: The requested entity, such as a account, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' BadRequestResponse: description: Bad request content: application/json: schema: $ref: '#/components/schemas/inline_response_400_1' PaymentNotFoundResponse: description: The requested entity, such as a payment, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' SettlementRuleNotFoundResponse: description: The requested entity, such as a settlement rule, was not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404' TooManyRequestsResponse: description: Too many requests content: application/json: schema: $ref: '#/components/schemas/inline_response_429' NotImplementedResponse: description: The operation was not implemented content: application/json: schema: $ref: '#/components/schemas/inline_response_501' ServiceUnavailableResponse: description: Service is unavailable content: application/json: schema: $ref: '#/components/schemas/inline_response_503' GatewayTimeoutResponse: description: Gateway has timed out content: application/json: schema: $ref: '#/components/schemas/inline_response_504' VrpConsentNotFoundResponse: description: VRP consent not found content: application/json: schema: $ref: '#/components/schemas/inline_response_404_1' schemas: Account: description: Contains information about the requested bank account. type: object properties: accountDetails: $ref: '#/components/schemas/AccountDetails' accountFeatures: $ref: '#/components/schemas/AccountFeatures' bankId: description: >- The Token.io bank identifier, identical to the `id` in the repsonse to `GET /banks`. type: string example: goldbank id: description: The system-generated, unique identifier for this account. type: string example: a:8DbPteGnytmMbKXdnWTReeRB6cYWKXZ84JgLTBC7fKL4:5zKcENpV isLocked: description: All services are locked out for this account if `isLocked` = true. type: boolean format: boolean example: false default: false name: description: The unique name of this account. type: string example: John A Smith AccountDetails: description: >- Contains the details needed to identify, correlate and validate the bank account. type: object properties: accountHolderName: description: The name of the account holder/owner. type: string example: John Arthur Smith bic: description: >- 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." type: string example: BOFIIE2D identifier: description: >- The type of `accountIdentifier` being used, e.g., bban, gbDomestic, iban, msisdn, pan or token. type: string example: iban accountIdentifiers: description: >- The account numbers and other strings that identify this as a unique bank account. type: array items: $ref: '#/components/schemas/AccountIdentifier' metadata: description: >- Additional fields returned by the bank in response to your particular request. The presence and type of metadata are dependent on the bank and generally comprise additional information about the account or the transaction pertinent to your specific use case. You define how this information is used when included in the bank's response. type: array items: $ref: '#/components/schemas/AccountDetailsMetadataEntry' providerAccountDetails: description: >- Specific information regarding the bank required by the respective Open Banking API standard adopted (CMA9, NextGenPSD2, PolishAPI, or STET). type: array items: $ref: '#/components/schemas/ProviderAccountDetails' status: description: >- Specifies the bank-defined status of the account (open, closed, active, inactive, etc.) type: string example: Active type: description: Specifies the type of account. type: array items: $ref: '#/components/schemas/AccountDetailsAccountType' currency: description: >- The ISO 4217 three letter currency code. type: string example: EUR AccountDetailsAccountType: description: Specifies the type of account. type: string example: SAVINGS default: INVALID enum: - INVALID - OTHER - CHECKING - SAVINGS - LOAN - CARD AccountDetailsMetadataEntry: description: >- Additional fields returned by the bank in response to your particular request. The presence and type of metadata are dependent on the bank and generally comprise additional information about the account or the transaction pertinent to your specific use case. You define how this information is used when included in the bank's response. type: object additionalProperties: description: >- Bank-defined | [*] – bank-dependent fields 0 .. n; each respective data type is also bank-dependent (string, number, boolean, null/empty, object, or array). type: string AccountFeatures: description: Open Banking features supported for this account. type: object properties: supportsInformation: description: An account available for AIS operations. type: boolean format: boolean example: false default: false supportsReceivePayment: description: An account that can receive money transfers. type: boolean format: boolean example: false default: false supportsSendPayment: description: An account that can send money transfers. type: boolean format: boolean example: false default: false AccountIdentifier: description: >- Account numbers and other strings that identify this as a unique bank account. type: object required: - bankgiro - bban - gbDomestic - iban - msisdn - pan - plus giro - token oneOf: - title: bankgiro properties: bankgiro: $ref: '#/components/schemas/AccountIdentifierBankgiro' - title: bban properties: bban: $ref: '#/components/schemas/AccountIdentifierBban' - title: gbDomestic properties: gbDomestic: $ref: '#/components/schemas/AccountIdentifierGbDomestic' - title: iban properties: iban: $ref: '#/components/schemas/AccountIdentifierIban' - title: msisdn properties: msisdn: $ref: '#/components/schemas/AccountIdentifierMsisdn' - title: pan properties: pan: $ref: '#/components/schemas/AccountIdentifierPan' - title: plusgiro properties: plusgiro: $ref: '#/components/schemas/AccountIdentifierPlusgiro' - title: token properties: token: $ref: '#/components/schemas/AccountIdentifierToken' AccountIdentifierBankgiro: description: The identifier for domestic bank accounts in Sweden. type: object properties: bankgiroNumber: description: >- The unique identifier for the bank account in Sweden (known in Swedish as Bankgironummer); it consists of 7 or 8 digits; the clearing code is not used. type: string example: '56781234' AccountIdentifierBban: type: object properties: bban: description: >- 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. type: string example: NWBK60161331926819 clearingNumber: description: >- 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. type: string example: 87654321 AccountIdentifierGbDomestic: description: A domestic bank account in the UK. type: object properties: accountNumber: description: The unique identifier for the bank account in the UK or Ireland. type: string example: '12345678' sortCode: description: >- The number assigned to a branch of a bank, typically containing six digits and most commonly used in the UK and Ireland. type: string example: 123456 AccountIdentifierIban: description: >- The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. type: object properties: iban: description: >- The International Bank Account Number. This consists of a two-letter country code followed by two check digits and up to thirty-five alphanumeric characters. type: string example: GB29NWBK60161331926819 AccountIdentifierMsisdn: description: >- 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. type: object properties: msisdn: description: >- The MSISDN is composed of the country code and the national destination code. Ensure you remove the + sign and any 0 before the mobile number. type: string example: '447949123456' AccountIdentifierPan: description: >- The Primary Account Number (PAN). 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. type: object properties: pan: description: >- The 14, 15, or 16 digit number generated as a unique identifier for a primary account. type: string example: '4658552288550023' AccountIdentifierPlusgiro: description: >- The domestic transaction clearing system in Sweden. The credit transfer function, which is part of Nordea, and used for mediating payments between accounts held by companies and individuals. type: object properties: plusgiroNumber: description: >- The account number (minimum 2 and maximum 8 digits) for a PlusGiro account. The clearing code is not used. type: string example: '987654' AccountIdentifierToken: description: >- 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. type: object properties: accountId: description: >- The bank account identifier for a linked account used by Token.io's Bank Integration Account Linking Service. type: string example: a:b6037206ca7311ed:afa1 memberId: description: The Token.io-generated member id for the user/account holder. type: string example: m:nP4w3u5y8ddrxDJkjimgSX9e4fZ:5zKtXEAq RefundInfo: description: Contains information about each refund initiation record in the list. type: object properties: account: $ref: '#/components/schemas/AccountIdentifier' name: description: Name of the account. type: string example: John A Smith AddressInfo: description: The complete postal address of a party. type: object properties: city: description: Name of the city as given in postal addresses of the building/area. type: string example: Berlin conscriptionNumber: description: >- 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. type: string example: '2831' country: description: >- A nation with its own government, occupying a particular territory containing the address. type: string example: Germany district: description: >- A defined district within the city or country containing the address. type: string example: Friedrichshain flats: description: House numbers (range or list) of flats behind a door. type: string example: 21A - 21C full: description: >- 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. type: string example: >- Fifth house on the left after the village oak, Smalltown, Smallcountry hamlet: description: >- 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. type: string example: Botzowviertel houseName: description: >- The name of a house. Sometimes used in countries like England instead of (or in addition to) a house number. type: string example: Grossen Blauen Haus houseNumber: description: >- The house number (may contain letters, dashes, or other characters). This identifies a single building with multiple addresses. type: string example: '123' place: description: >- 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`. type: string example: Arnswalder Platz postCode: description: >- An identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. type: string example: '10243' province: description: >- For Canada, uppercase two-letter postal abbreviations, e.g., BC, AB, ON, QC. type: string example: BC state: description: >- For the US, uppercase two-letter postal abbreviations, e.g., AK, CA, HI, NY, TX, WY. type: string example: CA street: description: >- the name of the respective street in which the dwelling or business is located or where mail is received. type: string example: Hans-Otto-Strasse subdistrict: description: A smaller, readily identifiable part of a district. type: string example: Friedrichshain Nord suburb: description: >- Suburbs and localities are the names of geographic subdivisions of urban areas in Australia. type: string example: Altona Meadows Suburb Alias: description: Alternate or additional member identification information. type: object properties: realmId: description: Identifies a member created under the realm of a specific bank. type: string example: m:vHZUAMFt6s64vn6aDyMiwBYbPDN:5zKtXEAq type: $ref: '#/components/schemas/Type' value: description: The alias string representing the type. type: string example: e-sales@token.io Type: description: The types of alias available. type: string example: EMAIL default: INVALID enum: - INVALID - UNKNOWN - EMAIL - PHONE - DOMAIN - BANK - CUSTOM - EIDAS OpenBankingStandard: description: Specifies the API standard adopted by the bank. type: string example: UK_Open_Banking_Standard default: Invalid_Standard enum: - Invalid_Standard - UK_Open_Banking_Standard - Starling_Bank_API - PolishApi - STET_PSD2_API - Citi_Handlowy_PSD2_API - NextGenPsd2 - Slovak_Banking_API_Standard - Czech_Open_Banking_Standard - American_Express_PSD2_API - Budapest_Bank_API Paging: description: Contains the page information for response content. type: object properties: page: description: The index of the current page. type: integer format: int32 example: 15 pageCount: description: The number of records per page. type: integer format: int32 example: 80 perPage: description: The number of total pages. type: integer format: int32 example: 32 totalCount: description: The number of total records. type: integer format: int32 example: 2500 FieldFormatInformation: description: >- Contains bank-dependent formatting constraints indicating allowable characters, if any. type: object properties: constraint: description: >- The regex specifying allowed characters. See https://regexr.com/3cr6fhttps://regexr.com/3cr6f for more details. type: string example: ^[A-Za-z0-9?:()./,'+\-\s]*$ name: description: >- The name of the field in the Token.io `requestpayload` with bank-imposed formatting constraints. type: string example: description path: description: >- The `object.field` path indicating the constrained field's position in the Token.io `requestPayload`. type: string example: credentials.credentials1 MandatoryFields: description: >- Contains the fields required by the bank, which the TPP must populate in the token request, where applicable. type: object properties: access: $ref: '#/components/schemas/MandatoryFieldsAccess' standingOrder: $ref: '#/components/schemas/MandatoryFieldsStandingOrder' transfer: $ref: '#/components/schemas/MandatoryFieldsTransfer' MandatoryFieldsAccess: description: Specifies the mandatory fields for an access token request. type: object properties: domestic: $ref: '#/components/schemas/MandatoryFieldsAccessDomestic' international: $ref: '#/components/schemas/MandatoryFieldsAccessInternational' MandatoryFieldsAccessDomestic: description: Specifies the mandatory fields for an access request. type: object properties: fields: description: The full path to the field within the domestic access request. type: array example: - >- access_body.instructions.access_destinations.customer_data.legal_names - access_body.instructions.source.bic - access_body.instructions.source.account_identifier items: type: string PolishApiFields: description: >- Lists other Polish API fields which must be included in the domestic access request. type: array example: >- access_body.instructions.metadata.provider_access_metadata.polish_api_access_metadata.delivery_mode items: type: string StetFields: description: >- Lists other STET API fields which must be included in the domestic access request. type: array example: >- access_body.instructions.metadata.provider_access_metadata.stet_access_metadata.beneficiary.creditor_agent items: type: string MandatoryFieldsAccessInternational: description: Specifies the mandatory fields for an international access request. type: object properties: fields: description: The full path to the field within the international access request. type: array example: - >- access_body.instructions.access_destinations.customer_data.legal_names - access_body.instructions.source.bic - access_body.instructions.source.account_identifier items: type: string PolishApiFields: description: >- Lists other Polish API fields which must be included in the access request. type: array example: >- access_body.instructions.metadata.provider_access_metadata.polish_api_access_metadata.delivery_mode items: type: string StetFields: description: >- Lists other STET API fields which must be included in the access request. type: array example: >- access_body.instructions.metadata.provider_access_metadata.stet_access_metadata.beneficiary.creditor_agent items: type: string MandatoryFieldsTransferDomestic: description: Specifies the mandatory fields for a domestic transfer. type: object properties: fields: description: The full path to the field within the domestic transfer. type: array example: - >- transfer_body.instructions.transfer_destinations.customer_data.legal_names - transfer_body.instructions.source.bic - transfer_body.instructions.source.account_identifier items: type: string PolishApiFields: description: >- Lists other Polish API fields which must be included in the domestic transfer. type: array example: >- transfer_body.instructions.metadata.provider_transfer_metadata.polish_api_transfer_metadata.delivery_mode items: type: string StetFields: description: >- Lists other STET API fields which must be included in the domestic transfer. type: array example: >- transfer_body.instructions.metadata.provider_transfer_metadata.stet_transfer_metadata.beneficiary.creditor_agent items: type: string MandatoryFieldsTransferInternational: description: Specifies the mandatory fields for an international transfer. type: object properties: fields: description: The full path to the field within the international transfer. type: array example: - >- transfer_body.instructions.transfer_destinations.customer_data.legal_names - transfer_body.instructions.source.bic - transfer_body.instructions.source.account_identifier items: type: string PolishApiFields: description: >- Lists other Polish API fields which must be included in the international transfer. type: array example: >- transfer_body.instructions.metadata.provider_transfer_metadata.polish_api_transfer_metadata.delivery_mode items: type: string StetFields: description: >- Lists other STET API fields which must be included in the international transfer. type: array example: >- transfer_body.instructions.metadata.provider_transfer_metadata.stet_transfer_metadata.beneficiary.creditor_agent items: type: string MandatoryFieldsStandingOrderDomestic: description: Specifies the mandatory fields for a domestic standing order. type: object properties: fields: description: The full path to the field within the domestic standing order. type: array example: - >- standing_order_body.instructions.transfer_destinations.customer_data.legal_names - standing_order_body.instructions.source.bic - standing_order_body.instructions.source.account_identifier items: type: string PolishApiFields: description: >- Lists other Polish API fields which must be included in the domestic standing order. type: array example: >- standing_order_body.instructions.metadata.provider_transfer_metadata.polish_api_transfer_metadata.delivery_mode items: type: string StetFields: description: >- Lists other STET API fields which must be included in the domestic standing order. type: array example: >- standing_order_body.instructions.metadata.provider_transfer_metadata.stet_transfer_metadata.beneficiary.creditor_agent items: type: string MandatoryFieldsStandingOrderInternational: description: Specifies the mandatory fields for an international standing order. type: object properties: fields: description: The full path to the field within the international standing order. type: array example: - >- standing_order_body.instructions.transfer_destinations.customer_data.legal_names - standing_order_body.instructions.source.bic - standing_order_body.instructions.source.account_identifier items: type: string PolishApiFields: description: >- Lists other Polish API fields which must be included in the international token request. type: array example: >- standing_order_body.instructions.metadata.provider_transfer_metadata.polish_api_transfer_metadata.delivery_mode items: type: string StetFields: description: >- Lists other STET API fields which must be included in the international token request. type: array example: >- standing_order_body.instructions.metadata.provider_transfer_metadata.polish_api_transfer_metadata.delivery_mode items: type: string MandatoryFieldsStandingOrder: description: Specifies the mandatory fields for a standing order token request. type: object properties: domestic: $ref: '#/components/schemas/MandatoryFieldsStandingOrderDomestic' international: $ref: '#/components/schemas/MandatoryFieldsStandingOrderInternational' MandatoryFieldsTransfer: description: Specifies the mandatory fields for a transfer token request. type: object properties: domestic: $ref: '#/components/schemas/MandatoryFieldsTransferDomestic' international: $ref: '#/components/schemas/MandatoryFieldsTransferInternational' Attachment: description: >- Contains optional provider blob objects supporting the transfer/transaction. type: object properties: blobId: description: The unique numeric value that references blob data. type: string example: '7124783462147' name: description: >- The name of the attachment. This can contain any combination of characters. type: string example: 3Etyewchj27 type: description: >- Specifies the type of attachment, e.g., image, audio, multimedia, or binary executable code. type: string example: Image Money: description: The balance currency and value. type: object required: - currency - value properties: currency: description: >- The ISO 4217 three letter currency code. type: string example: EUR value: description: >- The transaction amount with up to four digits after the decimal point. type: string example: '10.23' MoneyRequest: description: The balance currency and value. type: object properties: currency: description: >- The ISO 4217 three letter currency code. type: string example: EUR value: description: >- The transaction amount with up to four digits after the decimal point. type: string example: '10.23' CredentialField: description: Contains information used in embedded authentication flows. type: object properties: description: description: The description of the credentials. type: string example: User authentication displayName: description: The display name for the credentials. type: string example: Client ID flickerCode: description: The Flicker code displayed to the user. type: string example: FLICKERCODE id: description: >- Specifies the identifier to be used when passing the value for this credential. type: string example: clientId image: description: A Base64 representation of an image displayed to the user. type: string example: YWJAeXoyWhAeXohteQ options: description: >- A list of options for the user to select from. For example, it can be an SCA method choice (SMS message, phone call etc.), or confirm/decline options for a confirmation page. The customer sends one of the values back to Token.io with the corresponding id. type: array example: - SMS - Phone call items: type: string type: $ref: '#/components/schemas/CredentialFieldType' CredentialFieldType: description: Specifies the type of credential. type: string example: PASSWORD default: INVALID enum: - INVALID - FIELD - PASSWORD - PSU_MESSAGE - IMAGE - FLICKER - DECOUPLED - CONFIRMATION ProviderAccountDetails: description: >- Specific information regarding the bank required by the respective Open Banking API standard adopted (CMA9, NextGenPSD2, PolishAPI, or STET). type: object properties: cma9AccountDetails: $ref: '#/components/schemas/Cma9AccountDetails' nextGenPsd2AccountDetails: $ref: '#/components/schemas/NextGenPsd2AccountDetails' polishApiAccountDetails: $ref: '#/components/schemas/PolishApiAccountDetails' stetAccountDetails: $ref: '#/components/schemas/StetAccountDetails' ProviderTransactionDetails: description: >- Specific information regarding the bank required by the respective Open Banking API standard adopted. type: object properties: budapestApiTransactionDetails: $ref: '#/components/schemas/BudapestApiTransactionDetails' cma9ApiTransactionDetails: $ref: '#/components/schemas/Cma9ApiTransactionDetails' czechApiTransactionDetails: $ref: '#/components/schemas/CzechApiTransactionDetails' nextGenPsd2TransactionDetails: $ref: '#/components/schemas/NextGenPsd2TransactionDetails' polishApiTransactionDetails: $ref: '#/components/schemas/PolishApiTransactionDetails' slovakApiTransactionDetails: $ref: '#/components/schemas/SlovakApiTransactionDetails' stetTransactionDetails: $ref: '#/components/schemas/StetTransactionDetails' ProviderTransferDetails: description: Information about the transfer. type: object properties: id: description: A provider-specific reference id generated upon TPP submission. type: string example: uXmEDV5m2b8ZvLGE91ELf7PPw5BaDab98kMguu status: description: >- The status provided by the bank. This can be the ISO 20022 payment status code. See ISO 20022 payment status codes for more information. type: string example: AcceptedSettlementCompleted ProviderTransferMetadata: description: >- The transfer metadata required under the Open Banking API standard adopted by the bank. type: object oneOf: - title: CMA9 API properties: cma9TransferMetadata: $ref: '#/components/schemas/Cma9TransferMetadata' - title: NextGenPSD2 properties: nextGenPsd2TransferMetadata: $ref: '#/components/schemas/NextGenPsd2TransferMetadata' - title: Polish API properties: polishApiTransferMetadata: $ref: '#/components/schemas/PolishApiTransferMetadata' - title: French PSD2 properties: stetTransferMetadata: $ref: '#/components/schemas/StetTransferMetadata' ScaStatus: description: This status indicates whether the SCA process succeeded or failed. type: string example: AUTHENTICATED default: INVALID enum: - INVALID - AUTHENTICATED - AUTHENTICATION_FAILED - DECLINED_BY_PSU BudapestApiAccountReference: description: >- The unique provider account identifier required under the Budapest Bank API standards. type: object properties: iban: description: >- 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. type: string example: GB29NWBK60161331926819 BudapestApiTransactionDetails: description: >- Provider transaction details required under the Budapest Bank API standards. type: object properties: creditorAccount: $ref: '#/components/schemas/BudapestApiAccountReference' creditorName: description: The name of the creditor/payee. type: string example: ACME Company debtorAccount: $ref: '#/components/schemas/BudapestApiAccountReference' debtorName: description: The name of the debtor/payer. type: string example: John Smith transactionCategory: description: The category for the transaction, e.g., Debit, Credit. type: string example: Credit Cma9CardInstrument: description: >- Card instrument details required under the CMA9 API standard. type: object properties: accountIdentification: type: string example: a:J72REftaRoiaDYRDU7M9FDgf8jeh3eqek9DvKeyBWbuA:3VMczyq7r7b6HwC authorizationType: type: string cardSchemeName: type: string name: type: string Cma9AccountDetails: description: >- Provider account details required under the CMA9 API standard. type: object properties: description: description: A description of the account type. type: string example: Personal accountType: $ref: '#/components/schemas/Cma9AccountDetailsAccountType' accountSubtype: $ref: '#/components/schemas/Cma9AccountDetailsAccountSubtype' address: type: array items: $ref: '#/components/schemas/Cma9AccountDetailsAddress' emailAddress: description: The electronic mail address associated with the account. type: string example: john.smith@email.com mobile: description: The mobile phone number associated with the account. type: string example: 07999 123456 name: description: >- Name of the account, as assigned by the account servicing institution. The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. type: string example: John Smith partyId: description: >- The unique and immutable identifier used to identify the TPP resource; this identifier has no meaning to the account owner. type: string example: '68973542' partyNumber: description: The number assigned by an agent to identify its customer. type: string example: '24354657' partyType: $ref: '#/components/schemas/Cma9AccountDetailsPartyType' phone: description: >- The collection of information that identifies a phone number, as defined by the telecom service. type: string example: 020 123 4567 Cma9AccountDetailsAccountSubtype: description: This specifies the sub type of the account. type: string example: CURRENT_ACCOUNT default: INVALID_ACCOUNT_SUBTYPE enum: - INVALID_ACCOUNT_SUBTYPE - CHARGE_CARD - CREDIT_CARD - CURRENT_ACCOUNT - EMONEY - LOAN - MORTGAGE - PREPAID_CARD - SAVINGS Cma9AccountDetailsAccountType: description: Specifies the type of account. type: string example: PERSONAL_ACCOUNT default: INVALID_ACCOUNT_TYPE enum: - INVALID_ACCOUNT_TYPE - BUSINESS_ACCOUNT - PERSONAL_ACCOUNT Cma9AccountDetailsAddressType: description: Specifies the type of address. type: string example: BUSINESS default: INVALID_ADDRESS_TYPE enum: - INVALID_ADDRESS_TYPE - BUSINESS - CORRESPONDENCE - DELIVERYTO - MAILTO - POBOX - POSTAL - RESIDENTIAL - STATEMENT Cma9AccountDetailsAddress: description: The complete postal address of a party. type: object properties: address: $ref: '#/components/schemas/AddressInfo' addressType: $ref: '#/components/schemas/Cma9AccountDetailsAddressType' Cma9AccountDetailsPartyType: description: The party type, in a coded form. type: string example: JOINT default: INVALID_PARTY_TYPE enum: - INVALID_PARTY_TYPE - DELEGATE - JOINT - SOLE Cma9ApiTransactionDetails: description: >- Provider transaction details required under the CMA9 API standard. type: object properties: creditorAccount: $ref: '#/components/schemas/Cma9CreditorAccount' creditorAgent: $ref: '#/components/schemas/Cma9CreditorAgent' debtorAccount: $ref: '#/components/schemas/Cma9DebtorAccount' debtorAgent: $ref: '#/components/schemas/Cma9DebtorAgent' merchantDetails: $ref: '#/components/schemas/Cma9MerchantDetails' Cma9TransferMetadata: description: >- Transfer metadata required under the CMA9 API standard. type: object properties: endToEndIdentification: description: >- A short reference field to share an invoice or receipt number for your records; this reference is important to the debtor (this 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). type: string instructionIdentification: description: >- The TPP-generated, unique transaction id passed to the bank (mandatory) but does not have to go any further in the payment flow. The expectation is that this is unique indefinitely across all time periods by including a date or date time element to the field, or by inserting a unique id. type: string risk: $ref: '#/components/schemas/Cma9Risk' Cma9CreditorAccount: description: Specifies the payee's account with the creditor. type: object properties: accountIdentification: description: The payee's creditor account id or number. type: string creditorName: description: The name of the payee listed for the creditor account. type: string schemeName: description: The creditor-defined recurring payment scheme name. type: string example: Purchase instalment plan secondaryIdentification: description: Secondary identification required for the transaction. type: string Cma9CreditorAgent: description: >- The unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme. type: object properties: creditorAgentAddress: $ref: '#/components/schemas/DeliveryAddress' creditorAgentName: description: >- The name of financial institution servicing an account for the creditor. type: string example: Creditor bank identification: description: >- The unique identifier for financial institution servicing an account for the creditor. type: string example: '98765432' schemeName: description: The creditor-defined recurring payment scheme name. example: Purchase instalment plan Cma9DebtorAccount: description: >- The source account information for the payment, the payer's bank account. type: object properties: accountIdentification: description: The payer's debtor account id or number. type: string cardInstrument: $ref: '#/components/schemas/Cma9CardInstrument' debtorName: description: The name of the payee listed for the creditor account. type: string schemeName: description: The creditor-defined recurring payment scheme name. type: string example: Purchase instalment plan secondaryIdentification: description: Additional identification required. type: string Cma9DebtorAgent: description: >- The unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme. type: object properties: debtorAgentAddress: $ref: '#/components/schemas/DeliveryAddress' debtorAgentName: description: >- The name of financial institution servicing an account for the debtor. type: string example: Debtor bank. identification: description: >- The unique identifier for financial institution servicing an account for the debtor. type: string schemeName: description: The creditor-defined recurring payment scheme name. type: string example: Purchase instalment plan DeliveryAddress: description: Specifies the recipient's delivery address details. type: object properties: addressLine: description: Specifies the delivery address using multiple lines, as necessary. type: array example: - Flat 2, The Red Lodge, 1 High Street items: type: string addressType: description: Specifies the type of address. type: string example: BUSINESS default: INVALID_ADDRESS_TYPE enum: - INVALID_ADDRESS_TYPE - BUSINESS - CORRESPONDENCE - DELIVERYTO - MAILTO - POBOX - POSTAL - RESIDENTIAL - STATEMENT buildingNumber: description: The building number within the delivery address. type: string example: '1' country: description: >- A nation with its own government, occupying a particular territory containing the address. type: string example: UK countrySubDivision: description: >- Identifies a subdivision of a country; for instance, a state, region, or county. type: array example: - North Yorkshire items: type: string department: description: >- This OBIE specification maps to house number. type: string example: '1' postCode: description: >- An identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. type: string example: YO62 5JB streetName: description: >- The name of the respective street or thoroughfare in which the dwelling or business is located or where mail is received. type: string example: High Street subDepartment: description: >- This OBIE specification maps to flats. type: string example: Flat 2 townName: description: >- The name of a built-up area with defined boundaries and a local government. type: string example: York Cma9MerchantDetails: type: object properties: merchantCategoryCode: description: >- 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." type: string example: 5699-V merchantName: description: The name of the merchant. type: string example: Merchants R US Cma9PaymentContextCode: description: Specifies the context of the payment. type: string example: ECOMMERCE_GOODS enum: - INVALID_PAYMENT_CONTEXT_CODE - BILL_PAYMENT - ECOMMERCE_GOODS - ECOMMERCE_SERVICES - OTHER - PARTY_TO_PARTY Cma9BeneficiaryAccountType: description: To be provided if the AccountType is known. type: string example: BUSINESS enum: - PERSONAL - JOINT_PERSONAL - PERSONAL_SAVINGS_ACCOUNT - BUSINESS - BUSINESS_SAVINGS_ACCOUNT - CHARITY - COLLECTION - CORPORATE - GOVERNMENT - EWALLET - INVESTMENT - ISA - PREMIER - WEALTH - PENSION Cma9Risk: description: This object specifies additional details for risk scoring of payments. type: object properties: deliveryAddress: $ref: '#/components/schemas/DeliveryAddress' merchantCustomerIdentification: description: >- The unique customer identifier for the user with the merchant (maximum 70 characters). type: string example: '0000789123' paymentContextCode: $ref: '#/components/schemas/Cma9PaymentContextCode' paymentPurposeCode: description: >- The category code conforming to the Recommended UK Purpose Code in the ISO 20022 Payment Messaging List, related to the type of services or goods corresponding to the underlying purpose of the payment. This also includes the values listed for STET’s purpose code and OBIE's standards, e.g., CASH, CORT, DVMP, INTC, TREA. type: string beneficiaryAccountType: $ref: '#/components/schemas/Cma9BeneficiaryAccountType' contractPresentIndicator: description: >- This field indicates whether the Payment Service Provider (PSP) has a contract with the payee and has undertaken some form of validation or due diligence on the payee; values: true or false. This field can be pre-populated by Token.io, for PSPs using Token.io's license. type: string example: 'true' beneficiaryPrepopulatedIndicator: description: >- This field indicates whether the PSP, rather than the user, has generated the TRI fields and that the user can't change them during the transaction journey; values: true or false. This field can be pre-populated by the PSP. type: string example: 'true' CzechApiAccountReference: description: >- The unique provider account identifier required under the Czech Standard for Open Banking. type: object properties: iban: description: >- 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. type: string example: GB29NWBK60161331926819 bban: description: >- 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. type: string example: NWBK60161331926819 CzechApiTransactionDetails: description: >- Provider transaction details required under the Czech Standard for Open Banking. type: object properties: creditorAccount: $ref: '#/components/schemas/CzechApiAccountReference' creditorName: description: The name of the creditor/payee. type: string debtorAccount: $ref: '#/components/schemas/CzechApiAccountReference' debtorName: description: The name of the debtor/payer. type: string NextGenPsd2AccountReference: description: >- The unique provider account identifier required under the NextGenPSD2 standard. type: object properties: bban: description: >- 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. type: string example: NWBK60161331926819 currency: description: >- The ISO 4217 three letter currency code. type: string example: EUR iban: description: >- 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. type: string example: GB29NWBK60161331926819 maskedPan: description: >- The masked primary account number; tokenised identification for data protection. type: string msisdn: description: >- 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. type: string example: '447949123456' pan: description: >- 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. type: string example: '4658552288550023' NextGenPsd2AccountDetails: description: >- Provider account details required under the NextGenPSD2 standard. type: object properties: cashAccountType: description: >- The `ExternalCashAccountType1Code` from the ISO 20022 code. type: string currency: description: >- The ISO 4217 three letter currency code. type: string example: EUR details: description: >- The details provided by the bank regarding characteristics of the account or characteristics of the relevant card. type: string linkedAccounts: description: >- In the case of a set of pending card transactions, the relevant cash account the card is set up on; this is the same as the `resourceId` of the relevant cash account. type: string product: description: >- The bank-defined product name for this account; the proprietary definition. type: string usage: description: >- Specifies the usage of the account (PRIV = private personal account, ORGA = professional account). type: string example: PRIV NextGenPsd2TransactionDetails: description: >- Provider transaction details required under the NextGenPSD2 standard. type: object properties: additionalInformation: description: Additional bank-provided information about the transaction. type: string example: Additional bank information domain: $ref: '#/components/schemas/BankTransactionCodeDomain' checkId: description: The identifier for the electronic check, where applicable. type: string example: 4vn6aDyMiwBYbP creditorAccount: $ref: '#/components/schemas/NextGenPsd2AccountReference' creditorId: description: The creditor/payee identifier provided by the bank. type: string example: 4vn6aDyMiwBYbP creditorName: description: The name of the creditor/payee. type: string example: ACME Company currencyExchange: description: The currency exchange rate. type: array items: $ref: '#/components/schemas/NextGenPsd2ReportExchangeRate' debtorAccount: $ref: '#/components/schemas/NextGenPsd2AccountReference' debtorName: description: The name of the debtor/payer. type: string example: John Smith endToEndId: description: >- 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). type: string example: 6aDyMiwB entryReference: description: >- The identification of the transaction referencing delta function on an application level; same id used within camt.05x messages. type: string example: 72REftaRoiaDYRDU mandateId: description: The identifier for mandates; e.g., a SEPA Mandate id. type: string example: DE452399865089 purposeCode: description: >- 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. type: string example: CBLK remittanceInformationStructured: description: >- Structured remittance information; a reference issued by the seller used to establish a link between the payment of an invoice and the invoice instance. type: string example: REf:taRoiaDY34DU ultimateCreditor: description: The ultimate party to which the transfer is due. type: string example: ACME GmbH ultimateDebtor: description: >- The ultimate party that owes that owes money to the (ultimate) creditor. type: string example: John Smith valueDate: description: >- The date, in ISO 8601 format, when funds are posted to an account and available for immediate use. type: string example: '2022-03-27T17:00:00.000Z' NextGenPsd2TransferMetadata: description: >- The transfer metadata required under the NextGenPSD2 standard. type: object properties: creditorAgent: description: >- A unique and unambiguous identifier for a financial institution, as assigned under an internationally recognised or proprietary identification scheme. type: string creditorAgentName: description: >- The name of the financial institution servicing an account for the creditor. type: string endToEndIdentification: description: >- The unique identifier assigned by the initiating party to unambiguously identify the transaction; this identification is passed on, unchanged, throughout the entire end-to-end chain. type: string remittanceInformationStructured: description: >- The information supplied to enable matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts receivable system. type: string NextGenPsd2ReportExchangeRate: description: The currency exchange rate. type: object properties: contractIdentification: description: Identifies the forward or spot exchange contract. type: string exchangeRate: description: >- The rate of exchange between the `sourceCurrencyand` the `targetCurrency`. type: string quotationDate: description: >- The date of the FX quote, in ISO 8601 format. type: string example: '2022-04-05T17:00:00.000Z' sourceCurrency: description: >- The ISO 4217 three letter currency code. type: string example: EUR targetCurrency: description: >- The ISO 4217 three letter currency code. type: string example: EUR unitCurrency: description: The price of one currency expressed in terms of another currency. type: string example: 1.4 to 1. PolishApiAccountHolderType: description: Specifies the type of account holder. type: string example: INDIVIDUAL default: INVALID_ACCOUNT_HOLDER_TYPE enum: - INVALID_ACCOUNT_HOLDER_TYPE - INDIVIDUAL - CORPORATION PolishApiAccountPsuRelation: description: >- The bank-provided information concerning the relationship between the user and an account. type: object properties: stake: description: >- The total value, expressed as a percentage, specifying the user's share of the funds on the account or its liability in the case of credit products; applies to the Owner, Borrower, Guarantor relationship. type: integer format: int32 typeOfProxy: $ref: '#/components/schemas/PolishApiTypeOfProxy' typeOfRelation: $ref: '#/components/schemas/PolishApiTypeOfRelation' PolishApiBank: description: Specifies information about the bank itself. type: object properties: address: description: The physical/mailing address of the bank. type: array example: 45, Torunska, Gdansk items: type: string bicOrSwift: description: >- The standard format for business identifier codes (BIC), used to identify banks and financial institutions globally. type: string example: HBUKGB7F261 code: description: The bank code for foreign transfers. type: string example: BKAFEWFK564 countryCode: description: >- The ISO 3166-1 Alpha 2 country codes in upper case. type: string example: PL name: description: The official name of the bank corresponding to its SWIFT/BIC code. type: string example: Polska Bank PolishApiBankAccountInfo: description: Specifies information about the bank itself. type: object properties: address: description: The physical/mailing address of the bank. type: array items: type: string example: 123 Torunska, Srodmiescie, Gdansk, 62-345 name: description: The official name of the bank corresponding to its SWIFT/BIC code. type: string example: Polska Bank PolishApiCurrencyRate: description: The currency conversion rate information. type: object properties: fromCurrency: description: >- The ISO 4217 three letter currency code for the convert-from currency. type: string example: EUR rate: description: The currency exchange rate. type: number format: double toCurrency: description: >- The ISO 4217 three letter currency code for the convert-to currency. type: string example: EUR PolishApiDeliveryMode: description: The urgency classification for delivery. type: string example: STANDARD_D2 default: INVALID_DELIVERY_MODE enum: - INVALID_DELIVERY_MODE - STANDARD_D2 - STANDARD_D1 - URGENT_D1 - EXPRESS_D0 PolishApiNameAddress: description: Doing Business As (DBA) and/or other names and addresses of the company. type: object properties: value: description: The bank-defined name and postal address. type: array items: type: string example: ACME Business Ltd, 299 Zywiecka, Gdansk PolishApiPayer: description: Information about the tax payer. type: object properties: payerId: description: The payer's tax id. type: string example: '444433332211' payerIdType: description: The type of tax payer id. type: string example: R default: 'N' enum: - 'N' - P - R - '1' - '2' - '3' PolishApiAccountDetails: description: >- The provider account details required under the Polish API standard. type: object properties: accountHolderType: $ref: '#/components/schemas/PolishApiAccountHolderType' accountNameClient: description: Specifies the account owner name. type: string auxData: $ref: '#/components/schemas/PolishApiAccountDetailsAuxDataEntry' bank: $ref: '#/components/schemas/PolishApiBankAccountInfo' currency: description: >- The ISO 4217 three letter currency code. type: string example: EUR nameAddress: $ref: '#/components/schemas/PolishApiNameAddress' psuRelations: description: >- The bank-provided information concerning the relationship between the user and an account. type: array items: $ref: '#/components/schemas/PolishApiAccountPsuRelation' PolishApiAccountDetailsAuxDataEntry: description: The bank-defined auxiliary data associated with the account. type: object additionalProperties: description: >- Bank-defined | [*] – bank-dependent fields 0 .. n; each respective data type is also bank-dependent (string, number, boolean, null/empty, object, or array). type: string PolishApiTransactionDetails: description: >- The provider transaction details required under the Polish API standard. type: object properties: accountBaseCurrency: description: >- The ISO 4217 three letter currency code for the account's currency. type: string example: EUR auxData: $ref: '#/components/schemas/PolishApiTransactionDetails.AuxDataEntry' baseCurrency: description: >- The ISO 4217 three letter currency code for the transaction's currency. type: string example: EUR cardInfo: $ref: '#/components/schemas/PolishApiTransactionInfoCard' currencyDate: description: The transaction currency valuation date. type: string holdExpirationDate: description: >- The date the bank hold expires, in < ISO 8601 format. type: string example: '2022-11-12T17:00:00.000Z' initiator: $ref: '#/components/schemas/PolishApiNameAddress' mcc: description: The code for each transaction or operation performed by card. type: string example: 5699-V postTransactionBalance: description: The account balance after the transaction. type: string recipient: $ref: '#/components/schemas/PolishApiSenderRecipient' rejectionDate: description: >- The date, in ISO 8601 format, when the transaction was rejected. type: string example: '2022-10-23T17:00:00.000Z' rejectionReason: description: The reason the transaction was rejected. type: string sender: $ref: '#/components/schemas/PolishApiSenderRecipient' taxInfo: $ref: '#/components/schemas/PolishApiTransactionInfoTax' tppName: description: The name of the third-party provider. type: string example: Mario's Pizzas tppTransactionId: description: The TPP's unique transaction Identifier. type: string example: esaWvvr4l32iaDRqvrekkfwe212vsfvkcddEaVFaVR:4DVLaMVWER4VC6b tradeDate: description: >- The date of the transaction operation, in ISO 8601 format. type: string example: '2022-11-30T17:00:00.000Z' transactionRate: type: array items: $ref: '#/components/schemas/PolishApiCurrencyRate' transactionType: description: The type of transaction. type: string example: CREDIT default: CREDIT enum: - CREDIT - DEBIT usedPaymentInstrumentId: description: >- The unique identifier of the payment instrument used to execute the transaction/payment instrument id. type: string zusInfo: $ref: '#/components/schemas/PolishApiTransactionInfoZus' PolishApiTransactionDetails.AuxDataEntry: description: The bank-defined auxiliary data associated with the account. type: object additionalProperties: description: >- Bank-defined | [*] – bank-dependent fields 0 .. n; each respective data type is also bank-dependent (string, number, boolean, null/empty, object, or array). type: string PolishApiTransferMetadata: description: >- Transfer metadata required under the Polish API standard. type: object properties: deliveryMode: $ref: '#/components/schemas/PolishApiDeliveryMode' hold: description: >- Indicates whether payment should be held until confirmation of delivery. type: boolean format: boolean example: false default: false PolishApiSenderRecipient: description: Information about the recipient. type: object properties: accountMassPayment: description: The virtual account number of the recipient/virtual account name. type: string accountNumber: description: The recipient's account number. type: string example: 87654321 bank: $ref: '#/components/schemas/PolishApiBank' nameAddress: $ref: '#/components/schemas/PolishApiNameAddress' PolishApiSocialSecurityPayer: description: >- The information associated with payer social security; i.e., Polish Security Institution (ZUS). type: object properties: additionalPayerId: description: The payer's additional identification number. type: string additionalPayerIdType: description: The type of additional payer id. type: string nip: description: The payer's tax identification number. type: string example: '444433332211' PolishApiTransactionInfoCard: description: The information about the card used in/for the transaction. type: object properties: cardHolder: description: The name of the cardholder. type: string example: Piotr Brama cardNumber: description: The card account number. type: string example: '5687243201834817' PolishApiTransactionInfoTax: description: The data for a tax transfer to the Tax Office or Customs Chamber. type: object properties: formCode: description: The data for a tax transfer to the Tax Office or Customs Chamber. type: string example: 49DtA9CoF9qYzh77FA9nVrCn2jia:5zKtXEAq obligationId: description: >- The identifier of the liability from which the tax is due; e.g., decision, executive title, resolution. type: string example: DECISION payerInfo: $ref: '#/components/schemas/PolishApiPayer' periodId: description: The tax period number. type: string example: '11' periodType: description: The tax period type. type: string example: Month year: description: The tax year (YYYY). type: integer format: int32 example: 2022 PolishApiTransactionInfoZus: description: >- Data information for transfers to ZUS. type: object properties: contributionId: description: The declaration number/contribution identifier. type: string contributionPeriod: description: The declaration period/contribution period in MMYYYY format. type: string contributionType: description: The contribution type. type: string obligationId: description: The execution title number/obligation identifier or number. type: string payerInfo: $ref: '#/components/schemas/PolishApiSocialSecurityPayer' paymentTypeId: description: The payment type identifier. type: string PolishApiTypeOfProxy: description: >- The type of user's power of attorney for the payment account; required when the relationship type is an account representative. type: string example: GENERAL default: INVALID_TYPE_OF_PROXY enum: - INVALID_TYPE_OF_PROXY - GENERAL - SPECIAL - ADMINISTRATOR - USER PolishApiTypeOfRelation: description: The type of relation between the user and the account. type: string example: OWNER default: INVALID_TYPE_OF_RELATION enum: - INVALID_TYPE_OF_RELATION - OWNER - BORROWER - GUARANTOR - PROXY_OWNER - BENEFICIARY - TRUSTEE slovakApiCreditorAccountReference: description: Information about the payee/creditor's account. type: object properties: iban: description: >- 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. type: string example: GB29NWBK60161331926819 bban: description: >- 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. type: string example: NWBK60161331926819 slovakApiDebtorAccountReference: description: Information about the payer/debtor's account. type: object properties: iban: description: >- 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. type: string example: GB29NWBK60161331926819 bban: description: >- 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. type: string example: NWBK60161331926819 SlovakApiTransactionDetails: description: >- Provider transaction details required under the Slovak Banking API Standard. type: object properties: creditorAccount: $ref: '#/components/schemas/slovakApiCreditorAccountReference' creditorName: description: The name of creditor/payee. type: string debtorAccount: $ref: '#/components/schemas/slovakApiDebtorAccountReference' debtorName: description: The name of the debtor/payer. type: string StetAccountIdentification: description: Bank-defined account identifiers. type: object properties: currency: description: >- The ISO 4217 three letter currency code. type: string example: EUR other: $ref: '#/components/schemas/StetGenericIdentification' StetCreditorAccountReference: description: Information about the payee/creditor's account. type: object properties: iban: description: >- 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. type: string example: GB29NWBK60161331926819 StetDebtorAccountReference: description: Information about the payer/debtor's account. type: object properties: iban: description: >- 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. type: string example: GB29NWBK60161331926819 StetBeneficiary: description: The creditor or payee receiving the transfer. type: object properties: creditor: $ref: '#/components/schemas/StetPartyIdentification' creditorAccount: $ref: '#/components/schemas/StetAccountIdentification' creditorAgent: $ref: '#/components/schemas/StetFinancialInstitutionIdentification' id: description: >- The unique identification of an account, a person, or an organisation assigned by an issuer. type: string StetClearingSystemMemberIdentification: description: >- Identifies a member within a clearing system; to be used for certain international credit transfers in order to identify the beneficiary bank. type: object properties: clearingSystemId: description: >- The specification of a pre-agreed offering between clearing agents or the channel through which the payment instruction is processed. type: string memberId: description: Identification of a member of a clearing system. type: string example: m:49DtA9CoF9qYzh77FA9nVrCn2jia:5zKtXEAq StetFinancialInstitutionIdentification: description: >- The unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme. type: object properties: bicFi: description: >- The code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)". type: string clearingSystemMemberId: $ref: '#/components/schemas/StetClearingSystemMemberIdentification' name: description: >- The name by which the party is known and which is usually used to identify that party. type: string example: Credit Bureau postalAddress: $ref: '#/components/schemas/StetPostalAddressCreditor' StetGenericIdentification: description: Bank-defined account information. type: object properties: identification: description: The alias of the account. type: string issuer: description: >- The entity that assigned the identification; country code or any organisation name or identifier that can be recognized by both parties. type: string schemeName: description: >- The name of the identification scheme. Possible values for the scheme name, partially based on ISO 20022 external code list, are (a) BANK (BankPartyIdentification): Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client; (b) COID (CountryIdentificationCode) : Country authority given organisation identification; e.g., corporate registration number; (c) SREN (SIREN): 9-digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France; (d) SRET (SIRET): 14-digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France; consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity; (e) NIDN (NationalIdentityNumber): assigned by an authority to identify the national identity number of a person. Other values are also permitted, for instance: - OAUT (OAUTH2): OAUTH2 access token that is owned by the Payment Initiation Service Provider (PISP) being also an Account Information Service Provider (AISP) and that can be used in order to identify the user - CPAN (CardPan): Card PAN. type: string StetPartyIdentification: description: >- The ISO 20022 information about the party; this can be either a person or an organisation. type: object properties: name: description: >- The name by which the party is known and which is usually used to identify that party. type: string example: John Smith organisationId: $ref: '#/components/schemas/StetGenericIdentification' postalAddress: $ref: '#/components/schemas/StetPostalAddress' privateId: $ref: '#/components/schemas/StetGenericIdentification' StetPaymentTypeInformation: description: A set of elements used to further specify the type of transaction. type: object properties: categoryPurpose: description: >- Specifies the high level purpose of the instruction based on a set of pre-defined categories; used by the initiating party to provide information concerning the processing of the payment and is likely to trigger special processing by any of the agents involved in the payment chain. Available values: type: string example: DVPM default: CASH enum: - CASH - CORT - DVPM instructionPriority: description: >- Indicates the urgency or order of importance the instructing party would like to apply to processing; can be ignored for SCTInst (SEPA Instant). type: string example: SAMEDAY localInstrument: description: >- Used to specify a local instrument, local clearing option and/or further qualify the service or service level. For example, INST is used to ask for SEPA instant Payment (SCTInst). For International payments, this field may be valued with one of the ISO 20022 external codes to specify which payment instrument should be used by the creditor's bank. type: string example: INST serviceLevel: description: Only SEPA is allowed. type: string example: SEPA StetPostalAddress: description: Contains the mailing address of the creditor. type: object properties: addressLine: description: Up to 4 lines that capture the mailing address. type: array items: type: string example: Appartement 3a, 35 Rue de Bologne, Marseilles country: description: >- A nation with its own government, occupying a particular territory containing the address. type: string example: La France StetPostalAddressCreditor: description: Contains the mailing address of the creditor. type: object properties: addressLine: description: Up to 4 lines that capture the mailing address. type: array items: type: string example: 47 La Grande Rue, Paris country: description: >- A nation with its own government, occupying a particular territory containing the address. type: string example: La France StetRegulatoryReportingCodes: description: >- Contains the list of needed regulatory reporting codes for international payments. type: object properties: regulatoryReportingCode: description: Regulatory and statutory codes provided by the NCA. type: array items: type: string StetAccountDetails: description: >- The provider account details required under the French PSD2 API standard. type: object properties: accountId: $ref: '#/components/schemas/StetAccountIdentification' cashAccountType: description: Specifies the type of account. type: string details: description: >- The bank-defined characteristics of the account or characteristics of the card. type: string linkedAccount: description: The relevant cash account that the card is set up on. type: string product: description: >- The bank-defined product name for this account; the proprietary definition. type: string example: Green Savings Account psuStatus: description: >- The relationship between the user and the account; e.g., Account Holder, Co-account Holder, Attorney. type: string example: Account Holder usage: description: >- Specifies the usage of the account (PRIV = private personal account, ORGA = professional account). type: string example: PRIV StetTransactionDetails: description: >- The provider account details required under the French PSD2 API standard. type: object properties: creditorAccount: $ref: '#/components/schemas/StetCreditorAccountReference' creditorName: description: The name of creditor/payee. type: string debtorAccount: $ref: '#/components/schemas/StetDebtorAccountReference' debtorName: description: The name of the debtor/payer. type: string entryReference: description: >- The technical incremental identification of the transaction for reconciliation by the TPP. type: string transactionDate: description: >- type: string valueDate: description: The value date of the transaction on the account. type: string example: '2023-08-11' StetTransferMetadata: description: >- Transfer metadata required under the French PSD2 API standard. type: object properties: beneficiary: $ref: '#/components/schemas/StetBeneficiary' debtorAgent: $ref: '#/components/schemas/StetFinancialInstitutionIdentification' endToEndId: description: >- The unique identification assigned by the initiating party to unambiguously identify the transaction, which is passed on, unchanged, throughout the entire end-to-end chain. type: string executionRule: description: >- The execution date-shifting rule when a recurring payment date falls on a weekend or bank holiday; payment is then executed either the "preceding" or "following" working day in accordance with bank policy. type: string paymentTypeInformation: $ref: '#/components/schemas/StetPaymentTypeInformation' regulatoryReportingCodes: $ref: '#/components/schemas/StetRegulatoryReportingCodes' Signature: description: Contains information about the signing party. type: object properties: keyId: description: >- The id of the public key used to verify the signature. This is only present if a `tokenId` is present. It can be used to validate that the provided `tokenId` corresponds to the token request (this is needed for Hosted Pages flows only). type: string example: CqSTHPvWY_dgVh-f memberId: description: The Token.io member id of the signing member. type: string example: m:nP4w3u5y8ddrxDJkjimgSX9e4fZ:5zKtXEAq signature: description: The Base64url-encoded ciphertext signature. type: string example: >- ODRWmM0xMRM7CKmK3bNl4e2Kb2btavTbZssCsrHsu8yopoKxBzouBrD9q5-E63tgdV1DpB7i31vwNDKywA0CAE AccessBody: description: >- Contains the request payload for a token representing account information access permissions. type: object properties: resources: type: array items: $ref: '#/components/schemas/AccessBodyResource' transactionHistoryDays: description: The number of transaction history days. type: integer format: int32 example: 4 AccessBodyResource: description: >- The body case seeking access to one or more resources for a single account. type: object properties: account: $ref: '#/components/schemas/AccessBodyResourceAccount' balance: $ref: '#/components/schemas/AccessBodyResourceAccountBalance' fundsConfirmation: $ref: '#/components/schemas/AccessBodyResourceFundsConfirmation' standingOrders: $ref: '#/components/schemas/AccessBodyResourceAccountStandingOrders' transactions: $ref: '#/components/schemas/AccessBodyResourceAccountTransactions' transferDestinations: $ref: '#/components/schemas/AccessBodyResourceTransferDestinations' AccessBodyResourceAccount: description: Specifies the account and resource for which access is being requested. type: object properties: accountId: description: >- The account number and associated information that identify a unique bank account. type: string example: a:b6037206ca7311ed:afa1 AccessBodyResourceAccountBalance: type: object properties: accountId: description: >- The account number and associated information that identify a unique bank account. type: string example: '5291.27' AccessBodyResourceAccountStandingOrders: type: object properties: accountId: description: The unique identifier for the bank account. type: string example: a:J72REftaRoiaDYRDU7M9FDgf8jeh3eqek9DvKeyBWbuA:3VMczyq7r7b6HwC AccessBodyResourceAccountTransactions: type: object properties: accountId: description: The unique identifier for the bank account. type: string AccessBodyResourceFundsConfirmation: type: object properties: accountId: description: The unique identifier for the bank account. type: string example: a:J72REftaRoiaDYRDU7M9FDgf8jeh3eqek9DvKeyBWbuA:3VMczyq7r7b6HwC AccessBodyResourceTransferDestinations: type: object properties: accountId: description: The unique identifier for the bank account. type: string example: a:J72REftaRoiaDYRDU7M9FDgf8jeh3eqek9DvKeyBWbuA:3VMczyq7r7b6HwC ActingAs: description: Specifies another party for whom the token was created 'on behalf of'. type: object properties: displayName: description: >- The name of the recipient shown to the user; required when specifying `actingAs`, optional otherwise. type: string example: The Great Baking Co. refId: description: >- The sub-TPP identifier generated by Token.io once a merchant has been onboarded (36 chars). type: string example: 9htio4a1sp2akdr1aa secondaryName: description: >- The domain or email address of the recipient shown to the user along with the `displayName`. type: string example: jane.doe@company.com ExternalAuthorizationDetails: description: Contains the external authorization details provided by the bank. type: object properties: authorizationUrl: description: >- Content displayed from this URL prompts the user for permission to initiate the standing order. type: string example: https://your-standing-order-credentials.com StandingOrderBody: title: PIS - Standing Orders description: >- Contains the request payload for a token representing a standing order/recurring payment. type: object required: - amount - currency - instructions properties: amount: description: >- Specifies the transaction amount, with up to four digits after the decimal point, for payments scheduled according to frequency. type: string example: '10.23' currency: description: >- The ISO 4217 three letter currency code. type: string example: EUR endDate: description: >- Date when regularly scheduled payments end, in ISO 8601 format. type: string example: '2022-09-13' frequency: description: >- Specifies the ISO 20022 code for the scheduled frequency of standing order payments occurring between the first and final payments. Options: type: string example: WEEK instructions: $ref: '#/components/schemas/TransferInstructions' remittanceReference: description: >- Creditor's reference for matching an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts receivable system. type: string example: 64vn6aDyMiwBYbPDN:5zKtXEAq returnRefundAccount: description: >- Requests that a refund account be returned in the response of `GET transfers` for any amounts refunded. type: boolean format: boolean example: false default: false startDate: description: >- The date when the regularly scheduled payments will start; uses YYYY-MM-DD or YYYYMMDD format. type: string example: '2022-09-13' Token: description: >- Contains the details of each requested token returned according to the request's filtering parameters type: object properties: id: description: >- Identifies a unique authorization token for a transfer, standing order, or account information access. type: string example: ta:3eYPU1BEKKunfmYgQuSKXFCeo851C5Y3XiZW3XA465TU:5zKtXEAq payload: $ref: '#/components/schemas/TokenPayload' payloadSignatures: type: array items: $ref: '#/components/schemas/TokenSignature' replacedByTokenId: description: The id of the latest token replacing the original `tokenId`. type: string example: ta:BzFCFwVt5zrt6rdcHJK5imf2HXbGdVdyHKpWQZbgzL5s:qXTkpBAZVbXMxk9vi tokenRequestId: description: Identifies the original token request. type: string example: rq:ej5ACWNwi1EcqBeuDPc4Z8C4Bgc:5zKtXEAq TokenMember: description: Contains information identifying the requesting Token.io member. required: - id type: object properties: alias: $ref: '#/components/schemas/Alias' id: description: The Token.io-assigned `memberId` of the TPP. type: string example: m:nP4w3u5y8ddrxDJkjimgSX9e4fZ:5zKtXEAq TokenOperationResult: description: Contains details about the canceled token. type: object properties: status: $ref: '#/components/schemas/TokenOperationResultStatus' token: $ref: '#/components/schemas/Token' TokenOperationResultStatus: description: >- Specifies the success or failure of the cancellation, the condition can be avoided by using a PRIVILEGED signature, rather than LOW or STANDARD. type: string example: SUCCESS default: INVALID enum: - INVALID - SUCCESS - MORE_SIGNATURES_NEEDED TokenPayload: description: Contains the details about the token specified by id. type: object oneOf: - title: PIS - Payments properties: transfer: $ref: '#/components/schemas/TransferBody' - title: PIS - Standing Orders properties: standingOrder: $ref: '#/components/schemas/StandingOrderBody' - title: AIS properties: access: $ref: '#/components/schemas/AccessBody' properties: description: description: >- Description of the payment with the following qualifiers