Manual de Integração Cartão Protegido

Manual de Integração
Cartão Protegido
Versão 2.1
10/09/2012
Manual de Integração
Cartão Protegido
SUMÁRIO
HISTÓRICO DE ALTERAÇÕES ............................................................................................................................3
SOBRE A PLATAFORMA .....................................................................................................................................4
SOBRE O PRODUTO .........................................................................................................................................4
SOBRE ESTE MANUAL ......................................................................................................................................4
1.
CARTÃO PROTEGIDO ................................................................................................................................5
2.
PARÂMETRO JUSTCLICKALIAS ...................................................................................................................6
2.1.
FORMA CORRETA DE ASSOCIAÇÃO ........................................................................................................6
2.2.
FORMA DE ASSOCIAÇÃO NÃO ACEITA ....................................................................................................6
3.
FLUXO DE AUTORIZAÇÃO VIA PLATAFORMA CARTÃO PROTEGIDO .................................................................7
4.
FLUXO DE AUTORIZAÇÃO VIA PAGADOR.....................................................................................................8
4.1.
AUTORIZAÇÃO COM OPÇÃO SALVAR CARTÃO ..........................................................................................8
4.2.
AUTORIZAÇÃO COM CARTÃO JÁ SALVO ..................................................................................................8
4.3.
AUTORIZAÇÃO VIA POST ......................................................................................................................9
5.
CÓDIGO DE SEGURANÇA (CVV) .................................................................................................................9
6.
DICAS DE IMPLEMENTAÇÃO .................................................................................................................... 10
6.1.
IMPLEMENTANDO JUSTCLICKSHOP (COMPRA COM 1 CLIQUE) ................................................................. 10
6.1.1.
6.2.
7.
BOAS PRÁTICAS............................................................................................................................. 10
IMPLEMENTANDO COBRANÇA RECORRENTE .......................................................................................... 10
MÉTODOS DO CARTÃO PROTEGIDO ......................................................................................................... 11
7.1.
SALVANDO UM CARTÃO DE CRÉDITO ................................................................................................... 11
7.2.
RECUPERAÇÃO DO NÚMERO DO CARTÃO DE CRÉDITO, COM RETORNO MASCARADO ................................. 12
7.3.
RECUPERANDO UMA JUSTCLICKKEY ..................................................................................................... 13
7.4.
INVALIDANDO UM CARTÃO DE CRÉDITO............................................................................................... 14
8.
MAPA DE ERROS .................................................................................................................................... 16
9.
MEIOS DE PAGAMENTOS ACEITOS NA AUTORIZAÇÃO VIA PAGADOR ........................................................... 17
Telefone: (21)2111-4700 / (11) 3320-9050
http://suporte.braspag.com.br
Página 2 de 17
Manual de Integração
Cartão Protegido
HISTÓRICO DE ALTERAÇÕES
Cartão Protegido – Manual de Integração
Versão
Data

Descrição
1.5
05/06/2012

Alteração de Layout
2.0
24/08/2012



Parâmetro: JustClickAlias
Indexação das Tabelas
Inserção de novos códigos no Mapa de Erros
2.1
10/09/2013

Remoção do erro 723 do Mapa de Erros
Telefone: (21)2111-4700 / (11) 3320-9050
http://suporte.braspag.com.br
Página 3 de 17
Manual de Integração
Cartão Protegido
SOBRE A PLATAFORMA
A plataforma do CARTÃO PROTEGIDO é uma armazenadora segura de cartões de crédito. Os dados nela
armazenados seguem as normas PCI, que garante a integridade das informações dos cartões armazenados.
O gateway PAGADOR (BRASPAG) está integrado ao CARTÃO PROTEGIDO, facilitando o envio e processamento de
transações de cartão de crédito via token.
SOBRE O PRODUTO
Enquanto produto, o CARTÃO PROTEGIDO, por ser uma solução para resolver o problema de armazenamento seguro
de dados de cartão de crédito, pode ser utilizado para diversos fins, como:

