Pagador Transaction. Autorização, Captura, Cancelamento e Estorno. Versão

Transcrição

1 Versão /07/2014

2 SUMÁRIO HISTÓRICO DE ALTERAÇÕES... 3 INTRODUÇÃO AUTORIZAÇÃO MÉTODO AUTHORIZETRANSACTION RETORNO DO MÉTODO AUTHORIZETRANSACTION CAPTURA MÉTODO CAPTURECREDITCARDTRANSACTION RETORNO DO MÉTODO CAPTURECREDITCARDTRANSACTION CANCELAMENTO MÉTODO VOIDCREDITCARDTRANSACTION RETORNO DO MÉTODO VOIDCREDITCARDTRANSACTION REFUND (ESTORNO) MÉTODO REFUNDCREDITCARDTRANSACTION RETORNO DO MÉTODO REFUNDCREDITCARDTRANSACTION MUDANÇA DE STATUS (2º POST) ANINHAMENTO DE TRANSAÇÕES RETENTATIVA POST DE NOTIFICAÇÃO DA RETENTATIVA JUSTCLICK (CARTÃO PROTEGIDO) TABELAS DE DOMÍNIO MAPA DE ERROS SOAP DE EXEMPLO MÉTODO AUTHORIZETRANSACTION MÉTODO AUTHORIZETRANSACTIONNPAYMENTS MÉTODO CAPTURECREDITCARDTRANSACTION MÉTODO VOIDCREDITCARDTRANSACTION MÉTODO REFUNDCREDITCARDTRANSACTION SOFTDESCRIPTOR INSERINDO DADOS ADICIONAIS ONEBUY CARTÃO PRESENTE ALELO CARTÕES DE TESTE Telefone: (21) / (11) Página 2 de 38

3 HISTÓRICO DE ALTERAÇÕES Pagador Transaction Versão Data Descrição /01/2012 Versão inicial /04/2012 Inclusão: Retentativa;Incusão do exemplo de desenvolvimento;bloqueio de duplicidade;ips;soap de exemplo Authorize /05/2012 Inclusão de novos meios de pagamento: 524 até /05/2012 Inclusão do Post de Notificação do serviço de Retentativa; fluxo retentativa /06/2012 Alteração do Método AuthorizeCreditCardTransaction e CreateBoletoTransaction para AuthorizeTransaction /06/2012 Inclusão de novos meios de pagamento: 995 e /08/ /08/2012 Alteração da Soap de Exemplo: Método AuthorizeTransaction; Inserção das Soaps de Exemplo: AuthorizeTransactionNPayments, CaptureCreditCardTransaction, VoidCreditCardTransaction Inclusão do Método RefundCreditCardTransaction Alteração do Método VoidCreditCardTransaction /08/2012 Inclusão do Recurso SoftDescriptor /09/2012 Inclusão dos Erros BP Inclusão do Método: InsertTransactionAdditionalDataRequest /01/2013 Inclusão dos Códigos 5 e 6 na Tabela Tipo de Transação /04/2013 Alteração do Recurso SoftDescriptor /05/ /06/2013 Inclusão de novo meio de pagamento: 535, 536, 537, 538, 539, 540, 541, 542, 543, 544 e 545 Inserção do item OneBuy; Inserção dos objetos: OneBuyDataRequest e OneBuyDataResponse; Inserção do Parâmetro ProofOfSales nos objetos: CreditCardDataResponse e TransactionDataResponse; Atualização do ítem: Cartões de Teste; Remoção dos Meios de Pagamento: 520, 521 e 522; Inserção do Meio de Pagamento: /07/2013 Alteração da obrigatoriedade do Parâmetro CustomerIdentity /07/2013 Inclusão do Parâmetro: ServiceTaxAmount nas tabelas 13.11, e Inserção dos Meios de Pagamento: 6, 7, 8, 9, 10, 13, 14, 124, /09/2013 Alteração da obrigatoriedade do Parâmetro CardNumber /09/ /11/2013 Inclusão do novo meio de pagamento 548; Alteração no nome do meio de pagamento 546 para Cartão Presente/Alelo Alteração do item Retentativa: Alteração das Regras; Inclusão da Lista de Código de Erros - Cielo e Redecard Inserção dos Meios de Pagamento: 550 e 551; Alteração da obrigatoriedade do Parâmetro CustomerIdentity; Inclusão status de retorno para Estorno Redecard; Alteração da Soap de Exemplo: Método AuthorizeTransaction Inclusão do nó CustomerIdentityType Telefone: (21) / (11) Página 3 de 38

4 /11/2013 Alteração da obrigatoriedade do campo ServiceTaxAmount /12/2013 Inclusão da observação sobre as URLs de Integração /02/2014 Inclusão do meio de pagamento Boleto na descrição do Objetivo ; Alteração da Descrição dos Métodos Void e Refund; Inclusão dos Meios de Pagamento: 123 e 552; Inclusão do objeto DebitCardDataRequest; Inclusão do Parâmetro AuthenticationUrl no objeto CreditCardDataResponse e DebitCardDataResponse; Inclusão da Tabela de Países /02/2014 Alteração do nome do meio de pagamento Cielo Mastercard Maestro para Cielo Mastercard Débito /07/2014 Inclusão do código de erro BP07 Timeout para requisição da Redecard /07/2014 Inclusão de novo meio de pagamento: 565 Telefone: (21) / (11) Página 4 de 38

5 INTRODUÇÃO Webservice é uma solução capaz de integrar aplicações e componentes de negócios. E utilizando como meio, a Internet, mantendo segurança das informações trafegadas. As principais vantagens de utilizar webservices são: interoperabilidade entre aplicações distintas e fisicamente distantes, portabilidade entre diferentes plataformas, facilidade de integração e suporte, redução de custos para transporte de dados e formato universal. Para a Plataforma Pagador, o webservice foi desenvolvido em plataforma Microsoft.NET, oferecendo aos desenvolvedores a possibilidade de integração em três meios diferentes:.net, SOAP/XML, HTTP/POST. Desta forma, o estabelecimento que quiser utilizar o webservice, não necessita instalar novos sistemas, podendo operar em sua plataforma atual, sem mudanças ou adaptações. OBJETIVO Guiar o desenvolvedor da loja virtual na Integração com a solução de comércio eletrônico da Braspag, de modo a disponibilizar ao lojista a possibilidade de venda com cartão de crédito e boleto via webservice. Url de Homologação: Para homologar temos métodos de pagamento e cartões que simulam operações de crédito. Para mais informações consulte Cartões de Teste. Para acesso ao código descritivo do webservice (WSDL), acessar o link Service Description, conforme abaixo: A integração deve ser feita sempre usando URL e em hipótese alguma por IP ou usando nomes como ou apenas pagador.com.br. Para receber a URL de Produção, solicite à nossa equipe de implantação através da ferramenta Suporte. O Bloqueio de IP não é obrigatório, porém recomendamos por medidas de segurança. Bloqueio de Pedidos para transações com mesmo BraspagTransactionID e mesmo OrderID. O Bloqueio ativo só funcionará para pedidos que constam na Braspag com o status Não Pago e Pago. O Bloqueio não pode ser utilizado para os clientes que utilizarem as funcionalidades de Aninhamento e Retentativa. Este bloqueio só funciona para pedidos efetuados com o mesmo meio de pagamento, ou seja, se um pedido for enviado via cartão de crédito e depois o mesmo pedido como boleto, a função habilitada NÃO bloqueará o pedido. Telefone: (21) / (11) Página 5 de 38

