Tokenização

Dados da API

API Gateway
Esta API é utilizada para operações do gateway de pagamento:

• Produção: https://api.sopague.com.br/gateway
• Homologação: https://api-hmg.sopague.com.br/gateway
• Arquitetura: Representational State Transfer (REST)

O que é Tokenização?

A tokenização é uma operação essencial para aumentar a segurança em transações. Ela substitui os dados confidenciais de um cartão por um token único, garantindo que informações sensíveis não sejam expostas durante o processamento.

---

Gerar Token utilizando numero do cartão

Esta operação permite criar um token para um cartão, protegendo suas informações. Para realizar a tokenização, faça uma requisição POST conforme o exemplo abaixo:

POST v1/cards/tokenization

Via request Representational State Transfer (REST) com o body:

Requisição

  {   
    "cardNumber":"string"
  }

Dicionário de dados - Parâmetros

PROPRIEDADE	DESCRIÇÃO	TIPO	LOCAL	OBRIGATÓRIO	TAMANHO
cardNumber	Número do cartão que será tokenizado	string	body	sim	de 9 a 19

🟢 200

Tokenização realizada com sucesso

[
  {
    "numberToken":" 4DB5E9B5-F30E-4416-8E41-20B539426B68"
  }
]

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
numberToken	Token gerado para o cartão	string

🔴 400

Erro na requisição

  [
    {
      "tag": "CardNumber",
      "description": "Cartão inválido."
    }
  ]

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
tag	Tag do erro	string
description	Descrição do erro	string

🔴 500

Erro interno

  [
    {
      "tag": "",
      "description": "Não foi possível executar comando. Erro desconhecido."
    }
  ]

Dicionário de dados - Retorno

PROPRIEDADE	DESCRIÇÃO	TIPO
tag	Tag do erro	string
description	Descrição do erro	string