• 1. Request
  • Query parameters
  • Body parameters
  • Example
• 2. Response
• 3. Store the token
• 4. Look up

The /tokenize endpoint is designed to securely vault credit card information after every checkout. A tokenized representation of the card information is returned.

Store that token for later use in case of payment decline.

You can send that request in parallel to the Payment Authorization request. If you are already tokenizing with a partner, you can tokenize twice.

1. Request

Query parameters

The schema does not enforce these parameters, but the call is authenticated by them. A request without a valid mid and environment returns HTTP 401.

Log into into your Sandbox. Go to section Developers > Tokenization get both your Tokenization endpoint and Environment.

Body parameters

❗️

Real financial data cannot be used in the Sandbox.
Please use our whitelisted test credit cards.

Request example

curl --location -g --request POST '
  https://api-sandbox.flexfactor.io/v1/tokenize?mid={Your mid}&environment={Your Tokenization Key}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "paymentMethod": {
    	"senseKey": "XXX", //provide the key generated by SenseJS during the checkout
      "email": "[email protected]",
    	"creditCard": {
        "firstName": "Joe",
        "lastName": "Jones",
        "number": "4111111111111111",
        "verificationValue": "999", //That's the CVV
        "month": "03", // provide 2 numbers
        "year": "2025" // provide 4 numbers
      },
      "metadata": {
        "customerId": "cust_123"
      }
  }
}'

2. Response

The response uses the common FlexFactor envelope plus one field, id, which is the FlexFactor token for the vaulted card.

{
   "id": "baf4abdc-14a3-4458-abfb-c856c711b9c7", //this is the tokenized payment method
   "success": true,
   "result": null,
   "status": null,
   "statusCode": null,
   "errors": [],
   "customProperties": {}
 }

HTTP status codes

3. Token storage

The returned token must be stored in your database for future use, you will need it in case of payment decline.

A payment decline can happen immediately after tokenization (in case of CIT) of a few months after tokenization (in case of MIT).

❕

This vaulted token will not expire.

Store the returned id alongside the card details below. The response does not return the BIN or the last four digits, so take them from the card number you tokenized before you discard it.

paymentMethod information

4. Retrieve that token for /evaluate

On a payment decline, you will need to look up the paymentMethod information and include it in your call to /evaluate.