6 Para habilitar essa funcionalidade é necessário solicitar à Equipe de Implantação através da ferramenta de suporte (). Estão descritos neste manual quatro funcionalidades do Webservice PagadorTransaction: AuthorizeTransaction Este é utilizado para autorizar/gerar transações. CaptureCreditCardTransaction Método utilizado para capturar a transação de acordo com o valor requerido. VoidCreditCardTransaction Este método realiza o cancelamento de um pedido, desde que isso ocorra no mesmo dia da transação(autorização ou Captura), até às 23h59m. RefundCreditCardTransaction Este método realiza o estorno de um pedido, desde que isso ocorra no dia posterior ao da transação(captura), após 23h59m do dia da compra. INFORMAÇÕES IMPORTANTES Fluxo de uma transação Autorização e captura, sendo suportado o cancelamento no mesmo dia, se necessário. Autorização Captura Captura Automática Via Braspag - Utilizando, ou não, o delay Via Webservice Cancelamento Refund (Estorno) Conceito utilizado apenas para cartões de crédito e débito online. No caso do cartão, a autorização é a primeira perna da transação. Apenas verifica se o cartão é válido, se tem limite e retém o limite até segunda ordem (por no máximo 5 dias corridos). Conceito utilizado para cartões de crédito. É a segunda perna da transação, após a autorização, a transação deve ser capturada, isto é, deve-se confirmar que ela realmente irá ocorrer. Ocorre na primeira etapa do fluxo, no ato da autorização. A transação é autorizada e capturada na mesma etapa. Disponibilidade conforme meio de pagamento A responsabilidade da captura é da Braspag desde que solictada, filtramos todas as transações com status NÃO PAGO (Autorizado) e solicitando a captura junto a adquirente. Automaticamente após a autorização, ou o prazo estipulado para delay A responsabilidade da captura é do cliente. Caracteriza o delay de captura cadastrado via Admin, onde o mesmo realiza a captura no momento mais oportuno. Quando uma transação é desfeita (cancelada) pelo estabelecimento/lojista até as 23:59:59 do mesmo dia da captura, pois a validação da venda na adquirente ocorre somente às 00:00:00 do próximo dia. Quando uma transação é desfeita (estornada) pelo estabelecimento/lojista após as 23:59:59 do dia da realização da captura. ChargeBack Quando a transação é contestada junto ao banco emissor pelo portador do cartão (É o não reconhecimento da compra). Telefone: (21) / (11) Página 6 de 38

7 Fluxo Transacional Cliente Pagador Adquirente AuthorizeTransactionRequest Save Request Request Adquirente Response Adquirente Save Response AuthorizeTransactionResponse CaptureCreditCardTransactionRequest Save Request Request Adquirente Response Adquirente Save Response CaptureCreditCardTransactionResponse Parâmetros 2º Post Resposta Cliente VoidCreditCardTransactionRequest Save Request Request Adquirente Response Adquirente Save Response VoidCreditCardTransactionResponse RefundCreditCardTransactionRequest Save Request Request Adquirente Response Adquirente Save Response RefundCreditCardTransactionResponse AuthorizeTransactionRequest Save Boleto AuthorizeTransactionResponse Telefone: (21) / (11) Página 7 de 38

8 1. AUTORIZAÇÃO Para o envio de transações de variados meios de pagamentos (Cartão de Crédito, Boleto e etc), deve se utilizar o método AuthorizeTransaction. Para homologar temos métodos de pagamento e cartões que simulam operações de crédito. Para mais informações consulte Cartões de Teste Método AuthorizeTransaction Para realizar autorizações deve-se chamar o método AuthorizeTransaction. Este método é utilizado para autorizar transações de cartão de crédito, boleto entre outros e recebe o objeto AuthorizeTransactionRequest com as seguintes propriedades. Tabela 1 Propriedades do objeto AuthorizeTransactionRequest Parâmetro Descrição Tipo Obrigatório RequestId É o campo identificador desta requisição de autorização no formato: { } Guid Version Versão do contrato do Webservice (ex.: 1.0 ) string OrderData Dados do pedido OrderDataRequest (Tabela 13) PaymentData Collection Coleção de dados do pagamento ArrayOfPaymentDataReq uest (Tabela 13.1) CustomerData Consultar propriedades do CustomerDataRequest CustomerDataRequest (Tabela 13.6) 1.2. Retorno do Método AuthorizeTransaction O método AuthorizeTransaction retornará o objeto AuthorizeTransactionResponse com as propriedades a seguir. É obrigatório o armazenamento dos dados de retorno. Tabela 2 Propriedades do objeto AuthorizeTransactionResponse Parâmetro Descrição Tipo CorrelationId Identificador da requisição do Webservice Guid Success ErrorReportData Collection OrderData PaymentData Collection Se a requisição chegou até a operadora, Success = true, caso contrário Success = false Coleção de itens contendo erros da requisição Dados do pedido Coleção de dados do pagamento bool ArrayOfErrorReportData Response (Tabela 13.9) OrderDataResponse (Tabela 13.10) ArrayOfPaymentDataResponse (Tabela 13.11) Telefone: (21) / (11) Página 8 de 38

