Alternative to webhooks

If you're not using webhooks, you'll need to use GET /token-requests/{tokenRequestId}/result to obtain the transferId in order to call the GET /transfers/{transferId}.

  1. TPP -> Token.io - On receiving the callback from Token.io the TPP first checks the token request status using the GET /token-requests/{tokenRequestId}/result call.

  2. Token.io -> TPP - Token.io responds to the GET /token-requests/{tokenRequestId}/result call. If the token-request status is PROCESSED, the response should contain the transferId. The TPP will keep calling the GET /token-requests/{tokenRequestId}/result endpoint until the status has moved from PENDING to PROCESSED and the transferId has been received.

    A REJECTED token-request status means that the request has been rejected by either Token.io or the bank, and the user was not asked to authorize the payment.

  3. TPP -> Token.io - Once the response to the GET /token-requests/{tokenRequestId}/result call contains the transferId, the TPP uses the GET /transfers/{transferId} request.

  1. Token.io -> TPP - Token.io confirms the payment status in the GET /transfers/{transferId} response.

  2. If the status is non-final, e.g., PROCESSING, the TPP should use a polling call (GET /transfers/{transferId}) every 15 mins.

Refer to the Token.io API Reference for additional details.

Restricted beneficiary accounts (optional)

Transfer destinations are typically TPP-controlled accounts administered for appropriate funds distribution according to the governing regulations where the TPP is licensed. You can create a list of beneficiary accounts to restrict your transfer destinations. This step is optional.

The transfer destinations designated in your PIS calls can be manually added to the dashboard.

Please contact Support to use this feature.

In all cases, for proper payment request initiation, execution, and funds transfer to the correct beneficiary account(s), take the following steps:

  1. Sign in to the Dashboard and select Beneficiary under Settings.
    The List of Accounts is displayed; initially, your list will be empty until you make some entries. Here you can Add, Modify and Delete accounts.

  2. Add an account by clicking the Add button, then enter the required information: Account Name, Currency, Country, Account Type, and IBAN. BIC is optional.

  3. Click Save to add the information.

Once saved, beneficiary accounts in the list are available as transfer destinations for the payments you initiate by specifying the Account Number/IBAN and optional BIC, as appropriate.

The BIC manager can be used to further control what can be added to the list of restricted beneficiaries.

  1. On the List of Accounts page, click the BIC Manager button.

  2. On the BIC Manager page, click the Add new BIC button, then enter the required information: BIC, Bank Name.

  3. Click Save to add the information.

If the BIC manager list is empty, any IBAN can be added to the list of allowed beneficiaries. If, however, a BIC has been added via the BIC manager, then only IBANs belonging to that BIC can be added to the list of allowed beneficiaries.

The BIC and IBAN are validated upon saving to ensure only those that are valid can be saved.

Entering a BIC in the BIC manager without adding any IBANs to the list of allowed IBANs, does not have an impact on transactions. The beneficiary on a given transaction is only validated if there is at least one entry on the allowed beneficiaries list, the BIC manager only controls what can be added to that list.

Alternative to webhooks

If you're not using webhooks, you'll need to use GET /token-requests/{tokenRequestId}/result to obtain the transferId in order to call the GET /transfers/{transferId}.

  1. TPP -> Token.io - On receiving the callback from Token.io the TPP first checks the token request status using the GET /token-requests/{tokenRequestId}/result call.

  2. Token.io -> TPP - Token.io responds to the GET /token-requests/{tokenRequestId}/result call. If the token-request status is PROCESSED, the response should contain the transferId. The TPP will keep calling the GET /token-requests/{tokenRequestId}/result endpoint until the status has moved from PENDING to PROCESSED and the transferId has been received.

    A REJECTED token-request status means that the request has been rejected by either Token.io or the bank, and the user was not asked to authorize the payment.

  3. TPP -> Token.io - Once the response to the GET /token-requests/{tokenRequestId}/result call contains the transferId, the TPP uses the GET /transfers/{transferId} request.

  1. Token.io -> TPP - Token.io confirms the payment status in the GET /transfers/{transferId} response.

  2. If the status is non-final, e.g., PROCESSING, the TPP should use a polling call (GET /transfers/{transferId}) every 15 mins.

Refer to the Token.io API Reference for additional details.

Restricted beneficiary accounts (optional)

Transfer destinations are typically TPP-controlled accounts administered for appropriate funds distribution according to the governing regulations where the TPP is licensed. You can create a list of beneficiary accounts to restrict your transfer destinations. This step is optional.

The transfer destinations designated in your PIS calls can be manually added to the dashboard.

Please contact Support to use this feature.

