Token Operation

Essa operação é usada para tokenizar um determinado cartão de crédito que será utilizado em pagamentos recorrentes.

Para este método, você precisará incluir os parâmetros da requisição em um objeto JSON e enviá-los no parâmetro request_body.

caution

É importante saber que os tokens expiram após 14 meses de seu último uso.
Aviso: Para gerar o token e verificar a autenticidade do cartão de crédito, o EBANX cria uma transação temporária que não será capturada.

Endpoints

Endpoints	HTTP Method	Response
https://api.ebanx.com.br/ws/query https://staging.ebanx.com.br/ws/query	POST	application/json

Parâmetros de Requisição

Campo	Tipo	Descrição
integration_key Mandatório	String max 100	Sua chave de integração única e secreta
public_integration_key Mandatório	String max 100	Sua chave de integração única e pública. Essa chave poderá ser usada no lugar da integratio_key quando a solicitação é feita pelo client (navegador, aplicativo, etc ...) do seu cliente. Ao fazer isso, você não precisa lidar diretamente com as informações do cartão de crédito.
payment_type_code Mandatório	String max 32	A bandeira do cartão de crédito: amex, elo, hipercard, mastercard, visa.
token Opcional	String max 128, único	Deverá ser definido se você quiser informar-lo, caso contrário o EBANX criará um novo Token.
country Mandatório	String fixo 2	O código do país do cliente, duas letras. Código disponível: br: Brasil.
creditcard.card_number Mandatório	String max 19	O número do cartão de crédito (14-19 dígitos, deve passar pelo algoritmo Luhn).
creditcard.card_name Mandatório	String max 64	O nome do titular do cartão, conforme escrito no cartão.
creditcard.card_due_date Mandatório	String fixo 7	Data de validade do cartão de crédito (formatado como mm/aaaa).
creditcard.card_cvv Mandatório	String max 4	Código de verificação do cartão (CVV).

Parametros de resposta

Campo	Tipo	Descrição
status	String	O status da solicitação (SUCCESS ou ERROR).
payment_type_code	String max 32	A bandeira do cartão de crédito.
token	String max 128, único	O token gerado ou o mesmo que foi informado na requisição.
masked_card_number	String max 19	O número do cartão de crédito mascarado. Pode ser armazenado e mostrado ao cliente.