9 2. CAPTURA Para realizar capturas deve-se chamar o método CaptureCreditCardTransaction. Este método é utilizado para capturar as transações de cartão de crédito depois de autorizadas (com o status Não pago, no Admin). Este Webservice é útil para empresas que não trabalham com captura automática, ou seja, programam um delay nas capturas dos cartões de crédito Método CaptureCreditCardTransaction O método CaptureCreditCardTransaction recebe um objeto CaptureCreditCardTransactionRequest com as propriedades a seguir. Tabela 3 Propriedades do objeto CaptureCreditCardTransactionRequest Parâmetro Descrição Tipo Obrigatório RequestId É o campo identificador do pedido no formato: { } Guid Version Versão do contrato do Webservice (ex.: 1.0 ) string MerchantId É o campo identificador da loja no formato: { } Guid TransactionData Collection Coleção de transações a serem capturadas ArrayOfTransaction DataRequest (Tabela 13.16) 2.2. Retorno do Método CaptureCreditCardTransaction O método CaptureCreditCardTransaction retornará um objeto response com as propriedades abaixo: Tabela 4 Propriedade do objeto CaptureCreditCardTransactionResponse Parâmetro Descrição Tipo CorrelationId Identificador da requisição do Webservice Guid Success ErrorReportData Collection TransactionData Collection Se a requisição chegou até a operadora, Success = true, caso contrário Success = false Coleção de itens contendo erros da requisição Coleção de respostas para as transações enviadas bool ArrayOfErrorReportData Response (Tabela 13.9) ArrayOf TransactionDataResponse (Tabela 13.17) Tabela 4.1 Possíveis status de retorno do método CaptureCreditCardTransaction Status Código Descrição Capturado 0 O pedido foi capturado com Sucesso Negado 2 O pedido de captura foi negado checar campo message Erro interno null Um erro aconteceu antes de o pedido ser enviado à Adquirente 3. CANCELAMENTO Telefone: (21) / (11) Página 9 de 38

10 Para realizar cancelamento de pedidos de cartão de crédito via Webservice, deve-se chamar o método VoidCreditCardTransaction. Este Webservice poderá ser utilizado de duas maneiras: Para cancelar uma venda antes da captura (para clientes que utilizam delay de captura); Para cancelar pedidos até às 23h59min (horário de Brasília) do mesmo dia da captura. Qualquer pedido que esteja fora deste prazo não poderá ser cancelado com este método, sendo necessário utilizar o método RefundCreditCardTransaction. OBS: Todos os parâmetros devem ser enviados como string. Existem algumas particularidades para American Express e Redecard: Para American Express e Banorte só poderá ser cancelado um pedido depois de sua captura; Para Redecard será necessário informar o usuário e senha (criado no Portal da Redecard) à equipe de implantação, através da ferramenta de Suporte (/) Método VoidCreditCardTransaction Este método recebe um objeto VoidCreditCardTransactionRequest com as seguintes propriedades: Tabela 5 Propriedades do objeto VoidCreditCardTransactionRequest Parâmetro Descrição Tipo Obrigatório RequestId É o campo identificador do pedido no formato: { } Guid Version Versão do contrato do Webservice (ex.: 1.0 ) string MerchantId É o campo identificador da loja no formato: { } Guid TransactionData Collection Coleção de transações a serem canceladas ArrayOfTransaction DataRequest (Tabela 13.16) 3.2. Retorno do Método VoidCreditCardTransaction O método VoidCreditCardTransaction, retornará um objeto VoidCreditCardTransactionResponse com as propriedades abaixo: Tabela 6 Propriedade do objeto VoidCreditCardTransactionResponse Parâmetro Descrição Tipo CorrelationId Identificador da requisição do Webservice. Guid Success ErrorReportData Collection TransactionData Collection Se a requisição chegou até a operadora, Success = true, caso contrário Success = false. Coleção de itens contendo erros da requisição Coleção de respostas para as transações enviadas. bool ArrayOfErrorReportData Response (Tabela 13.9) ArrayOf TransactionDataResponse (Tabela 13.17) OBS: Caso o parâmetro amount não seja enviado ou contenha o valor 0, o cancelamento será no valor integral da transação Telefone: (21) / (11) Página 10 de 38

11 Tabela 7 Possíveis status de retorno do método VoidTransaction Status Código Descrição VoidConfirmed 0 O pedido foi cancelado com sucesso VoidDenied 1 O pedido não foi cancelado InvalidTransaction 2 O pedido não foi encontrado ou já foi cancelado no sistema 4. REFUND (ESTORNO) Para realizar Estorno de pedidos via Webservice, deve-se chamar o método RefundCreditCardTransaction. Este Webservice poderá ser utilizado: Para estornar pedidos após 23h59min (horário de Brasília) do dia da realização da captura Método RefundCreditCardTransaction Este método recebe um objeto RefundCreditCardTransactionRequest com as seguintes propriedades: Tabela 8 Propriedades do objeto RefundCreditCardTransactionRequest Parâmetro Descrição Tipo Obrigatório RequestId É o campo identificador do pedido no formato: { } Guid Version Versão do contrato do Webservice (ex.: 1.0 ) string MerchantId É o campo identificador da loja no formato: { } Guid TransactionData Collection Coleção de transações a serem estornadas ArrayOfTransaction DataRequest (Tabela 13.16) 4.2. Retorno do Método RefundCreditCardTransaction O método RefundCreditCardTransaction, retornará um objeto RefundCreditCardTransactionResponse com as propriedades abaixo: Tabela 9 Propriedade do objeto RefundCreditCardTransactionResponse Parâmetro Descrição Tipo CorrelationId Identificador da requisição do Webservice. Guid Success ErrorReportData Collection Se a requisição chegou até a operadora, Success = true, caso contrário Success = false. Coleção de itens contendo erros da requisição bool ArrayOfErrorReportData Response (Tabela 13.9) Telefone: (21) / (11) Página 11 de 38

12 TransactionData Collection Coleção de respostas para as transações enviadas. ArrayOf TransactionDataResponse (Tabela 13.17) OBS: Caso o parâmetro amount não seja enviado ou contenha o valor 0, o estorno será no valor integral da transação Tabela 10 Possíveis status de retorno do método RefundCreditCardTransaction Status Código Descrição RefundConfirmed 0 O pedido foi estornado com sucesso RefundDenied 1 O pedido não foi estornado InvalidTransaction 2 O pedido não foi encontrado ou já foi estornado no sistema RefundAccepted* 3 Solicitação de estorno recebida OBS: O status 3 é exclusivo para transações Redecard. O estorno é processado pela Redecard durante a madrugada que segue a solicitação de estorno. Para a solicitação de estorno ser processada na madrugada é preciso enviar a mesma antes das 18:00h. O retorno é D+1 para solicitações recebidas até as 18:00h ou D+2 para solicitações recebidas após as 18:00h. Após o retorno da Redecard a transação pode ser marcada como Estornada, no caso da Redecard aceitar o pedido de estorno, ou continuar como Paga, caso a Redecard negue o Estorno. Telefone: (21) / (11) Página 12 de 38

