Tokenize Card

💡 This endpoint initiates the card tokenization process. It also stores the card in a secure card vault.

A successful call to this endpoint will return a slug_tokenized_card or a slug_stored_card if the card cannot be tokenized.

Recommendation

To validate if the card information is correct before tokenizing, we recommend that you use Zero Dollar validation first.

Making Request

The call must be made using the POST method. Authentication via Authorization header is required.

POST/v1/card_payments/tokenize_card

Request Parameters

Attribute	Type	Description	Required
card_number	string	Card number, without spaces or dashes	Yes
card_expiration_date	string	Card expiration date, in MMyyyy format (e.g.: 012029)	Yes
card_security_code	string	Security code (CVV/CVC)	Yes

Request Example

GET /v1/card_payments/tokenize_card

{
  "card_expiration_date": "012029",
  "card_security_code": "123",
  "card_number": "4111111111111111"
}

Success

HTTP 200 Response Body - Example

{
    "code": "ACCEPTED",
    "tokenized_card": {
        "slug_token": "45F2106AE4D740A5B7C8FAAF7C244AAA",
        "token_expiration_date": "102028",
        "active": "ACTIVE"
    },
    "stored_card": {
        "slug_stored_card": "45F2106AE4D740A5B7C8FAAF7C2445FA",
        "active": "CARD_STORED"
    },
    "multiacq_id": "021",
    "status": "ok"
}

Errors

HTTP 422 Response Body - Unprocessable Entity - Example

{
    "request_token": "5B018B0166884D999799E5F3C41D0051",
    "code": "TOKENIZATION_FAILED",
    "msg": "400 BAD_REQUEST",
    "multiacq_id": "021",
    "status": "unprocessable_entity"
}

  {
    "errors": [
        {
            "code": "AUTHORIZER_REJECTED",
            "msg": "46 - Identification required"
        }
    ],
    "muid": "f251e1b753504766957cf4142e936262",
    "request_token": "83329FF45587498D88E1590C7FB78CD8",
    "amount": 1,
    "currency": "BRL",
    "tracking_number": "00010609171144580010000000324834",
    "last_digits": "1111",
    "transaction_status": "REJECTED",
    "brand_response_code": "83",
    "multiacq_id": "021"
}

Response Attributes

Attribute	Type	Description
code	string	Response code from transaction result.
msg	string	Response message from transaction result.
tokenized_card	object	Tokenized card data information.
slug_token	string	Token recovery information.
token_expiration_date	string	Token expiration date in MMyyyy format.
active	string (enum)	Current token state. Values:
ACTIVE UNPROVISIONED
stored_card	object	Stored card information.
slug_stored_card	string	Stored card identification. Can be sent in the sale request instead of card information.
active	const (enum)	Stored card state
request_token	string	Unique string that identifies the request.
status	string	Request status