Sign in

v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB
Requests - for Payments v1 or AIS

Initiate bank authorization

The POST /token-requests/{tokenRequestId}/authorization endpoint initiates the bank authorization process with a given bank id and token request id.

post/token-requests/{tokenRequestId}/authorization

Path parameters

tokenRequestIdstring required
Example:rq:ej5ACWNwi1EcqBeuDPc4Z8C4Bgc:5zKtXEAq

The token request id received in response to the original token request.

Request body

consentAcceptedboolean

This flag indicates whether the user has grated consent for the payment in the TPP's user interface.

credentialsInitiateBankAuthorizationRequestCredentialsEntry

Maps a bank-defined credential id string to a value.

useCredentialFlowboolean

If true, this triggers the credential flow. The credentials map must be populated if required by the bank (see credentialFields in the response to GET /banks). Otherwise, empty credentials are used.

useWebappCredentialsFlowboolean

When useWebAppCredentialsFlow is set to true and bank's flow includes embedded steps, these steps are handled by Token.io's Hosted Pages, rather than by the customer's own pages.

Response

Successful response

OR
OR

Example response

{
  "fields": {
    "fields": [
      {
        "description": "User authentication",
        "displayName": "Client ID",
        "flickerCode": "FLICKERCODE",
        "id": "clientId",
        "image": "YWJAeXoyWhAeXohteQ",
        "options": [
          "SMS",
          "Phone call"
        ],
        "type": "PASSWORD"
      }
    ]
  },
  "oauthState": "71b624cf-af3a-4f78-9420-d6e4248a9efe"
}