13 5. MUDANÇA DE STATUS (2º POST) A URL de mudança de status é fornecida pelo cliente para cadastro junto a Braspag. Nessa URL serão postadas as informações de todos os pedidos que tiverem seu status alterado para PAGO. Cliente BrasPag FIM INÍCIO SIM OK? NÃO RETORNO STATUS DE PAGAMENTO ENVIA (POR 3 VEZES) PARA O FINAL DA FILA 2 POST URL MUDANÇA DE STATUS 2º POST Database NÃO SIM Status alterado p/ Capturado? Tabela 11 - Parâmetros enviados pelo 2º Post Parâmetro Descrição Tipo Obrigatório NumPedido Número do pedido do cliente String Status Status do Pagamento = 0 (Pago) string CODPAGAMENTO Código do Meio de Pagamento (Tabela 13.19) Int16 É necessário solicitar a Equipe de Implementação o cadastramento da URL de Mudança de Status. Quando acessada pelo servidor da Braspag, enviando o POST da Tabela 11, a URL cadastrada para Retorno de Mudança de Status, deverá exibir um código informando que recebeu a mudança de status e a processou com sucesso. <status>ok</status> Se a URL de mudança de status da loja for acessada pelo servidor da Braspag não exibir o código de confirmação, o servidor irá tentar novamente por três vezes, a cada hora. Caso o <status>ok</status> ainda não seja exibido, será entendido que o servidor da loja não responde, e será enviado um ao responsável pela loja, informando que o pedido em questão foi pago. Ou seja, o código fonte da página indicando Sucesso deverá conter APENAS <status>ok</status> e nada mais. Telefone: (21) / (11) Página 13 de 38

14 A URL de mudança de Status de Pagamento somente pode utilizar porta 80 (padrão para http) ou porta 443 (padrão para https). Exemplo de POST em sua URL: FORM/POST PARAMETERS Status: 0 NumPedido: CODPAGAMENTO: 501 RAW BODY NumPedido=16135&Status=0&CODPAGAMENTO= ANINHAMENTO DE TRANSAÇÕES Entende-se por Aninhamento de Transações, a possibilidade do cliente enviar "n" transações, utilizando inclusive meios de pagamentos diversificados (Cartão de Crédito, Boleto e Débito), através de um identificador único retornado pela Braspag a cada transação (BraspagOrderID - BOI); CLIENTE ENVIA RESPOSTA DE BOI INVÁLIDO DB NÃO ENVIA TRANSAÇÃO TEM BOI? SIM CONSULTA BOI BOI VÁLIDO? SIM DB REALIZA ANINHAMENTO DB NÃO BOI DATABASE CRIA E ARMAZENA BOI COMPRA AUTORIZADA? SIM ENVIA RESPONSE C/ BOI NÃO As principais funcionalidades do Aninhamento de Transações são: O BraspagOrderID será retornado pela Braspag a cada transação, seja ela realizada via Post ou WS ; Telefone: (21) / (11) Página 14 de 38

15 Aninhar n transações enviadas pelo cliente (desde que o mesmo tenha enviado o mesmo BOI, das demais transações); Validação do BOI pela Braspag a cada requisição; A utilização de mais de um meio de pagamento. Telefone: (21) / (11) Página 15 de 38

16 7. RETENTATIVA Entende-se por Retentativa, a possibilidade de retentar automaticamente uma transação de cartão de crédito rejeitada, utilizando inclusive adquirentes diferentes. Através de um cadastro prévio junto a Braspag e as afiliações dos Meios de Pagamentos estarem liberadas para transacionar sem CVV. CLIENTE BRASPAG ADQUIRENTE CONFIGS: ADQUIRENTE 1 ADQUIRENTE 2 ADQUIRENTE 3 LOJA REQUISIÇÃO NÃO AUTORIZADA BP REQUISIÇÃO NÃO AUTORIZADA PROCESSA TRANSAÇÃO PERSISTE RETENTATIVAS NO BANCO BANCO DE RETENTATIVAS CONSULTA E ATUALIZA RETENTATIVAS A RETENTATIVA TERMINARÁ QUANDO FOR ATINGIDO NÚMERO MÁXIMO PREVIAMENTE CONFIGURADO NO ADMIN, OU QUANDO OBTIVER SUCESSO EM UMA DAS TENTATIVAS. Post de Notificação da Retentativa Sucesso ou Fracasso BP RETENTATIVA RETENTATIVA 1 RETENTATIVA 2 RETENTATIVA 3 RESPOSTA 1 - Não Autorizado RESPOSTA 2 Não Autorizado RESPOSTA 3 Autorizado PROCESSA TRANSAÇÃO Segue regras: Podem ser cadastradas quantidade de tentativas para cada Meio de Pagamento, no intervalo de no mínimo 1 e no máximo 5; Podem ser cadastrados os intervalo entre as tentativas, esse intervalo deverá ser em horas, respeitando o intervalo de no mínimo 1 e no máximo 48 (a configuração em horas). As afiliações utilizadas na Retentativa devem está habilitadas para transacionar sem CVV Para habilitar essa funcionalidade é necessário solicitar à Equipe de Implantação através da ferramenta de suporte (). Lista de Códigos de Erro - CIELO Estes são os LR (Catálogo de Códigos de resposta de Autorização Cielo). Esses códigos de retorno respondem por 99,9% dos retornos no processo de autorização. Outros códigos podem ser enviados, para esses casos deve-se assumir que eles não são passiveis de retentativa. (Manual E-commercer Cielo) Telefone: (21) / (11) Página 16 de 38

17 Códigos de retorno que está habilitado na Braspag (LR) Código de Resposta (LR) Descrição Permite Retentativa 06 Tente Novamente 51 Saldo Insuficiente 76 Tente Novamente 78 Cartão não foi desbloqueado 91 Banco Indisponível 96 Tente Novamente AA Tente Novamente As descrições acima são exclusivas para uso interno do estabelecimento comercial e não devem, sob hipotese alguma, ser divulgadas para o portador do cartão. Exceto código AA, todos os demais são gerados pelos emissores ou bandeiras. Catálogo de Erro Código Erro 001 Mensagem Inválida 003 Transação Inexistente 016 Identificador, TID inválido. 097 Sistema Indisponível 099 Erro Inesperado Telefone: (21) / (11) Página 17 de 38

18 Lista de Código de Erro REDECARD Após analises identificamos os códigos Redecard de maior índice de negativas, conforme a descrição do erro é passível de retentativas. Código de Resposta (LR) Descrição Permite Retentativa 05 Erro de edição 14 Database erro 51 Estabelecimento inválido 53 Transação não permitida pelo emissor 54 Não autorizada 56 Cartão usado recentemente 57 Não Autorizada 58 Não autorizada 74 Falha de Comunicação Connection with the aquire failed 7.1. Post de Notificação da Retentativa O Post de Notificação da Retentativa será enviado a loja após atingir o número máximo de tentativas previamente configurado ou quando ocorrer o SUCESSO. Tabela 12 - Parâmetros enviados pelo Post de notificação da Retentativa Parâmetro Descrição Tipo OrderId Número do pedido do cliente String PaymentMethod Código do meio de pagamento (Tabela 13.20) Int16 LastRetry Número da última retentativa realizada Int16 TotalRetries Número de retentativa configuradas Int16 RetryStatus BraspagOrderId Status da retentativa RetryStatus = 0 Finalizado com esgotamento de retentativa RetryStatus = 1 Finalizado com sucesso Identificador do pedido criado internamente. Se este campo já estiver preenchido, significa que a transação já passou pela Braspag e desejase agregar mais transações ao mesmo pedido * Int16 Guid BraspagTransactionId Id da transação na Braspag Guid Telefone: (21) / (11) Página 18 de 38

