Tokens

Cancel a token

The PUT /tokens/{tokenId}/cancel endpoint cancels a given token.

put/tokens/{tokenId}/cancel

Request

  • Base URL
    https://api.token.io
  • URL
    https://api.token.io/tokens/{tokenId}/cancel
  • Auth
    • HTTP bearer
    • or API key in header Authorization

Path parameters

tokenIdstring required
Example:ta:3eYPU1BEKKunfmYgQuSKXFCeo851C5Y3XiZW3XA465TU:5zKtXEAq

Identifies a unique authorization token for a transfer, standing order, or account information access.

Headers

token-customer-ip-addressstring ipv4

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>i.e.</i>, 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.

customer-initiatedboolean

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>i.e.</i>, within the same 24-hour period) access limit on the same AISP, in accordance with RTS regulations.

token-customer-device-idstring

Obtained by the TPP from details in the user agent information of the user.

Response

Successful response

Changes

No recorded changes to this operation across all 5 revisions of this API.