Retrieve card tokenization results

Last updated: July 2, 2025

Use the onTokenized event to monitor the results of tokenizing the payment card. For example, if you want to conduct a pre-payment risk check with the card's details and decide whether to proceed with 3D Secure authentication or cancel the payment.

Information

Follow the Getting started with Flow guide before you update your integration with the steps outlined on this page.

The onTokenized event triggers when the card is tokenized and returns a Request card metadata response.

Add the event to the initialization code for your Flow instance:


1// Flow initialization
2const flowComponent = checkout.create('flow', {
3    onTokenized,
4});

Implement the event logic to customize the payment flow depending on the results of tokenization. For example, the following code uses the tokenization result to perform a risk check and cancels the payment if it fails:


1const onTokenized = async (self, tokenizeResult) => {
2  // Perform risk check with the tokenization result. For example, using an async function to 
3  // send the data to a third-party risk tool:
4  cardRiskCheckResult = await performRiskCheck(tokenizeResult);
5
6  // Return `{ continue: false }` to cancel payment with the card
7  if (cardRiskCheckResult.result === 'abort') {
8    return {
9      continue: false,
10      errorMessage: 'This card is not supported',
11    };
12  }
13
14  // Otherwise return `{ continue: true }` to proceed with payment
15  return {
16    continue: true,
17  };
18};

The handleSubmit event enables you to submit a modified payment session.

Add the event to the initialization code for your Flow instance:


1// Flow initialization
2const flowComponent = checkout.create('flow', {
3    onTokenized,
4    handleSubmit,
5});

Implement the event logic to provide the tokenization result data to your server-side integration:


1const handleSubmit = async (self, submitData) => {
2  // Provide the `submitData` to your server-side integration
3  // for payment submission
4  const submitResponse = await performPaymentSubmission(submitData, cardRiskCheckResult);
5
6  return submitResponse;
7};

Call the Submit a payment session endpoint and provide the payment session's ID as a path parameter.

In your request, provide the payment session data from the handleSubmit event in session_data. You can also modify any of the following fields:

3ds
amount
items
reference

post

https://api.checkout.com/payment-sessions/{id}/submit


1{
2  "session_data": "{SESSION_DATA_FROM_FLOW}",
3  "3ds": {
4    "enabled": true
5  }
6}


1{
2  "id": "pay_f2ws3hn4ijquzbytp3v5lsfxge",
3  "status": "Action Required",
4  "type": "card",
5  "action": {
6    "type": "3ds",
7    "url": "http://3ds2.checkout.com/interceptor/sid_y3oqhf46pyzuxjbcn2giaqnb44"
8  }
9}

You must provide the unmodified response to the handleSubmit event in the client-side integration. Flow handles any additional required actions.

You can obtain the payment response for both asynchronous and synchronous payments.

Retrieve card tokenization results

Information

Add the onTokenized event
Client side

Add the handleSubmit event
Client side

Submit the modified payment session
Server side

Request example

Response example

Handle the payment response
Client side

Information

Add the onTokenized event Client side

Add the handleSubmit event Client side

Submit the modified payment session Server side

Request example

Response example

Handle the payment response Client side

Add the onTokenized event
Client side

Add the handleSubmit event
Client side

Submit the modified payment session
Server side

Handle the payment response
Client side