1. Cartão
Sua Fintech
  • Bem vindo(a) a documentação de APIs
  • Autenticação
    • Login
      POST
    • Tokenização
      POST
  • Pagamentos
    • Cartão
      • Processar transação
        POST
      • Tokenizar
        POST
    • Pix
      • Gerar QRCode
    • Boleto
  • Conta Digital
  1. Cartão

Tokenizar

POST
/card/tokenize
Quando os dados do cartão são enviados para a tokenização, a API gera um identificador único (cardId) que poderá ser utilizado posteriormente para processar pagamentos sem precisar enviar novamente os dados completos do cartão.

💳 Tokenização do Cartão#

A rota recebe os dados necessários para identificar e validar o cartão e retorna um cardId.
🔒 O cardId funciona como o identificador do cartão tokenizado e pode ser utilizado posteriormente na rota de processamento de pagamento.

📝 Dados do Cartão#

Os dados enviados para a tokenização incluem:
name → Nome utilizado para identificar o cartão.
holderName → Nome impresso no cartão.
expirationDate → Data de validade do cartão.
number → Número do cartão.
securityCode → Código de segurança do cartão.

tokenizeExpiration#

O campo tokenizeExpiration é opcional e define o período de validade da tokenização.
Esse campo não altera nem representa a validade do cartão. Ele determina por quanto tempo o cardId permanecerá válido para utilização.
⏳ A validade definida em tokenizeExpiration controla exclusivamente a expiração da tokenização. A validade original do cartão continua sendo definida pelo campo expirationDate.

🔐 Resultado da Tokenização#

Após a tokenização, a API retorna um cardId.
✅ O cardId deve ser armazenado pelo sistema para utilização em futuras transações, enquanto a tokenização estiver válida.
O cardId pode ser enviado posteriormente na rota de processamento de pagamento no lugar dos dados completos do cartão.

🗑️ Exclusão do Cartão#

Um cartão tokenizado pode ser excluído utilizando a rota /card/delete.
Para excluir a tokenização, basta enviar o cardId correspondente.
⚠️ Importante: após a exclusão, o cardId não deverá mais ser utilizado para processar pagamentos.

📌 Regras#

  • Os dados do cartão são enviados para gerar um cardId.
  • O cardId identifica o cartão tokenizado.
  • O tokenizeExpiration é opcional.
  • tokenizeExpiration define exclusivamente a validade da tokenização.
  • tokenizeExpiration não altera a validade do cartão.
  • A validade do cartão é informada através do campo expirationDate.
  • O cardId pode ser utilizado posteriormente para processar pagamentos enquanto a tokenização estiver válida.
  • Não é necessário enviar novamente os dados completos do cartão ao utilizar um cardId.
  • A tokenização pode ser excluída através da rota /card/delete.
  • A exclusão é realizada informando o cardId.

Requisição

Authorization
Bearer Token
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
or
Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Sucesso
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/card/tokenize' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Cartão Teste",
    "holderName": "Nome impresso no cartão",
    "expirationDate": "25/30",
    "number": "000000000000000",
    "securityCode": "0000"
}'
Response Response Example
{
    "success": true,
    "message": "Cartão tokenizado com sucesso",
    "cardId": "00000000-0000-0000-0000-000000000000"
}
Modificado em 2026-09-03 18:23:35
Página anterior
Processar transação
Próxima página
Gerar QRCode
Built with