Serviço de criar Pagamento com armazenamento de cartão
O Carat oferece à loja a opção de armazenar, de forma segura, o número do cartão do comprador para uso futuro em transações de compras ou até para efetuar estorno de um pagamento.
O fluxo seguido para o pagamento com armazenamento do cartão é exatamente o mesmo seguido pelo pagamento descrito anteriormente.
No caso de um pagamento com armazenamento o cartão do comprador é criptografado e depois armazenado em uma base de dados usada pelo Carat. Esse armazenamento se dá seguindo as rígidas normas do PCI (Payment Card Industry).
Algumas observações:
- 1. É importante saber que apenas o número do cartão e a data de validade são armazenados, pois é terminantemente proibido guardar de qualquer maneira o código de segurança (CVV, CVC2, CAV2 ou CID) do cartão;
- 2. Este recurso é permitido para cartões de crédito e;
- 3. Para os seguintes cartões voucher:
- a. Alelo Cultura
- b. Alelo Refeição
- c. Alelo Alimentação
- d. Sodexo Cultura
- e. Sodexo Refeição
- f. Sodexo Alimentação
- g. Coopercard Cultura
- 4. Outro dado a ser observado é que o cartão só é armazenado no Carat caso a transação de pagamento seja confirmada.
Para efetuar o armazenamento do cartão, a loja deve enviar alguns parâmetros extras ao efetuar uma transação de pagamento no Carat. Segue um exemplo de JSON com armazenamento de cartão:
Neste caso, além do nit da transação de pagamento, é criado uma transação com nita, isto é, um nit de armazenamento, que é apresentado no retorno da operação de criação de transação de pagamento. Segue abaixo um exemplo de retorno JSON:
Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br
Na tabela abaixo são apresentados os campos adicionais retornados:
| Parâmetro | Descrição | Formato |
|---|---|---|
nita | Identificador da transação de armazenamento no Carat. | = 65 A |
nsua | Número sequencial único da transação de armazenamento no Carat. | = 15 N |
Aviso de Armazenamento#
No processamento do pagamento com armazenamento do cartão, o Carat envia dois POSTS HTTPS para o servidor da loja.
O Carat enviará um POST na URL de Aviso de Status com os parâmetros de resposta da transação de pagamento e outro POST na URL de Aviso de Armazenamento com os parâmetros de resposta da transação de armazenamento do cartão, juntamente com o identificador do cartão armazenando.
Os campos enviados no aviso de armazenamento são descritos na seguinte tabela:
| Parâmetro | Descrição | Formato |
|---|---|---|
nita | Código NITA, que identificará a transação de armazenamento do cartão no Carat em caso de sucesso. | = 65 A |
nsua | NSU do Carat para esta transação de armazenamento, que servirá para acompanhamento nos relatórios do back-office. | = 15 N |
nsu | Número sequencial único para cada pedido, criado pela loja. O nsu será usado em toda comunicação com a loja, de forma a identificar o pedido. Como trata de uma possível chave para acesso do lado da loja, é exigido que o campo seja formatado e enviado pela aplicação da loja. | < 12 N |
status | Status da transação de armazenamento. Saiba mais. | = 3 A |
hash | Código identificador do cartão armazenado no Carat. | = 88 C |
bin | 6 primeiros dígitos do cartão armazenado. | = 6 N |
final | Últimos quatro dígitos do cartão armazenado. | = 4 N |
autorizadora | Código da Autorizadora (no Carat) utilizado pelo cliente ao efetuar o pagamento. Saiba mais. | < 10 N |
Importante:
Além dos parâmetros acima o Carat pode devolver outros sem aviso prévio. Por favor, esteja preparado para receber parâmetros extras (que podem ser ignorados) além dos contidos na tabela acima.
Não é necessário devolver nenhum conteúdo como resposta ao POST, porém se não for bem sucedido (HTTP Status-Code 200: OK), o Carat tentará de novo até o número de vezes configurado no sistema, antes de desistir e deixar a transação de armazenamento como pendente de aviso.
Pagamento recorrente#
O pagamento recorrente decorre da necessidade da loja manter débitos programados no cartão de determinado cliente, podendo ser com valor fixo ou variável, com quantidade de ocorrências programadas ou de maneira perene até que o cliente determine o encerramento dos débitos.
Recorrência é a capacidade do Carat em processar novos pagamentos sem que o cliente necessite entrar com os dados novamente, usando os dados do cartão já previamente armazenados. A necessidade surge em casos de renovação de assinatura, mensalidades, etc.
Importante:
Para as Transações Recorrentes serão armazenados somente: Número e Data de validade do cartão, já o código de segurança (CVV, CVC2, CAV2 ou CID) não poderá ser armazenado e nem enviado no pagamento recorrente. O armazenamento do código de segurança, seja criptografado ou não, é terminantemente proibido pelas normas do PCI SSC (Payment Card Industry Security Standards Council). Caberá ao lojista efetuar negociação com as redes adquirentes (Acquirers) para realização dos pagamentos sem a obrigatoriedade do código de segurança; caso contrário, este parâmetro será solicitado durante o fluxo transacional.
Porém, mesmo que as Redes adquirentes permitam transações sem este código (CVV2), não há garantias que o Emissor (Instituição Bancária) aceite uma transação desta forma (sem o código de segurança).
Para realizar o pagamento recorrente, utilize a nossa interface de pagamento REST.
Consulta dos dados do armazenamento#
A consulta dos dados do armazenamento de cartão seguirá o seguinte fluxo:
- A loja envia uma consulta do armazenamento fornecendo o nita
- O Carat irá enviar os dados do armazenamento na URL de aviso de armazenamento cadastrada pela loja no Carat.
A loja poderá consultar os dados do armazenamento, conforme a figura abaixo:
Para realizar a consulta, a loja deverá fazer um POST no seguinte endereço:
| Ambiente de Homologação |
|---|
| https://esitef-homologacao.softwareexpress.com.br/e-sitef-hml/armazenamento/consultarArmazenamento.se?nita=XXXX |
| Ambiente de Produção |
| https://esitef.softwareexpress.com.br/e-sitef/armazenamento/consultarArmazenamento.se?nita=XXXX |
Atenção:
Nunca utilize o IP ao invés do domínio esitef-ec.softwareexpress.com.br! O IP pode mudar a qualquer instante e sem aviso prévio, por isso é importante a utilização do domínio para acessar o Carat.
Onde XXXX é o NITA criptografado com 65 caracteres alfa numéricos recebido pelo site do Carat no pedido de consulta.
A resposta será OK caso o NITA do armazenamento esteja correto e a comunicação é encerrada.
A seguir o Carat irá enviar um POST HTTPS na URL para aviso de armazenamento cadastrada na loja.
A loja deve estar preparada para lidar com estes parâmetros e com eventuais novos parâmetros que podem passar a serem enviados sem prévio aviso (tais novos parâmetros após recebidos, podem ser ignorados pela loja) e preparada também para a chamada HTTPS (SSL) na URL para envio de HASH cadastrada.
O POST HTTPS do Carat pode não ser imediato, será assíncrono com o tempo podendo variar conforme carga do servidor e da Internet. Caso haja algum problema no envio, o Carat tentará reenviar a mensagem após um determinado período de tempo.
Os parâmetros devolvidos são os mesmos descritos na seção de Aviso de Armazenamento.