Compra com 1 clique:
A “compra com 1 clique” permite que um pagamento online, via cartão de crédito, seja feito pulando a etapa de
preenchimento dos dados para pagamento ou até mesmo de todo o processo do carrinho de compras, pois os
dados do cartão já foram previamente informados pelo comprador em compras passadas e serão replicados em
futuras compras mediante sua autorizaçãol.

Cobrança Recorrente:
Estabelecimentos que já possuam uma solução interna de gerenciamento de recorrências podem utilizar a
plataforma apenas para a parte sensível: armazenar os dados de cartão de crédito e processar via PAGADOR, as
cobranças nas Adquirentes utilizando apenas o token. (Não é obrigatório que a transação seja processada via
Pagador)

Re-tentativa de envio de transação (venda):
Para estabelecimentos que represam os dados da venda para passar num segundo momento, sendo para retentar o envio de uma transação de cartão de crédito para uma Adquirente ou para fazer algum procedimento
interno antes de autorizar a venda (validação de estoque, análise de fraude), a plataforma atende perfeitamente
esta finalidade. O estabelecimento precisa conhecer e manipular apenas um token, mantendo-se aderente com as
regras de segurança da indústria de cartões de crédito.

Ou para qualquer outra finalidade, onde se faça necessário armazenar dados de um cartão de crédito de
forma segura, mesmo que temporariamente.
SOBRE ESTE MANUAL
Este manual tem como objetivo orientar o desenvolvedor da loja sobre a integração com a plataforma CARTÃO
PROTEGIDO, descrevendo as funcionalidades existentes e os métodos a serem utilizados, listando informações a
serem enviadas e recebidas e provendo exemplos.
Para receber a URL de Produção, solicite à nossa equipe de implantação através da ferramenta
Suporte.
Telefone: (21)2111-4700 / (11) 3320-9050
http://suporte.braspag.com.br
Página 4 de 17
Manual de Integração
Cartão Protegido
1.
CARTÃO PROTEGIDO
Nas seções abaixo, estão graficamente representados, os fluxos do processo de venda.
Existem 3 maneiras de integrar o produto:

Diretamente pela plataforma do CARTÃO PROTEGIDO;

Via plataforma PAGADOR, utilizando Webservice;