In all cases, for proper payment request initiation, execution, and funds transfer to the correct beneficiary account(s), take the following steps:

  1. Sign in to the Dashboard and select Beneficiary under Settings.
    The List of Accounts is displayed; initially, your list will be empty until you make some entries. Here you can Add, Modify and Delete accounts.

  2. Add an account by clicking the Add button, then enter the required information: Account Name, Currency, Country, Account Type, and IBAN. BIC is optional.

  3. Click Save to add the information.

Once saved, beneficiary accounts in the list are available as transfer destinations for the payments you initiate by specifying the Account Number/IBAN and optional BIC, as appropriate.

The BIC manager can be used to further control what can be added to the list of restricted beneficiaries.

  1. On the List of Accounts page, click the BIC Manager button.

  2. On the BIC Manager page, click the Add new BIC button, then enter the required information: BIC, Bank Name.

  3. Click Save to add the information.

If the BIC manager list is empty, any IBAN can be added to the list of allowed beneficiaries. If, however, a BIC has been added via the BIC manager, then only IBANs belonging to that BIC can be added to the list of allowed beneficiaries.

The BIC and IBAN are validated upon saving to ensure only those that are valid can be saved.

Entering a BIC in the BIC manager without adding any IBANs to the list of allowed IBANs, does not have an impact on transactions. The beneficiary on a given transaction is only validated if there is at least one entry on the allowed beneficiaries list, the BIC manager only controls what can be added to that list.

Alternative to webhooks

If you're not using webhooks, you'll need to use GET /token-requests/{tokenRequestId}/result to obtain the transferId in order to call the GET /transfers/{transferId}.

  1. TPP -> Token.io - On receiving the callback from Token.io the TPP first checks the token request status using the GET /token-requests/{tokenRequestId}/result call.

  2. Token.io -> TPP - Token.io responds to the GET /token-requests/{tokenRequestId}/result call. If the token-request status is PROCESSED, the response should contain the transferId. The TPP will keep calling the GET /token-requests/{tokenRequestId}/result endpoint until the status has moved from PENDING to PROCESSED and the transferId has been received.

    A REJECTED token-request status means that the request has been rejected by either Token.io or the bank, and the user was not asked to authorize the payment.

  3. TPP -> Token.io - Once the response to the GET /token-requests/{tokenRequestId}/result call contains the transferId, the TPP uses the GET /transfers/{transferId} request.

  1. Token.io -> TPP - Token.io confirms the payment status in the GET /transfers/{transferId} response.

  2. If the status is non-final, e.g., PROCESSING, the TPP should use a polling call (GET /transfers/{transferId}) every 15 mins.

Refer to the Token.io API Reference for additional details.

Restricted beneficiary accounts (optional)

Transfer destinations are typically TPP-controlled accounts administered for appropriate funds distribution according to the governing regulations where the TPP is licensed. You can create a list of beneficiary accounts to restrict your transfer destinations. This step is optional.

The transfer destinations designated in your PIS calls can be manually added to the dashboard.

Please contact Support to use this feature.

In all cases, for proper payment request initiation, execution, and funds transfer to the correct beneficiary account(s), take the following steps:

  1. Sign in to the Dashboard and select Beneficiary under Settings.
    The List of Accounts is displayed; initially, your list will be empty until you make some entries. Here you can Add, Modify and Delete accounts.

  2. Add an account by clicking the Add button, then enter the required information: Account Name, Currency, Country, Account Type, and IBAN. BIC is optional.

  3. Click Save to add the information.

Once saved, beneficiary accounts in the list are available as transfer destinations for the payments you initiate by specifying the Account Number/IBAN and optional BIC, as appropriate.

The BIC manager can be used to further control what can be added to the list of restricted beneficiaries.

  1. On the List of Accounts page, click the BIC Manager button.

  2. On the BIC Manager page, click the Add new BIC button, then enter the required information: BIC, Bank Name.

  3. Click Save to add the information.

If the BIC manager list is empty, any IBAN can be added to the list of allowed beneficiaries. If, however, a BIC has been added via the BIC manager, then only IBANs belonging to that BIC can be added to the list of allowed beneficiaries.

The BIC and IBAN are validated upon saving to ensure only those that are valid can be saved.

Entering a BIC in the BIC manager without adding any IBANs to the list of allowed IBANs, does not have an impact on transactions. The beneficiary on a given transaction is only validated if there is at least one entry on the allowed beneficiaries list, the BIC manager only controls what can be added to that list.

 

If you have any feedback about the developer documentation, please contact devdocs@token.io

© 2025 TOKEN, INC.     ALL RIGHTS RESERVED.