Card Tokenization - ZenPayments

Tokenization is the process of exchanging sensitive card data with a unique token without compromising its security when you desire to use this card for future payments. A token is up to 64-digit characters.

Keep in mind that when you are using a token for a transaction we also automatically include the networkTransactionId in the request.

Tokenization can be performed during a sale, auth and cardAuthentication request when the value of card.save parameter is passed as Yes. We will generate a secure token for that card. The response will include the first six and the last four digits of the card number in the card.number field and a token in the card.token field, which can be used in the future in place of a card number.

Although you can tokenize a card in any sale, auth, and cardAuthentication request, as mentioned above, this endpoint can be utilized to generate a token-only request for your convenience.

Fields	Description	Type	Filterable	Required	Readonly
terminal	Terminal Object	Object	No	Yes	No
terminal.id	Terminal ID	Integer	No	Yes	No
source	Where the card details come from `Internet` or `MOTO`	ENUM	No	Yes	No
card	Card details	Object	No	Yes	No
card.name	Cardholder name	String	No	Yes	No
card.number	Card number	Integer	No	Yes	No
card.exp	Card expiration date `mm/yy`	String	No	Yes	No
card.cvv	Card security code	Integer	No	Conditional	No

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "terminal": {
        "id": 24
    },
    "source": "Internet",
    "card": {
        "name": "John Wick",
        "number": 5146312200000035,
        "exp": "12/30",
        "cvv": "998"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Card Tokenization

application/json

Body

Example

{
    "id": "890",
    "amount": 0,
    "origin": "API",
    "type": "GenerateToken",
    "level": 1,
    "authCode": null,
    "parent": {
        "id": null
    },
    "terminal": {
        "id": 24
    },
    "threeds": {
        "id": null
    },
    "card": {
        "bin": 514631,
        "name": "John Wick",
        "number": 35,
        "exp": "2030-12-31",
        "verification": {
            "cvv": null,
            "address": null
        },
        "networkTransactionId": "1212MCC111268**",
        "token": "1kDCZY8x9saJ0035"
    },
    "contact": null,
    "externalId": null,
    "isRecurring": "No",
    "split": null,
    "refunded": false,
    "captured": false,
    "history": [],
    "order": null,
    "feeTransaction": null,
    "batch": {
        "id": null,
        "number": null,
        "batchedOn": null
    },
    "ip": {
        "address": "173.239.211.182",
        "isp": "Ipxo Limited",
        "type": "hosting",
        "location": {
            "city": "New York",
            "state": "NY",
            "country": "US",
            "zip": "10118"
        },
        "info": {
            "isAnonymous": "Yes",
            "isAnonymousVpn": "No",
            "isPublicProxy": "No",
            "isHostingProvider": "No",
            "isTorExitNode": "No"
        }
    },
    "status": {
        "status": "Approved",
        "reason": null
    },
    "updatedOn": null,
    "createdOn": "2023-05-09 16:17:30"
}