Via plataforma PAGADOR, utilizando Post de Dados.
Os dados necessários para armazenar um cartão de crédito na plataforma são: CPF do Cliente, Nome do Cliente, Nome
do Portador, Número do Cartão e Data de Validade. O código de segurança não é armazenado (vide seção Código de
Segurança).
A plataforma do CARTÃO PROTEGIDO armazena de forma segura, 100% PCI Compliance, os dados dos cartões
de crédito.
Para garantir uma maior segurança, apenas os IP’s previamente cadastrados do Estabelecimento
poderão consultar um número de cartão ou autorizar uma transação utilizando a chave do Cartão
Protegido (JustClickKey).
Como a autorização de uma transação é via PAGADOR, todas as funcionalidades de confirmação da transação Segundo Post (post de confirmação), e Terceiro Post (sonda) - permanecem funcionando da mesma forma.
Telefone: (21)2111-4700 / (11) 3320-9050
http://suporte.braspag.com.br
Página 5 de 17
Manual de Integração
Cartão Protegido
2.
PARÂMETRO JustClickAlias
Este parâmetro tem por finalidade facilitar o armazenamento, por parte do cliente, de informações referentes a um
Cartão Protegido.
O cliente poderá, no momento do salvamento do cartão, criar um Alias (apelido) que identificará esse cartão na
Plataforma CARTÃO PROTEGIDO.
Outra vantagem, é o fato desse Alias poder ser associado a um novo JustClickKey, o que facilitaria a troca de um
cartão quando, por exemplo, a validade deste expirar.
Para isso, o lojista deveria indicar que o JustClickKey está desabilitado. Dessa forma, o Alias associado a ele ficaria
liberado para ser utilizado com um novo JustClickKey.
2.1. Forma Correta de Associação
Um Alias pode ser associado a um novo Token, desde que antes seja desassociado do Token antigo, conforme indicado
no exemplo abaixo:
Merchant Id
JustClickKey (Token)
Alias
Enabled
LOJA A
Token 1
XPTO
0
LOJA A
Token 2
XPTO
0
LOJA A
Token 3
XPTO
1
Obs.: A desassociação ocorrerá após a execução do método InvalidateCreditCard (Item 8.5).
2.2. Forma de Associação Não Aceita
Um Alias pode ser associado a um novo Token, desde que antes seja desassociado do Token antigo, no exemplo abaixo
está indicada uma forma que não permitiria essa associação, pois o Alias só estará liberado para uma nova associação
desde que esteja desvinculado de um determinado Token :
Merchant Id
JustClickKey (Token)
Alias
Enabled
LOJA A
Token 1
XPTO
1
LOJA A
Token 2
XPTO
1
LOJA A
Token 3
XPTO
1
Telefone: (21)2111-4700 / (11) 3320-9050
http://suporte.braspag.com.br
Página 6 de 17
Manual de Integração
Cartão Protegido
3.
FLUXO DE AUTORIZAÇÃO VIA PLATAFORMA CARTÃO PROTEGIDO
Abaixo está representado o fluxo de uma requisição para salvar um cartão de um cliente durante uma venda, seguido
de outro fluxo onde o mesmo cliente realiza uma compra via CARTÃO PROTEGIDO.
Com a permissão do cliente para salvar seu cartão, o estabelecimento deve:
1.
2.
3.
4.
Enviar a tentativa de autorização da compra em questão via Gateway. Processo padrão que já acontece hoje
Receber o resultado da autorização
Enviar os dados do cartão para armazenamento no CARTÃO PROTEGIDO
Receber a “JustClickKey”, que é a chave que vai representar a dupla “cartão de crédito-cliente” para futuras
“compras com 1 clique”, e armazená-la.
Quando o cliente voltar ao site para fazer uma nova compra e se logar, o site pode apresentar a opção de “compra
com 1 clique”, e o fluxo será:
1.
2.
Chamar a autorização da transação direto pela plataforma do CARTÃO PROTEGIDO, passando a
“JustClickKey” e/ou “JustClickAlias” do cliente e, opcionalmente, o CVV (vide seção Código de Segurança)
Receber o resultado da autorização
Autorização com opção Salvar Cartão
1 - Authorize()
GATEWAY
2 - Authorize Result
MERCHANT
3- SaveCreditCard (MerchantId,
CustomerIdentification, CustomerName,
CardHolder, CardNumber, CardExpiration, JustClickAlias)
CARTÃO PROTEGIDO
4 -SaveCreditCardResponse (JustClickKey)
Cartão Protegido
1 - GetCreditCardRequest()
CARTÃO PROTEGIDO
MERCHANT
2 - GetCreditCardResponse()
Telefone: (21)2111-4700 / (11) 3320-9050
http://suporte.braspag.com.br
Página 7 de 17
Manual de Integração
Cartão Protegido
4.
FLUXO DE AUTORIZAÇÃO VIA PAGADOR
Abaixo estão representados os fluxos de uma requisição para salvar um cartão de um cliente durante uma venda e de
uma compra via CARTÃO PROTEGIDO, ambas utilizando a integração PAGADOR/CARTÃO PROTEGIDO
4.1. AUTORIZAÇÃO COM OPÇÃO SALVAR CARTÃO
Autorização com opção Salvar Cartão
MERCHANT
1 - AuthorizeTransaction(… CustomerIdentity,
CustomerName, CardHolder, CardNumber, CardExpirationDate,
SaveCreditCard)
PAGADOR
4 - Authorize Result + CreditCardToken
3-SaveCreditCardResponse
2- SaveCreditCardRequest
CARTÃO PROTEGIDO
1.
2.
3.
4.
Enviar a tentativa de autorização da compra em questão via PAGADOR, contendo o parâmetro
SaveCreditCard;
O PAGADOR envia os dados de cartão de crédito para a plataforma CARTÃO PROTEGIDO, à fim de
armazenar esses dados;
CARTÃO PROTEGIDO envia resposta do armazenamento dos dados do cartão ao PAGADOR;
Como resultado, o PAGADOR envia resposta da autorização e do armazenamento, ao cliente;
4.2. AUTORIZAÇÃO COM CARTÃO JÁ SALVO
Autorização com Cartão já salvo
1 - AuthorizeTransaction(…, CardSecurityCode,
CreditCardToken)
PAGADOR
MERCHANT
4 - Authorize Result
3 – GetMaskedCreditCardReturn
2 – GetMaskedCreditCardRequest
CARTÃO PROTEGIDO
1.
2.
3.
4.
Enviar a tentativa de autorização da compra em questão via PAGADOR, contendo o parâmetro
CredicardToken;
O PAGADOR envia os dados de cartão de crédito para a plataforma CARTÃO PROTEGIDO, à fim de
recuperar os dados previamente salvos do cartão;
CARTÃO PROTEGIDO envia resposta dos dados do cartão ao PAGADOR;
Como resultado, o PAGADOR envia resposta da autorização ao cliente;
Note que toda a comunicação é feita pelo estabelecimento através da plataforma PAGADOR.
Para obter todas as informações sobre os métodos dos Webserivces e seus parâmetros, assim como aqueles da
integração via Post, solicite os devidos manuais da plataforma PAGADOR.
Telefone: (21)2111-4700 / (11) 3320-9050
http://suporte.braspag.com.br
Página 8 de 17
Manual de Integração
Cartão Protegido
4.3. AUTORIZAÇÃO VIA POST
Abaixo, fluxo de autorização via Post. Mostrando uma transação onde o cliente possui a chave gerada pelo Cartão
Protegido e outra onde essa chave ainda irá ser criada e enviada ao cliente (CredicardToken).
CARTÃO PROTEGIDO - AUTORIZAÇÃO VIA POST
- Todos os dados do Post devem ser
criptografados;
- Parâmetro “PaymentMethod” será
obrigatório, mesmo enviando Token
na autorização
MERCHANT
1 - Parâmetros enviados via Post
2.4 – Post Result
+
CredicardToken
CredicardToken?
3.4 –Post Result
SIM
3.1 – Authorize (CredicardToken)
CARTÃO PROTEGIDO
NÃO
2.1 – Authorize (SaveCreditCard)
3.2- GetMaskedCreditCardRequest
3.3- GetMaskedCreditCardResponse
PAGADOR
2.2 – SaveCreditCardRequest
2.3 – SaveCredtCardResponse
* O parâmetro “CreditCardToken” retornado pelo PAGADOR é a própria “JustClickKey” do CARTÃO PROTEGIDO.
5.
CÓDIGO DE SEGURANÇA (CVV)
O código de segurança é obrigatório para que uma autorização, em compras não presenciais, seja aceita pelo banco
emissor do cartão. Ele é mais um mecanismo de segurança no processo anti-fraude, onde busca-se validar que a
pessoa que está utilizando o cartão seja de fato a dona dele. Por isso, as regras da indústria de cartões (PCI)
permitem que se armazene o número do cartão e a validade, mas nunca o código de segurança. Este deve ser sempre
solicitado no ato da compra para validação. Sendo a BRASPAG uma empresa PCI compliance, ela não armazena o
código de segurança, que deverá ser solicitado pelo estabelecimento no ato da confirmação da venda via CARTÃO
PROTEGIDO, caso seja obrigatório o uso da Adquirente em questão.
Estabelecimentos que possuem o modelo de negócio baseado em recorrência, como, por exemplo, assinaturas de
serviços, já possuem afiliação liberada para uso sem CVV.
Esta condição de recorrência é concedida exclusivamente pelas Adquirentes, não dependendo da BRASPAG.
Telefone: (21)2111-4700 / (11) 3320-9050
http://suporte.braspag.com.br
Página 9 de 17
Manual de Integração
Cartão Protegido
6.
DICAS DE IMPLEMENTAÇÃO
6.1. IMPLEMENTANDO JUSTCLICKSHOP (COMPRA COM 1 CLIQUE)
Para fazer uma venda através de um clique, é necessário que o estabelecimento já possua uma autorização,
fornecida pelo cliente, para poder armazenar os dados de seu cartão de crédito. Desta forma, nas próximas
compras ele pode optar por fazer o pagamento com o cartão de crédito previamente salvo.
Concedida a autorização para o armazenamento, basta que o estabelecimento envie os dados do cartão para a
plataforma do CARTÃO PROTEGIDO, recebendo como resposta uma chave que representa a dupla “cartão de
crédito-cliente”. Para cada cartão distinto que o cliente autorize o armazenamento, o CARTÃO PROTEGIDO
fornecerá uma chave também distinta.
Nas próximas vendas para este cliente, o estabelecimento poderá oferecer a “compra com 1 clique” como forma
de pagamento. Isto pode ser feito através de um botão de “comprar com um clique” no produto/ serviço
selecionado, ou como mais um meio de pagamento no processo de finalização do carrinho de compras.
Para processar uma venda via “compra com 1 clique”, basta que seja passado para a plataforma do CARTÃO
PROTEGIDO a chave previamente fornecida que identifique o “cartão de crédito-cliente” e, dependendo de
qual serviço do CARTÃO PROTEGIDO o estabelecimento opte por utilizar, a plataforma irá:


Devolver os dados do cartão para o estabelecimento autorizar a transação;
Autorizar direto a transação na Operadora via PAGADOR (sendo este o mais indicado, por garantir maior
segurança dos dados).
6.1.1.





BOAS PRÁTICAS
Salvar o número do cartão mascarado para apresentar ao cliente qual cartão ele tem habilitado para “a
compra com 1 clique” no site;
Opcionalmente, também salvar a data de validade, para ativamente comunicar ao cliente que o cartão
que ele tem armazenado expirou e sugerir a troca;
Apenas salvar o cartão na plataforma do CARTÃO PROTEGIDO caso ele tenha sido autorizado com
sucesso na última compra do cliente;
Segurança do login e senha dos usuarios do site – senhas muito fracas são facilmente descobertas e o
fraudador consegue fazer uma compra mesmo sem ter o cartão (no caso de não solicitação do CVV pelo
site);
Controlar variáveis de sessão para evitar que o usuário (login do cliente) permaneça logado no site e
outra pessoa acesse depois fazendo “compras via 1 clique” com este login (ex: usuários conectados em
lan houses).
6.2. IMPLEMENTANDO COBRANÇA RECORRENTE
Para cada pedido a ser cobrado com recorrência de cartão de crédito, o estabelecimento deve salvar os dados
do cartão de crédito na plataforma do Cartão Protegido e receber a chave (JustClickKey) que representa aquele
“pedido-cartão”. Chegado o dia da cobrança da recorrência, basta que o método de autorização de cartão seja
chamado, passando os dados para pagamento e, ao invés dos dados do cartão (número + data de validade), a
chave que o representa (JustClickKey ou JustClickAlias).
Se houver necessidade de troca de cartão para determinado pedido, basta que este novo cartão seja salvo no
CARTÃO PROTEGIDO, e a nova chave gerada seja associada ao pedido na plataforma do estabelecimento.
Não há necessidade de cancelamento/ exclusão do cartão na plataforma.
Se houver a necessidade de associar um Alias já existente a um novo JustClickKey, basta desabilitar o
JustClickKey antigo para deixar o Alias associado a ele, liberado para uma nova associação.
Se o estabelecimento optar por não processar a autorização da transação pela integração PAGADOR/CARTÃO
PROTEGIDO, é fundamental que em nenhum momento o número do cartão seja gravado (persistido em banco
ou em seção do browser) para que a segurança das informações seja mantida.
Telefone: (21)2111-4700 / (11) 3320-9050
http://suporte.braspag.com.br
Página 10 de 17
Manual de Integração
Cartão Protegido
7.
MÉTODOS DO CARTÃO PROTEGIDO
Abaixo estão representados os fluxos dos webmethods da plataforma do CARTÃO PROTEGIDO, para execução dos
procedimentos via webservice descritos nas seções anteriores.
7.1. SALVANDO um cartão de crédito
O método SaveCreditCard recebe o objeto SaveCreditCardRequest e deve ser chamado para salvar os dados de
uma cartão de crédito e receber a chave identificadora (token) da dupla “cartão de crédito-cliente” para futuras
autorizações via “compra com 1 clique”. Não se deve informar RequestId repetidos para essa operação, pois essa
informação será necessária para recuperar o JustClickKey na utilização do método GetJustClickKey().
Saving a Credit Card - SaveCreditCard() method
SaveCreditCardRequest
MERCHANT
CARTÃO PROTEGIDO
SaveCreditCardResponse
Tabela 1 - SaveCreditCardRequest
Parâmetros
Tipo
Descrição
Obrigatório?
MerchantKey
Guid
Chave da loja JustClick
Sim
CustomerIdentification
string
CPF do comprador
Não
CustomerName
string
Nome do comprador
Sim
CardHolder
string
Nome do Portador do cartão de crédito
Sim
CardNumber
string
Número do cartão de crédito
Sim
CardExpiration
string
Validade do cartão de crédito. Formato:
mm/yyyy
Sim
JustClickAlias
string
Alias (Apelido) do cartão de crédito
Não
RequestId
Guid
Identificador da requisição enviada
Sim
Version
string
Versão do método. Padrão: 2.0
Não
Tabela 2 - SaveCreditCardResponse
Parâmetros
Tipo
JustClickKey
Guid
CorrelationId
Guid
Success
bool
Telefone: (21)2111-4700 / (11) 3320-9050
http://suporte.braspag.com.br
Descrição
Obrigatório?
Token (Chave identificadora) que representa
o cartão de crédito
Identificador da resposta recebida, que será o
próprio “RequestId” enviado no objeto de
request
Indicador de sucesso no fluxo da operação
(true ou false). No caso de FALSE, significa
que a requisição não foi concluída com êxito e
Sim
Sm
Não
Página 11 de 17
Manual de Integração
Cartão Protegido
portanto todos os demais parâmetros de
retorno podem ser ignorados
ErrorReportCollection
List<ErrorReport>
Lista de erros/validações gerados no fluxo da
operação. Vide seção “Mapa de Erros”
Não
7.2. RECUPERAÇÃO do número do Cartão de Crédito, com retorno Mascarado
O método GetMaskedCreditCard recebe o objeto GetMaskedCreditCardRequest, e deve ser chamado para
consultar os dados de um cartão de crédito de forma PCI Compliance, ou seja, apenas o número mascarado do cartão
é retornado no método GetMaskedCreditCardResponse, juntamente com as demais informações não sensíveis.
Getting a Masked Credit Card - GetMaskedCreditCard() method
GetMaskedCreditCardRequest
MERCHANT
CARTÃO PROTEGIDO
GetMaskedCreditCardResponse
Tabela 3 - GetMaskedCreditCardRequest
Parâmetros
Tipo
Descrição
Obrigatório?
MerchantKey
Guid
Chave da loja JustClick
Sim
JustClickKey
Guid
Token que representa o cartão de crédito
Sim
JustClickAlias
string
Alias (Apelido) do cartão de crédito
Não
RequestId
Guid
Identificador da requisição enviada
Não
Version
string
Versão do método. Padrão: 2.0
Não
Tabela 4 - GetMaskedCreditCardResponse
Parâmetros
Tipo
CardHolder
string
Portador do cartão de crédito
Sim
CardExpiration
string
Validade do cartão de crédito. Formato: mm/yyyy
Sim
MaskedCardNumber
string
Número do cartão de crédito mascarado
Sim
CorrelationId
Guid
Identificador da resposta recebida, que será o próprio
“RequestId” enviado no objeto de request
Não
Success
bool
Indicador de sucesso no fluxo da operação (true ou
false). No caso de FALSE, significa que a requisição não
foi concluída com êxito e portanto todos os demais
parâmetros de retorno podem ser ignorados
Não
ErrorReportCollection
List<ErrorReport>
Lista de erros/validações gerados no fluxo da operação.
Vide seção “Mapa de Erros”
Não
Telefone: (21)2111-4700 / (11) 3320-9050
http://suporte.braspag.com.br
Descrição
Obrigatório?
Página 12 de 17
Manual de Integração
Cartão Protegido
7.3. RECUPERANDO uma JustClickKey
O método GetJustClickKey recebe o objeto GetJustClickKeyRequest, e deve ser chamado para consultar uma
JustClickKey. Em geral, esse método será utilizado apenas quando o lojista, por algum motivo, perder a JustClickKey
de um usuário. Por questões de segurança, ao utilizar esse método 5 (cinco) vezes consecutivas passando um
‘SaveCreditCardRequestId’ inválido, a loja ficará impossibilitada de utilizar o método até que entre em contato com o
suporte da Braspag para efetuar a liberação.
Getting a JustClickKey - GetJustClickKey() method
GetJustClickKeyRequest
MERCHANT
CARTÃO PROTEGIDO
GetJustClickKeyResponse
Tabela 7 - GetJustClickKeyRequest
Parâmetros
Tipo
Descrição
Obrigatório?
MerchantKey
Guid
Chave da loja JustClick
Sim
SaveCreditCardRequestId
Guid
Identificador da requisição ao método SaveCreditCard
(parâmetro “RequestId”) que resultou no
armazenamento do cartão de crédito na plataforma do
Cartão Protegido.
Sim
RequestId
Guid
Identificador da requisição enviada
Não
Version
string
Versão do método. Padrão: 2.0
Não
Tabela 8 - GetJustClickKeyResponse
Parâmetros
Tipo
JustClickKey
Guid
Token que representa o cartão de crédito
Sim
CorrelationId
Guid
Identificador da resposta recebida, que será o próprio
“RequestId” enviado no objeto de request
Não
Success
bool
Indicador de sucesso no fluxo da operação (true ou
false). No caso de FALSE, significa que a requisição
não foi concluída com êxito e portanto todos os demais
parâmetros de retorno podem ser ignorados
Não
ErrorReportCollection
List<ErrorReport>
Lista de erros/validações gerados no fluxo da
operação. Vide seção “Mapa de Erros”
Não
Telefone: (21)2111-4700 / (11) 3320-9050
http://suporte.braspag.com.br
Descrição
Obrigatório?
Página 13 de 17
Manual de Integração
Cartão Protegido
7.4. Invalidando um Cartão de Crédito
O método InvalidateCreditCard recebe o objeto InvalidateCreditCardRequest, e deve ser chamado para
invalidar um cartão de crédito. Um cartão inválido não pode ser utilizado numa autorização do PAGADOR
Invalidating a Credit Card - InvalidateCreditCard() method
InvalidateCreditCardRequest
MERCHANT
CARTÃO PROTEGIDO
InvalidateCreditCardResponse
Tabela 9 - InvalidateCreditCardRequest
Parâmetros
Tipo
Descrição
Obrigatório?
MerchantKey
Guid
Chave da loja JustClick
Sim
JustClickKey
Guid
Token que representa o cartão de crédito
Sim
JustClickAlias
string
Alias (Apelido) do cartão de crédito
Não
RequestId
Guid
Identificador da requisição enviada
Não
Version
string
Versão do método. Padrão: 2.0
Não
Tabela 10 - InvalidateCreditCardResponse
Parâmetros
Tipo
CorrelationId
Guid
Identificador da resposta recebida, que será o próprio
“RequestId” enviado no objeto de request
Não
Success
bool
Indicador de sucesso no fluxo da operação (true ou
false). No caso de FALSE, significa que a requisição não
foi concluída com êxito e portanto todos os demais
parâmetros de retorno podem ser ignorados
Não
ErrorReportCollection
List<ErrorReport>
Lista de erros/validações gerados no fluxo da operação.
Vide seção “Mapa de Erros”
Não
Telefone: (21)2111-4700 / (11) 3320-9050
http://suporte.braspag.com.br
Descrição
Obrigatório?
Página 14 de 17
Manual de Integração
Cartão Protegido
Detalhes importantes no consumo dos métodos:
“RequestID”/ “CorrelationID”: No envio do objeto de Request, deve ser enviado no parâmetro “RequestID” um
guid qualquer que funcionará como uma chave identificadora daquela requisição. Após processamento do Request em
questão, o objeto de Response será montado com o devido resultado e o parâmetro “CorrelationID” conterá o mesmo
guid enviado no Request (“RequestID”). Desta forma é possível se certificar de qual Request o objeto Response é
proveniente;
“Success”: Todo objeto de Response possui o parâmetro “Success” que indica se a requisição foi processada com
sucesso ou não pela aplicação. Quando o retorno do “Sucess” for FALSE significa que houve falha no recebimento e/ou
processamento, ou seja, o método não conseguiu executar a função a qual ele se propõe. Assim, este deve ser o
primeiro parâmetro a ser checado no retorno de uma requisição. Sendo FALSE, todo o processamento subsequente
deve ser abortado e o erro analisado e tratado.
“ErrorReportCollection”: Todo objeto de Response possui o parâmetro “ErrorReportCollection” que conterá o(s)
erro(s) ocorrido(s) no processamento, ou seja, quando o parâmetro “Sucess” for FALSE. Erro de processamento pode
ser devido a um parâmetro incorreto ou a falta de um parâmetro esperado.
Telefone: (21)2111-4700 / (11) 3320-9050
http://suporte.braspag.com.br
Página 15 de 17
Manual de Integração
Cartão Protegido
8.
MAPA DE ERROS
Abaixo segue a lista dos possíveis erros retornado pelos métodos no campo “ErrorReportCollection”
Código
Mensagem
701
Merchant key can not be null
702
Merchant key is not valid
703
JustClick key can not be null
704
JustClick key is not valid
705
Customer name can not be null
706
Card holder can not be null
707
Card number can not be null
709
Card expiration can not be null
710
Card expiration is not valid (Format: MM/yyyy)
720
Merchant JustClick not found
724
Credit card not exists for merchant
731
Invalid IP address
732
SaveCreditCardRequestId can not be null
733
SaveCreditCardRequestId not found for this Merchant
734
Numbers of attempts to Recovery JustClickKey exceeded
735
Save Credit Card Request Id Already Exists
747
Empty Request
749
JustClickAlias Already Exists
750
Extra Data Name Is Not Valid
751
JustClickAlias Is Not Filled
752
Data Collection Can Not Be Empty
753
JustClickAlias Is Mandatory
799
Undefined error
Telefone: (21)2111-4700 / (11) 3320-9050
http://suporte.braspag.com.br
Página 16 de 17
Manual de Integração
Cartão Protegido
9.
MEIOS DE PAGAMENTOS ACEITOS NA AUTORIZAÇÃO VIA PAGADOR
Na utilização do método de autorização do CARTÃO PROTEGIDO, são aceitos todos os meios de pagamento de
cartão de crédito existentes na integração via webservice do PAGADOR , bastando que o estabelecimento possua
afiliação para tal.
Meios de pagamento que necessariamente funcionam via Post, como Cielo Visa Electron ou Mastercard Komerci, não
podem ser utilizados quando a integração for diretamente via plataforma do CARTÃO PROTEGIDO.
Telefone: (21)2111-4700 / (11) 3320-9050
http://suporte.braspag.com.br
Página 17 de 17