19 URL Post de Notificação é enviando nos seguintes cenários: Tentativa com Sucesso Número de tentativas esgotadas A URL cadastrada deverá exibir um código informando que recebeu a Notificação da Retentativa conforme os cenários acima e processou com sucesso. <status>ok</status> Se a URL da loja for acessada pelo servidor da Braspag não exibir o código de confirmação, o servidor irá tentar novamente por três vezes, a cada hora. A URL de mudança de Status de Pagamento somente pode utilizar porta 80 (padrão para http) ou porta 443 (padrão para https). Caso não seja retornado o OK, após as 3 tentativas a URL será bloqueada. E o desbloqueio deve ser solicitada a equipe de Operações. A URL de Notificação da Retentativa é fornecida pelo cliente para cadastro junto a Braspag. Nessa URL serão postadas as informações de Fracasso ou Sucesso do serviço de Retentativa. Para habilitar essa funcionalidade é necessário solicitar à Equipe de Implantação através da ferramenta de suporte (). 8. JUSTCLICK (CARTÃO PROTEGIDO) O JUSTCLICK é uma solução para fazer cobrança de transações pontuais de cartão de crédito (à vista ou parceladas) com resposta em real time e on-line para e-commerce e call-center, usando o conceito de 1- Click Shop (compra com 1 clique) ou venda sem digitação. A plataforma recebe os dados de uma venda e concecta-se ao PAGADOR para fazer o processamento. 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 seu aval. Parâmetro: SAVECREDITCARD (tabela 2) Indica se o cartão será salvo ou não na Plataforma do JustClick Parâmetro CREDITCARDTOKEN (tabela 2) Token do cartão de crédito gerado pela Plataforma JustClick Para a utilização dessa funcionalidade é necessário entrar em contato com a Equipe Comercial da Braspag. Telefone: (21) / (11) Página 19 de 38

20 9. TABELAS DE DOMÍNIO Tabela 13 Propriedades do objeto OrderDataRequest Parâmetro Descrição Tipo Obrigatório MerchantId É o campo identificador da loja no formato: { } Guid OrderId Numero do pedido no cliente string BraspagOrderId Identificador do pedido criado internamente. Se este campo já estiver preenchido, significa que a transação já passou pela Braspag e deseja-se agregar mais transações ao mesmo pedido * Guid Tabela 13.1 Propriedades do objeto PaymentDataRequest Parâmetro Descrição Tipo Obrigatório PaymentMethod Código do meio de pagamento (Tabela 13.18) short Amount Quantia a ser operada long Currency Moeda (ex.: BRL, USD, etc) string Country AdditionalData Collection País (ex.: BRA ) Coleção de dados adicionais Países (Tabela 13.21) ArrayOfAdditionalDataR equest (Tabela 13.8) *Essa tabela é comum a todos os meios de pagamentos disponíveis via Webservice (Cartão de Crédito CreditCardDataRequest, Boleto Bancário BoletoDataRequest, OneBuy OneBuyDataRequest e Cartão de Débito - DebitCardDataRequest). Tabela 13.2 Propriedades do objeto CreditCardDataRequest Parâmetro Descrição Tipo Obrigatório Não ServiceTaxAmount NumberOf Payments Montante do valor da autorização que deve ser destinado à taxa de serviço. Obs.: Esse valor não é adicionado ao valor da autorização Número de pagamentos short long Não PaymentPlan Código do plano de pagamento** byte TransactionType Tipo da Transação*** byte CardHolder Nome que consta no cartão de crédito string CardNumber Numero do cartão de crédito string (Caso seja enviado CreditCardToke n ou JustClickAlias, este parâmetro não será obrigatório) Telefone: (21) / (11) Página 20 de 38

21 CardSecurityCode CardExpiration Date CreditCardToken Código de segurança do cartão (Utilizar 6 dígitos para Givex) Data de expiração do cartão Identificador do cartão de crédito a ser usado na transação via JustClick string string Guid (Mas a loja pode ter habilitar aceitar CVV Nulo) (Não é obrigatório para Cartão Presente/Alelo) Não JustClickAlias Alias (Apelido) do cartão de crédito string Não SaveCreditCard Indica se é para armazenar os dados do cartão de crédito para uso do JustClick. A ação só será feita se a loja possuir o produto JustClick contratado boolean Não **Códigos Plano de Pagamento 0 À Vista 1 Parcelado pelo estabelecimento¹ 2 Parcelado pelo emissor do cartão² 3 Parcelado IATA pelo estabelecimento³ 4 Parcelado IATA pelo emissor do cartão³ 5 À Vista, com IATA ¹ Parcelamento realizado pelo estabelecimento sem juros. ² Parcelamento realizado pelo emissor com juros. ³ Tipo de pagamento exclusivo para companhias aéreas. ***Códigos Tipo de Transação 0 Valor inválido ou não existente 1 Pré-Autorização 2 Captura Automática 3 Pré-Autorização com Autenticação 4 Captura Automática com Autenticação 5 Pré-Autorização Recorrente 4 6 Captura Automática Recorrente 4 4 Somente para transações Cielo. Este tipo de transação não originará uma nova Recorrência, apenas permitirá a realização de uma transação sem a necessidade de envio do CVV. Telefone: (21) / (11) Página 21 de 38

22 Tabela 13.3 Propriedades do objeto DebitCardDataRequest Parâmetro Descrição Tipo Obrigatório Card Holder Nome que consta no cartão de crédito string Card Number Numero do cartão de crédito string Card Security Code Código de segurança do cartão string Card Expiration Date Data de expiração do cartão string * Propriedades exclusivas para Visa Electron e Mastercard Débito Tabela 13.4 Propriedades do objeto BoletoDataRequest Parâmetro Descrição Tipo Obrigatório BoletoNumber "NossoNumero". Caso não informe esse valor, a Braspag irá gerar automaticamente String Não BoletoInstructions Instruções a serem inclusas no boleto String Não BoletoExpiration Date Data de vencimento (formato: MM/dd/yyyy). Caso não informe, será utilizado os dias de vencimento confirgurado pela afiliação para tal String Não Tabela 13.5 Propriedades do objeto OneBuyDataRequest Parâmetro Descrição Tipo Obrigatório TokenOneBuy Token fornecido pelo aplicativo instalado em dispositivo mobile (XXXX-XXXX-XXXX-XXXX) string NumberOf Payments Número de pagamentos short PaymentPlan Código do plano de pagamento** byte Tabela 13.6 Propriedades do objeto CustomerDataRequest Parâmetro Descrição Tipo Obrigatório CustomerIdentity Identificação do cliente string Opcional / Obrigatório para o meio de Pagamento (CredSystem) CustomerIdentity Type Tipo de Identificação do Cliente String Não CustomerName Nome do cliente string Customer do cliente string Não CustomerAddress Data Endereço de cobrança do cartão AddressDataRequest (Tabela 13.7) Não Telefone: (21) / (11) Página 22 de 38

