Tokenização

APIs para cadastro e gestão de cartões tokenizados.

🚧

Esta documentação está desatualizada.

Para informações sempre atualizadas, acesse https://paygodev.readme.io/docs.

🚧

Antes de usar as APIs...

Certifique-se de ter verificado as secções de APIs e Chave de Integração, além de ter lido as nossas Informações preliminares.

Tokenização

Cartões tokenizados podem ser utilizados para uma série de funções, como:

• Compra em um clique;
• Cobrança recorrente;
• Pagamento automático, sem necessidade do comprador interagir no instante do pagamento.

POST ClienteCartao/Insert

📘

{{Url}}/ClienteCartao/Insert?key={{Key}}

Variáveis:
Url: endereço do ambiente atual.
Key: chave de acesso.

API para solicitar tokenização de cartão a um cliente.
Parâmetros da API:

• id: identificador da relação entre cliente e cartão. Este campo é utilizado para alterar uma relação já existente. Para criar um relacionamento novo, basta não enviar este campo. Um exemplo de edição é a alteração de cartão preferencial;

• idCliente: cliente o qual está registrando uma tokenização de cartão. Caso o id acima seja enviado, este campo se passa a ser desnecessário;

• preferencial: mandar 'true' ou 'false' para inidicar se este cartão é o cartão preferencial do cliente. Esta indicação fará que, caso haja uma venda sem informar um cartão específico, o sistema entenderá que deverá mandar o cartão preferencial.

O retorno desta chamada conterá a URL do ambiente seguro (PCI-DSS) que deve ser disponibilizado ao cliente para que digite os dados do cartão de crédito.

Assim que o usuário submete os dados, o ambiente seguro registra o cartão e retorna um Token para o ControlPay, permitindo ao ControlPay realizar vendas futuras com este cartão.

Este token possui uma amarração entre o lojista e o cartão, dando mais segurança ao processo. Caso este token seja interceptado, o interceptor não poderá usar este token em nunhum outro estabelecimento a não ser o que solicitou a tokenização.

HEADERS
Content-Type	application/json

PARAMS
key	{{Key}}

BODY raw

{
	"clienteId":1,
	"id":12,
	"preferencial":true
}

---

Exemplo: ClienteCartao/Insert

Example Request - ClienteCartao/Insert

curl --location --request POST 'sandbox.controlpay.com.br/webapi/ClienteCartao/Insert?key={{Key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
	"clienteId":1,
	"id":12,
	"preferencial":true
}

'

---

POST ClienteCartao/GetByClienteId

📘

{{Url}}/ClienteCartao/GetByClienteId?key={{Key}}&clienteId={{ClienteId}}

Variáveis:
Url: endereço do ambiente atual.
Key: chave de acesso.
ClienteId: ID do cliente a quem o cartão pertence.

API para consultar os cartões cadastrados para um cliente.

HEADERS
Content-Type	application/json

PARAMS
key	{{Key}}
clienteId	{{ClienteId}}

---

Exemplo: ClienteCartao/GetByClienteId

Example Request - ClienteCartao/GetByClienteId

curl --location --request POST 'sandbox.controlpay.com.br/webapi/ClienteCartao/GetByClienteId?key={{Key}}&clienteId=2' \
--header 'Content-Type: application/json' \
--data-raw ''