23 DeliveryAddress Data Endereço de entrega AddressDataRequest (Tabela 13.7) Não Tabela 13.7 Propriedades do objeto AddressDataRequest Parâmetro Descrição Tipo Obrigatório Street Rua string Não Number Número string Não Complement Complemento string Não District Bairro string Não ZipCode CEP string Não City Cidade string Não State Estado string Não Country País Paises (Tabela 13.21) Não Tabela 13.8 Propriedades do objeto AdditionalDataRequest Parâmetro Descrição Tipo Obrigatório Name Nome do campo string Não Value Valor do campo string Não Tabela 13.9 Propriedades do objeto ErrorReportDataResponse Parâmetro Descrição Tipo ErrorCode Código do erro na Braspag string ErrorMessage Mensagem descrevendo o motivo do erro string Tabela Propriedades do objeto OrderDataResponse Parâmetro Descrição Tipo OrderId Número do pedido no cliente string BraspagOrderId Número do pedido na Braspag Guid Telefone: (21) / (11) Página 23 de 38

24 Tabela Propriedades do objeto PaymentDataResponse Parâmetro Descrição Tipo BraspagTransactionId Id da transação na Braspag Guid Amount Valor operado pela operadora para a operação requerida (ex.: R$1,00 = 100) long PaymentMethod Código do meio de pagamento (Tabela 13.20) short Tabela Propriedades do objeto CreditCardDataResponse Parâmetro Descrição Tipo AcquirerTransactionId Id da transação na adquirente string AuthorizationCode Código de autorização string ReturnCode Código de retorno da adquirente string ReturnMessage Mensagem de retorno da adquirente string ProofOfSale Número do Comprovante de Venda string Status Status de retorno AtributoStatusdoobjetoCreditCard (Tabela ) byte CreditCardToken SerivceTaxAmount AuthenticationUrl Identificador do cartão de crédito a ser usado na transação via JustClick Montante do valor da transação a ser destinado como taxa de serviço utilizado pela operadora. URL para qual o Lojista deve redirecionar o Cliente para o fluxo de autenticação. Guid String string Tabela Valores do Atributo Status do objeto CreditCardDataResponse Status Código Descrição Capturado 0 Transação Capturada Autorizada 1 Transação Autorizada, pendente de captura. Não Autorizada 2 Transação não Autorizada, pela Adquirente. Erro Desqualificante Aguardando Resposta 3 Transação com erro Desqualificante. 4 Transação aguardando resposta. Telefone: (21) / (11) Página 24 de 38

25 Tabela Propriedades do objeto DebitCardDataResponse Parâmetro Descrição Tipo AcquirerTransactionId Id da transação na adquirente string ReturnCode Código de retorno da adquirente string ReturnMessage Mensagem de retorno da adquirente string Status Status de retorno AtributoStatusdoobjetoCreditCard (Tabela ) byte AuthenticationUrl URL para qual o Lojista deve redirecionar o Cliente para o fluxo de autenticação. string Tabela Propriedades do objeto BoletoDataResponse Parâmetro Descrição Tipo BoletoNumber "NossoNumero" gerado String BoletoExpiration Date Data de vencimento String BoletoUrl URL do boleto gerada String BarCodeNumber Representação numérica do código de barras String Assignor Campo cedente String Message Mensagem indicando Sucesso/Falha na geração do boleto String Tabela Propriedades do objeto OneBuyDataResponse Parâmetro Descrição Tipo AuthorizationCode Código de autorização string ReturnCode Código de retorno da adquirente string ReturnMessage Mensagem de retorno da adquirente string Status Status de retorno AtributoStatusdoobjetoOneBuy (Tabela ) byte Telefone: (21) / (11) Página 25 de 38

26 Tabela Valores do Atributo Status do objeto OneBuyDataResponse Status Código Descrição Capturado 0 Transação Capturada Autorizada 1 Transação Autorizada, pendente de captura. Não Autorizada 2 Transação não Autorizada, pela Adquirente. Erro Desqualificante Aguardando Resposta 3 Transação com erro Desqualificante. 4 Transação aguardando resposta. Tabela Propriedades do objeto TransactionDataRequest Parâmetro Descrição Tipo Obrigatório BraspagTransactionId Numero da transação na Braspag Guid Amount Valor a ser operado (ex.: R$1,00 = 100) long ServiceTaxAmount Montante do valor da autorização que deve ser destinado à taxa de serviço. Obs.: Esse valor não é adicionado ao valor da autorização string Não Tabela Propriedades do objeto TransactionDataResponse Parâmetro Descrição Tipo BraspagTransactionId Numero da transação na Braspag Guid AcquirerTransactionId Número da transação de captura na Operadora string Amount Valor operado pela operadora, total ou parcial da transação em centavos (ex.: R$1,00 = 100) long AuthorizationCode Código de autorização string ProofOfSale Número do Comprovante de Venda string ReturnCode Código de retorno da adquirente string ReturnMessage Mensagem de retorno da adquirente string Status ServiceTaxAmount Status de retorno (Captura) statusderetornodométodocapturecreditcardtransaction (tabela 4.1) Montante do valor da transação a ser destinado como taxa de serviço utilizado pela operadora. short string Telefone: (21) / (11) Página 26 de 38

27 Tabela Propriedades do objeto OrderTransactionDataResponse Parâmetro Descrição Tipo BraspagTransactionId Numero da transação na Braspag Guid OrderId Identificação do pedido no cliente string AcquirerTransactionI d Número da transação na Operadora string PaymentMethod Código do meio de pagamento int PaymentMethodName Nome do meio de pagamento string ErrorCode ErrorMessage Amount Código de erro da transação. Caso vazio não houve erro na transação Mensagem de erro da transação. Caso vazio não houve erro na transação Valor operado pela operadora, total ou parcial da transação em centavos (ex.: R$1,00 = 100) string string long AuthorizationCode Código de autorização string NumberOfPayments Numero de vezes em que a transação foi parcelada int Currency Moeda (ex.: BRL, USD, etc ) string Country País (ex.: BRA ) string Status Status de retorno short ReceivedDate Data em que a transação foi recebida na Braspag string CapturedDate VoidedDate CreditCardToken Data de captura da transação. Caso vazio a transação não foi capturada Data de cancelamento da transação. Caso vazio a transação não foi cancelada Identificador do cartão de crédito a ser usado na transação via JustClick string string string Tabela Propriedades do objeto AdditionalTransactionDataResponse Parâmetro Descrição Tipo Name Nome do campo do dado adicional string Value Valor do dado adicional string Telefone: (21) / (11) Página 27 de 38

28 Tabela Meios de Pagamento Códigos Meios de Pagamento 06 Boleto Bradesco 07 Boleto Caixa Econômica Federal 08 Boleto HSBC 09 Boleto Banco do Brasil 10 Boleto Real ABN AMRO 13 Boleto Citibank 14 Boleto Itaú 123 Cielo Visa Electron 124 Boleto Santander 500 Cielo VISA 501 Cielo MASTERCARD 502 Cielo AMEX 503 Cielo DINERS 504 Cielo ELO 505 Banorte VISA 506 Banorte MASTERCARD 507 Banorte DINERS 508 Banorte AMEX 509 Redecard Webservice VISA 510 Redecard Webservice MASTERCARD 511 Redecard Webservice DINERS 512 PagosOnLine VISA 513 PagosOnLine MASTERCARD 514 PagosOnLine AMEX 515 PagosOnLine DINERS 516 Payvision VISA 517 Payvision MASTERCARD Telefone: (21) / (11) Página 28 de 38

29 518 Payvision DINERS 519 Payvision AMEX 520 Banorte Cargos Automáticos VISA 521 Banorte Cargos Automáticos MASTERCARD 523 AMEX 2P 524 SITEF VISA 525 SITEF MASTERCARD 526 SITEF AMEX 527 DITEF DINERS 528 SITEF HIPERCARD 529 SITEF LEADER 530 SITEF AURA 531 SITEF SANTANDER VISA 532 SITEF SANTANDER MASTERCARD 533 ONEBUY 535 SUB1 VISA 536 SUB1 MASTERCARD 537 SUB1 - AMEX 538 SUB1 DINERS 539 SITEF SONDA 540 SUB1 NARANJA 541 SUB1 NEVADA 542 SUB1 CABAL 543 Cielo DISCOVER 544 Cielo JCB 545 Cielo AURA 546 Cartão Presente/Alelo 548 Redecard Hipercard Telefone: (21) / (11) Página 29 de 38

30 550 CredSystem 551 Boleto Caixa SIGCB 552 Cielo Mastercard Débito 565 CREDZ Tabela Países Sigla País BRA Brasil USA Estados Unidos MEX México COL Colômbia CHL Chile ARG Argentina PER Peru VEN Venezuela ECU Equador 10. MAPA DE ERROS Tabela 14 Mapeamento de Erros Código Nome Descrição 100 RequestIdIsMandatoryParameter RequestId is a mandatory parameter 101 VersionIsMandatoryParameter Version is a mandatory parameter 102 OrderDataIsMandatoryItem OrderData is a mandatory item 103 MerchantIdIsMandatoryParameter MerchantId is a mandatory parameter 104 BraspagTransactionIdIsMandatoryParameter BraspagTransactionId is a mandatory parameter Telefone: (21) / (11) Página 30 de 38

31 105 OrderIdIsMandatoryParameter OrderId is a mandatory parameter 106 BraspagOrderIdIsInvalidOrDoNotExists BraspagOrderId é inválido ou não existe 107 PaymentDataCollectionIsMandatoryItem PaymentDataCollection is a mandatory item 108 PaymentDataIsMandatoryItem PaymentData is a mandatory item 109 PaymentMethodIsInvalid PaymentMethod is invalid 110 AmountMustBeGreaterThanZero Amount must be greater than or equal to zero 111 CardNumberIsMandatoryParameter CardNumber is a mandatory parameter 112 CardExpirationDateIsMandatoryParameter CardExpirationDate is a mandatory parameter 113 CardExpirationDateIsInvalid CardExpiration is invalid 114 NumberOfPaymentsIsInvalid NumberOfPayments is invalid 115 PaymentPlanIsInvalid PaymentPlan is invalid 116 CurrencyIsMandatoryParameter Currency is a mandatory parameter 117 CountryIsMandatoryParameter Country is a mandatory parameter 118 TransactionTypeIsInvalid TransactionType is invalid 119 CustomerDataIsMandatoryItem CustomerData is mandatory item 120 CustomerIdentityIsMandatoryParameter CustomerIdentity is a mandatory parameter 121 CustomerNameIsMandatoryParameter CustomerName is a mandatory parameter 122 InvalidMerchantId Invalid MerchantId 123 CreditCardTokenIsInvalidOrDoNotExists CreditCardToken is invalid or does not exist 124 TransactionIdAlreadyExists TransactionId already exists 125 InvalidIpAddress Invalid IP address 126 PaymentMethodIsNotEnabled PaymentMethod is not enabled Telefone: (21) / (11) Página 31 de 38

32 127 CurrencyIsNotSupported 128 TransactionTypeIsNotSupported Currency submited is not supported for this payment method Transaction type submited is not supported for this payment method 129 CountryIsNotSupported Country is not supported 130 TransactionDataCollectionIsMandatoryItem TransactionDataCollection is a mandatory item 131 BraspagOrderIdIsMandatoryParameter BraspagOrderId is a mandatory parameter 132 TransactionNotAvailableForCapture Transaction not available for capture 133 BoletoExpirationDateisInvalid BoletoExpirationDate is invalid 134 Invalid Address Invalid Address 135 OrderId was already registered OrderId was already registered 199 UndefinedError Undefined error BP07 TimeOut* TimeOut BP900 Falha na Operação Falha na Operação BP901 Falha na Autorização Falha na Autorização BP902 Falha na Captura Falha na Captura BP903 Falha no Cancelamento Falha no Cancelamento BP904 Falha na Consulta Falha na Consulta * TimeOut em Requisição Redecard Telefone: (21) / (11) Página 32 de 38

33 11. SOAP DE EXEMPLO Método AuthorizeTransaction <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <AuthorizeTransaction xmlns=" <request> <OrderData> <MerchantId> </MerchantId> <OrderId>0000</OrderId> <BraspagOrderId xsi:nil="true" /> </OrderData> <CustomerData> <CustomerIdentity> </CustomerIdentity> <CustomerIdentityType>CPF</CustomerIdentityType> <CustomerName>Comprador Teste</CustomerName> <CustomerAddressData xsi:nil="true" /> <DeliveryAddressData xsi:nil="true" /> </CustomerData> <PaymentDataCollection> <PaymentDataRequest xsi:type="creditcarddatarequest"> <PaymentMethod>997</PaymentMethod> <Amount>500</Amount> <Currency>BRL</Currency> <Country>BRA</Country> <NumberOfPayments>1</NumberOfPayments> <PaymentPlan>0</PaymentPlan> <TransactionType>1</TransactionType> <CardHolder>Comprador Teste</CardHolder> <CardNumber> </CardNumber> <CardSecurityCode>123</CardSecurityCode> <CardExpirationDate>05/2018</CardExpirationDate> <AdditionalDataCollection xsi:nil="true" /> </PaymentDataRequest> </PaymentDataCollection> <RequestId> </RequestId> <Version>1.0</Version> </request> </AuthorizeTransaction> </soap:body> Método AuthorizeTransactionNPayments Obs.: Trata-se do método AuthorizeTransaction passando mais de um meio de pagamento <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <AuthorizeTransaction xmlns=" <request> <OrderData> <MerchantId> </MerchantId> <OrderId>0000</OrderId> <BraspagOrderId xsi:nil="true" /> </OrderData> <CustomerData> <CustomerIdentity> </CustomerIdentity> Telefone: (21) / (11) Página 33 de 38

34 <CustomerIdentityType>CPF</CustomerIdentityType> <CustomerName>Comprador Teste</CustomerName> <CustomerAddressData xsi:nil="true" /> <DeliveryAddressData xsi:nil="true" /> </CustomerData> <PaymentDataCollection> <PaymentDataRequest xsi:type="creditcarddatarequest"> <PaymentMethod>997</PaymentMethod> <Amount>500</Amount> <Currency>BRL</Currency> <Country>BRA</Country> <NumberOfPayments>1</NumberOfPayments> <PaymentPlan>0</PaymentPlan> <TransactionType>1</TransactionType> <CardHolder>Comprador Teste</CardHolder> <CardNumber> </CardNumber> <CardSecurityCode>123</CardSecurityCode> <CardExpirationDate>05/2018</CardExpirationDate> <AdditionalDataCollection xsi:nil="true" /> </PaymentDataRequest> <PaymentDataRequest xsi:type="creditcarddatarequest"> <PaymentMethod>997</PaymentMethod> <Amount>1000</Amount> <Currency>BRL</Currency> <Country>BRA</Country> <NumberOfPayments>1</NumberOfPayments> <PaymentPlan>0</PaymentPlan> <TransactionType>2</TransactionType> <CardHolder>Comprador Teste</CardHolder> <CardNumber> </CardNumber> <CardSecurityCode>123</CardSecurityCode> <CardExpirationDate>05/2018</CardExpirationDate> <AdditionalDataCollection xsi:nil="true" /> </PaymentDataRequest> </PaymentDataCollection> <RequestId> </RequestId> <Version>1.0</Version> </request> </AuthorizeTransaction> </soap:body> </soap:envelope> Método CaptureCreditCardTransaction <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <CaptureCreditCardTransaction xmlns=" <request> <MerchantId> </MerchantId> <TransactionDataCollection> <TransactionDataRequest> <BraspagTransactionId> </BraspagTransactionId> <Amount>0</Amount> </TransactionDataRequest> </TransactionDataCollection> <RequestId> </RequestId> <Version>1.0</Version> </request> </CaptureCreditCardTransaction> </soap:body> Telefone: (21) / (11) Página 34 de 38

35 </soap:envelope> Método VoidCreditCardTransaction <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <VoidCreditCardTransaction xmlns=" <request> <MerchantId> </MerchantId> <TransactionDataCollection> <TransactionDataRequest> <BraspagTransactionId> </BraspagTransactionId> <Amount>0</Amount> </TransactionDataRequest> </TransactionDataCollection> <RequestId> </RequestId> <Version>1.0</Version> </request> </VoidCreditCardTransaction > </soap:body> </soap:envelope> Método RefundCreditCardTransaction <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soap=" <soap:body> <RefundCreditCardTransaction xmlns=" <request> <MerchantId> </MerchantId> <TransactionDataCollection> <TransactionDataRequest> <BraspagTransactionId> </BraspagTransactionId> <Amount>0</Amount> </TransactionDataRequest> </TransactionDataCollection> <RequestId> </RequestId> <Version>1.0</Version> </request> </RefundCreditCardTransaction > </soap:body> </soap:envelope> Telefone: (21) / (11) Página 35 de 38

36 12. SOFTDESCRIPTOR ***SOMENTE PARA TRANSAÇÕES REALIZADAS NA CIELO*** Permite que o lojista envie um texto de até 13 caracteres que será impresso na fatura do portador, ao lado da identificação da loja. Os dados referentes ao SoftDescriptor serão inseridos na Tabela AdditionalDataRequest (Tabela 13.6). O campo Name deverá ser preenchido com a palavra SoftDescriptor. Já o campo Value deverá conter o texto de até 13 caracteres. Conforme indicado no exemplo abaixo: Parâmetro Descrição Tipo Obrigatório Name SoftDescriptor String Value SomenteCielo String (Até 13 caracteres) O número de caracteres da cadastrados na Cielo, somados ao número de caracteres enviados via SoftDescriptor (Campo Value acima) devem totalizar o número permitido por cada bandeira, conforme os exemplos abaixo: Visa: Máximo de 25 caracteres - Exemplo: RazaoSocial*SomenteCielo Master: Máximo de 22 caracteres - Exemplo: RazSocial*SomenteCielo Diners: Máximo de 20 caracteres - Exemplo: RSocial*SomenteCielo Elo: Máximo de 20 caracteres - Exemplo: RSocial*SomenteCielo Obs.: Será utilizado o carácter * como separador do nome da Razão Social e do enviado via SoftDescriptor. E esse carácter deverá ser contabilizado no total de cada bandeira. Obs2: Caso o número de caracteres exceda o total permitido por determinada bandeira, o valor será exibido truncado, excluindo os caracteres da esquerda para a direita, conforme exemplo abaixo: TruncadoCardVisa*SomenteCielo (possui 31 carateres) será exibido como TruncadoCardVisa*SomenteC (25 caracteres, tratando-se de Visa) 13. INSERINDO DADOS ADICIONAIS Para realizar inserção de dados adicionais de uma transação já existente, deve-se utilizar o método InsertTransactionAdditionalData. Este método recebe o objeto InsertTransactionAdditionalDataRequest com as seguinte propriedades. Tabela 15 Propriedades do Objeto InsertTransactionAdditionalDataRequest Parâmetro Descrição Tipo Obrigatório AdditionalData Collection Coleção de dados adicionais ArrayOfAddition aldatarequest (Tabela 13.8) Url de Homologação: Telefone: (21) / (11) Página 36 de 38