Pagador Transaction Autorização, Captura, Cancelamento e Estorno Versão 1.9.9.1 12/02/2014 Pagador Transaction Autorização, Captura, Cancelamento e Estorno SUMÁRIO HISTÓRICO DE ALTERAÇÕES........................................................................................................................................ 3 INTRODUÇÃO ............................................................................................................................................................. 5 1. AUTORIZAÇÃO ....................................................................................................................................................... 8 1.1. MÉTODO AUTHORIZETRANSACTION........................................................................................................................... 8 1.2. RETORNO DO MÉTODO AUTHORIZETRANSACTION ........................................................................................................ 8 2. CAPTURA................................................................................................................................................................ 9 2.1. MÉTODO CAPTURECREDITCARDTRANSACTION ............................................................................................................ 9 2.2. RETORNO DO MÉTODO CAPTURECREDITCARDTRANSACTION.......................................................................................... 9 3. CANCELAMENTO.................................................................................................................................................. 10 3.1. MÉTODO VOIDCREDITCARDTRANSACTION ................................................................................................................ 10 3.2. RETORNO DO MÉTODO VOIDCREDITCARDTRANSACTION ............................................................................................. 10 4. REFUND (ESTORNO) ............................................................................................................................................. 11 4.1. MÉTODO REFUNDCREDITCARDTRANSACTION............................................................................................................ 11 4.2. RETORNO DO MÉTODO REFUNDCREDITCARDTRANSACTION ......................................................................................... 12 5. MUDANÇA DE STATUS (2º POST) ......................................................................................................................... 13 6. ANINHAMENTO DE TRANSAÇÕES ........................................................................................................................ 14 7. RETENTATIVA ....................................................................................................................................................... 15 7.1. POST DE NOTIFICAÇÃO DA RETENTATIVA................................................................................................................... 17 8. JUSTCLICK (CARTÃO PROTEGIDO) ........................................................................................................................ 18 9. TABELAS DE DOMÍNIO ......................................................................................................................................... 19 10. MAPA DE ERROS .............................................................................................................................................. 29 11. SOAP DE EXEMPLO .......................................................................................................................................... 31 11.1. MÉTODO AUTHORIZETRANSACTION......................................................................................................................... 31 11.1.1. MÉTODO AUTHORIZETRANSACTIONNPAYMENTS ................................................................................................... 32 11.2. MÉTODO CAPTURECREDITCARDTRANSACTION .......................................................................................................... 33 11.3. MÉTODO VOIDCREDITCARDTRANSACTION ................................................................................................................ 33 11.4. MÉTODO REFUNDCREDITCARDTRANSACTION............................................................................................................ 34 12. SOFTDESCRIPTOR ............................................................................................................................................ 34 13. INSERINDO DADOS ADICIONAIS ...................................................................................................................... 35 14. ONEBUY ........................................................................................................................................................... 35 15. CARTÃO PRESENTE ALELO ............................................................................................................................... 36 16. CARTÕES DE TESTE .......................................................................................................................................... 36 Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 2 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno HISTÓRICO DE ALTERAÇÕES Pagador Transaction – Autorização, Captura, Cancelamento e Estorno Versão Data Descrição Autor Revisor 1.0 16/01/2012 Versão inicial Diogo Mello Bianca Barcelos 1.1 04/04/2012 1.2 15/05/2012 Inclusão: Retentativa;Incusão do exemplo de desenvolvimento;Bloqueio de duplicidade;IPs;SOAP de exemplo Authorize. Inclusão de novos meios de pagamento: 524 até 532 Bianca Barcelos Guilherme Cantisano Daniel Abreu Guilherme Cantisano 1.3 23/05/2012 Inclusão do Post de Notificação do serviço de Retentativa; fluxo retentativa Bianca Barcelos Felipe Cotecchia 1.4 05/06/2012 Alteração do Método AuthorizeCreditCardTransaction e CreateBoletoTransaction para AuthorizeTransaction Bianca Barcelos Marlon França 1.5 29/06/2012 Inclusão de novos meios de pagamento: 995 e 996 Daniel Abreu Bianca Barcellos Daniel Abreu Marlon França Daniel Abreu Daniel Braga Daniel Abreu Daniel Braga Daniel Abreu Rafael Barros Daniel Abreu Daniel Braga Daniel Abreu Rafael Barros Daniel Abreu Rafael Barros Daniel Abreu Rafael Barros Daniel Abreu Rafael Barros Daniel Abreu Rafael Barros Daniel Abreu Rafael Barros Ramilo Neves Daniel Abreu 1.6 07/08/2012 1.7 27/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 1.8 31/08/2012 Inclusão do Recurso SoftDescriptor 1.9 17/09/2012 1.9.1 16/01/2013 Inclusão dos Erros “BP” Inclusão do Método: InsertTransactionAdditionalDataRequest Inclusão dos Códigos 5 e 6 na Tabela Tipo de Transação 1.9.2 16/04/2013 Alteração do Recurso SoftDescriptor 1.9.3 15/05/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: 533 Alteração da obrigatoriedade do Parâmetro CustomerIdentity Inclusão do Parâmetro: ServiceTaxAmount nas tabelas 13.11, 13.14 e 13.15 Inserção dos Meios de Pagamento: 6, 7, 8, 9, 10, 13, 14, 124, 546 Alteração da obrigatoriedade do Parâmetro CardNumber 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 1.9.4 1.9.4.1 04/06/2013 17/07/2013 1.9.5 24/07/2013 1.9.5.1 10/09/2013 1.9.6 18/09/2013 Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 3 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 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 Ramilo Neves Daniel Abreu 1.9.7 12/11/2013 1.9.7.1 22/11/2013 Alteração da obrigatoriedade do campo ServiceTaxAmount Ramilo Neves Daniel Abreu 1.9.8 10/12/2013 Inclusão da observação sobre as URLs de Integração Ramilo Neves Daniel Abreu Inclusão do meio de pagamento na 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. Ramilo Neves Rafael Barros Alteração do nome do meio de pagamento Cielo Mastercard Maestro para Cielo Mastercard Débito Ramilo Neves Rafael Barros 1.9.9 12/02/2014 1.9.9.1 21/02/2014 Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 4 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 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: https://homologacao.pagador.com.br/webservice/pagadorTransaction.asmx 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 www.pagador.com.br 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)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 5 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno Para habilitar essa funcionalidade é necessário solicitar à Equipe de Implantação através da ferramenta de suporte (http://suporte.braspag.com.br). 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 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). Captura 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. Captura Automática 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 Via Braspag Utilizando, ou não, o delay 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 Via Webservice Cancelamento Refund (Estorno) ChargeBack 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. Quando a transação é contestada junto ao banco emissor pelo portador do cartão (É o não reconhecimento da compra). Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 6 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 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)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 7 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 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. 1.1. 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: {00000000-0000-00000000-000000000000} Guid Sim Versão do contrato do Webservice (ex.: “1.0”) string Sim OrderDataRequest (Tabela 13) Sim Version OrderData Dados do pedido PaymentData Collection Coleção de dados do pagamento CustomerData Consultar propriedades do CustomerDataRequest ArrayOfPaymentDataReq uest (Tabela 13.1) Sim CustomerDataRequest (Tabela 13.6) Sim 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 CorrelationId Success ErrorReportData Collection OrderData PaymentData Collection Descrição Tipo Identificador da requisição do Webservice Guid Se a requisição chegou até a operadora, Success = true, caso contrário Success = false bool Coleção de itens contendo erros da requisição Dados do pedido Coleção de dados do pagamento Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br ArrayOfErrorReportData Response (Tabela 13.9) OrderDataResponse (Tabela 13.10) ArrayOfPaymentDataResponse (Tabela 13.11) Página 8 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 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. 2.1. 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: {00000000-0000-0000-0000-000000000000} Guid Sim Versão do contrato do Webservice (ex.: “1.0”) string Sim É o campo identificador da loja no formato: {00000000-0000-0000-0000-000000000000} Guid Sim ArrayOfTransaction DataRequest (Tabela 13.16) Sim Version MerchantId TransactionData Collection Coleção de transações a serem capturadas 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 CorrelationId Success Descrição Tipo Identificador da requisição do Webservice Guid Se a requisição chegou até a operadora, Success = true, caso contrário Success = false bool ErrorReportData Collection Coleção de itens contendo erros da requisição TransactionData Collection Coleção de respostas para as transações enviadas Tabela 4.1 – Possíveis status de retorno do método ArrayOfErrorReportData Response (Tabela 13.9) ArrayOf TransactionDataResponse (Tabela 13.17) 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 Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 9 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 3. CANCELAMENTO 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 (http://suporte.braspag.com.br/). 3.1. 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: {00000000-0000-0000-0000-000000000000} Guid Sim Versão do contrato do Webservice (ex.: “1.0”) string Sim É o campo identificador da loja no formato: {00000000-0000-0000-0000-000000000000} Guid Sim ArrayOfTransaction DataRequest (Tabela 13.16) Sim Version MerchantId TransactionData Collection Coleção de transações a serem canceladas 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 CorrelationId Success ErrorReportData Collection Descrição Tipo Identificador da requisição do Webservice. Guid Se a requisição chegou até a operadora, Success = true, caso contrário Success = false. bool Coleção de itens contendo erros da requisição Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br ArrayOfErrorReportData Response (Tabela 13.9) Página 10 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno TransactionData Collection ArrayOf TransactionDataResponse (Tabela 13.17) Coleção de respostas para as transações enviadas. OBS: Caso o parâmetro amount não seja enviado ou contenha o valor 0, o cancelamento será no valor integral da transação Tabela 7 – Possíveis status de retorno do método VoidTransaction 4. 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 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. 4.1. 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: {00000000-0000-0000-0000-000000000000} Guid Sim Version Versão do contrato do Webservice (ex.: “1.0”) string Sim MerchantId É o campo identificador da loja no formato: {00000000-0000-0000-0000-000000000000} Guid Sim ArrayOfTransaction DataRequest (Tabela 13.16) Sim TransactionData Collection Coleção de transações a serem estornadas Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 11 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 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 CorrelationId Success Descrição Tipo Identificador da requisição do Webservice. Guid Se a requisição chegou até a operadora, Success = true, caso contrário Success = false. bool ErrorReportData Collection Coleção de itens contendo erros da requisição TransactionData Collection Coleção de enviadas. respostas para as ArrayOfErrorReportData Response (Tabela 13.9) transações 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)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 12 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 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 URL MUDANÇA DE STATUS 2º POST Database 2°POST NÃO SIM Status alterado p/ Capturado? Tabela 11 - Parâmetros enviados pelo 2º Post Parâmetro NumPedido Status CODPAGAMENTO Descrição Tipo Obrigatório Número do pedido do cliente String Sim Status do Pagamento = “0” (Pago) string Sim Código do Meio de Pagamento (Tabela 13.19) Int16 Sim É 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 9, 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 e-mail 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)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 13 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 6. 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). 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 REALIZA ANINHAMENTO DB DB BOI DATABASE NÃO CRIA E ARMAZENA BOI COMPRA AUTORIZADA? SIM NÃO ENVIA RESPONSE C/ BOI 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 ; 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)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 14 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 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 REQUISIÇÃO REQUISIÇÃO LOJA BP NÃO AUTORIZADA NÃO AUTORIZADA PROCESSA TRANSAÇÃO BANCO DE RETENTATIVAS PERSISTE RETENTATIVAS NO BANCO CONSULTA E ATUALIZA RETENTATIVAS RETENTATIVA 1 RESPOSTA 1 - “Não Autorizado” 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 RETENTATIVA 2 BP RETENTATIVA RESPOSTA 2 – “Não Autorizado” PROCESSA TRANSAÇÃO RETENTATIVA 3 RESPOSTA 3 – “Autorizado” 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 (http://suporte.braspag.com.br). 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)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 15 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno Códigos de retorno que está habilitado na Braspag (LR) Código de Resposta (LR) Descrição Permite Retentativa 06 Tente Novamente Sim 51 Saldo Insuficiente Sim 76 Tente Novamente Sim 78 Cartão não foi desbloqueado Sim 91 Banco Indisponível Sim 96 Tente Novamente Sim AA Tente Novamente Sim 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)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 16 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 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) Permite Retentativa Descrição 05 Erro de edição Sim 14 Database erro Sim 51 Estabelecimento inválido Sim 53 Transação não permitida pelo emissor Sim 54 Não autorizada Sim 56 Cartão usado recentemente Sim 57 Não Autorizada Sim 58 Não autorizada Sim 74 Falha de Comunicação Sim Connection with the aquire failed Sim 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 OrderId PaymentMethod LastRetry TotalRetries RetryStatus BraspagOrderId BraspagTransactionId Descrição Tipo Número do pedido do cliente String Código do meio de pagamento (Tabela 13.20) Int16 Número da última retentativa realizada Int16 Número de retentativa configuradas Int16 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 * Id da transação na Braspag Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Int16 Guid Guid Página 17 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 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 (http://suporte.braspag.com.br). 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 1Click 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)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 18 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 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: {00000000-0000-0000-0000-000000000000} Guid Sim Numero do pedido no cliente string Sim 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 Sim OrderId BraspagOrderId Tabela 13.1 – Propriedades do objeto PaymentDataRequest Parâmetro PaymentMethod Amount Descrição Tipo Obrigatório Código do meio de pagamento (Tabela 13.18) short Sim Quantia a ser operada long Sim string Sim Países (Tabela 13.21) Sim Currency Moeda (ex.: “BRL”, “USD”, etc) Country País (ex.: “BRA”) ArrayOfAdditionalDataR equest Não (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). AdditionalData Collection Coleção de dados adicionais Tabela 13.2 – Propriedades do objeto CreditCardDataRequest Parâmetro Descrição Tipo Obrigatório 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 long Não Número de pagamentos short Sim Código do plano de pagamento** byte Sim Tipo da Transação*** byte Sim string Sim string Sim (Caso seja enviado CreditCardToke n ou JustClickAlias, este parâmetro não será obrigatório) NumberOf Payments PaymentPlan TransactionType CardHolder CardNumber Nome que consta no cartão de crédito Numero do cartão de crédito Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 19 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno CardSecurityCode CardExpiration Date CreditCardToken JustClickAlias SaveCreditCard Sim (Mas a loja pode ter habilitar aceitar CVV Nulo) Sim (Não é obrigatório para Cartão Presente/Alelo) Código de segurança do cartão (Utilizar 6 dígitos para Givex) string Data de expiração do cartão string Identificador do cartão de crédito a ser usado na transação via JustClick Guid Não Alias (Apelido) do cartão de crédito string Não boolean Não 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 **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 4 5 Pré-Autorização Recorrente 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)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 20 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno Tabela 13.3 – Propriedades do objeto DebitCardDataRequest Parâmetro Card Holder Card Number Card Security Code Descrição Tipo Obrigatório Nome que consta no cartão de crédito string Sim Numero do cartão de crédito string Sim Código de segurança do cartão string Sim string Sim Card Expiration Data de expiração do cartão Date * 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 TokenOneBuy NumberOf Payments PaymentPlan Descrição Tipo Obrigatório string Sim Número de pagamentos short Sim Código do plano de pagamento** byte Sim Token fornecido pelo aplicativo instalado dispositivo mobile (XXXX-XXXX-XXXX-XXXX) em 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 Sim CustomerEmail E-mail do cliente string Não CustomerAddress Data Endereço de cobrança do cartão AddressDataRequest (Tabela 13.7) Não Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 21 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno DeliveryAddress Data AddressDataRequest (Tabela 13.7) Endereço de entrega Não Tabela 13.7 – Propriedades do objeto AddressDataRequest Parâmetro Tipo Obrigatório Rua string Não Número string Não Complemento string Não District Bairro string Não ZipCode CEP string Não City Cidade string Não State Estado string Não Paises (Tabela 13.21) Não Street Number Complement Country Descrição País 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 ErrorCode ErrorMessage Descrição Tipo Código do erro na Braspag string Mensagem descrevendo o motivo do erro string Tabela 13.10 – 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)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 22 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno Tabela 13.11 – Propriedades do objeto PaymentDataResponse Parâmetro Descrição BraspagTransactionId Amount PaymentMethod Tipo Id da transação na Braspag Guid Valor operado pela operadora para a operação requerida (ex.: R$1,00 = 100) long Código do meio de pagamento (Tabela 13.20) short Tabela 13.12 – Propriedades do objeto CreditCardDataResponse Parâmetro Descrição AcquirerTransactionId Tipo Id da transação na adquirente string Código de autorização string Código de retorno da adquirente string ReturnMessage Mensagem de retorno da adquirente string ProofOfSale Número do Comprovante de Venda string AuthorizationCode ReturnCode Status de retorno AtributoStatusdoobjetoCreditCard (Tabela 13.12.1) Status byte CreditCardToken Identificador do cartão de crédito a ser usado na transação via JustClick Guid SerivceTaxAmount Montante do valor da transação a ser destinado como taxa de serviço utilizado pela operadora. String AuthenticationUrl URL para qual o Lojista deve redirecionar o Cliente para o fluxo de autenticação. string Tabela 13.12.1 - 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 3 Transação com erro Desqualificante. Aguardando Resposta 4 Transação aguardando resposta. Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 23 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno Tabela 13.13 – Propriedades do objeto DebitCardDataResponse Parâmetro Descrição AcquirerTransactionId ReturnCode ReturnMessage Id da transação na adquirente string Código de retorno da adquirente string Mensagem de retorno da adquirente string Status de retorno AtributoStatusdoobjetoCreditCard (Tabela 13.12.1) Status AuthenticationUrl Tipo URL para qual o Lojista deve redirecionar o Cliente para o fluxo de autenticação. byte string Tabela 13.14 – Propriedades do objeto BoletoDataResponse Parâmetro BoletoNumber Descrição Tipo "NossoNumero" gerado String Data de vencimento String URL do boleto gerada String 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 BoletoExpiration Date BoletoUrl BarCodeNumber Tabela 13.15 – Propriedades do objeto OneBuyDataResponse Parâmetro AuthorizationCode ReturnCode ReturnMessage Status Descrição Tipo Código de autorização string Código de retorno da adquirente string Mensagem de retorno da adquirente string Status de retorno AtributoStatusdoobjetoOneBuy (Tabela 13.15.1) Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br byte Página 24 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno Tabela 13.15.1 - 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 3 Transação com erro Desqualificante. Aguardando Resposta 4 Transação aguardando resposta. Tabela 13.16 – Propriedades do objeto TransactionDataRequest Parâmetro BraspagTransactionId Amount ServiceTaxAmount Descrição Tipo Obrigatório Numero da transação na Braspag Guid Sim Valor a ser operado (ex.: R$1,00 = 100) long Sim string Não 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 Tabela 13.17 – 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 AuthorizationCode Valor operado pela operadora, total ou parcial da transação em centavos (ex.: R$1,00 = 100) long Código de autorização string ProofOfSale Número do Comprovante de Venda string ReturnCode Código de retorno da adquirente string Mensagem de retorno da adquirente string Status de retorno (Captura) statusderetornodométodoCaptureCreditCardTransaction (tabela 4.1) short Montante do valor da transação a ser destinado como taxa de serviço utilizado pela operadora. string ReturnMessage Status ServiceTaxAmount Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 25 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno Tabela 13.18 – 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 Número da transação na Operadora string AcquirerTransactionI d PaymentMethod Código do meio de pagamento int PaymentMethodName Nome do meio de pagamento string ErrorCode Código de erro da transação. Caso vazio não houve erro na transação string ErrorMessage Mensagem de erro da transação. Caso vazio não houve erro na transação string Amount Valor operado pela operadora, total ou parcial da transação em centavos (ex.: R$1,00 = 100) long AuthorizationCode NumberOfPayments Código de autorização string 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 Data de captura da transação. Caso vazio a transação não foi capturada string VoidedDate Data de cancelamento da transação. Caso vazio a transação não foi cancelada string CreditCardToken Identificador do cartão de crédito a ser usado na transação via JustClick string Tabela 13.19 – 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)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 26 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno Tabela 13.20 – 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)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 27 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 518 Payvision DINERS 519 Payvision AMEX 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 550 CredSystem 551 Boleto Caixa – SIGCB Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 28 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 552 Cielo Mastercard Débito Tabela 13.21 – 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 101 VersionIsMandatoryParameter 102 OrderDataIsMandatoryItem 103 MerchantIdIsMandatoryParameter MerchantId is a mandatory parameter 104 BraspagTransactionIdIsMandatoryParameter BraspagTransactionId is a mandatory parameter 105 OrderIdIsMandatoryParameter 106 BraspagOrderIdIsInvalidOrDoNotExists Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br RequestId is a mandatory parameter Version is a mandatory parameter OrderData is a mandatory item OrderId is a mandatory parameter BraspagOrderId é inválido ou não existe Página 29 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno PaymentDataCollection is a mandatory item 107 PaymentDataCollectionIsMandatoryItem 108 PaymentDataIsMandatoryItem 109 PaymentMethodIsInvalid 110 AmountMustBeGreaterThanZero 111 CardNumberIsMandatoryParameter 112 CardExpirationDateIsMandatoryParameter 113 CardExpirationDateIsInvalid CardExpiration is invalid 114 NumberOfPaymentsIsInvalid NumberOfPayments is invalid 115 PaymentPlanIsInvalid 116 CurrencyIsMandatoryParameter Currency is a mandatory parameter 117 CountryIsMandatoryParameter Country is a mandatory parameter 118 TransactionTypeIsInvalid 119 CustomerDataIsMandatoryItem CustomerData is mandatory item 120 CustomerIdentityIsMandatoryParameter CustomerIdentity is a mandatory parameter 121 CustomerNameIsMandatoryParameter 122 InvalidMerchantId 123 CreditCardTokenIsInvalidOrDoNotExists 124 TransactionIdAlreadyExists 125 InvalidIpAddress 126 PaymentMethodIsNotEnabled 127 CurrencyIsNotSupported 128 TransactionTypeIsNotSupported Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br PaymentData is a mandatory item PaymentMethod is invalid Amount must be greater than or equal to zero CardNumber is a mandatory parameter CardExpirationDate is a mandatory parameter PaymentPlan is invalid TransactionType is invalid CustomerName is a mandatory parameter Invalid MerchantId CreditCardToken is invalid or does not exist TransactionId already exists Invalid IP address PaymentMethod is not enabled Currency submited is not supported for this payment method Transaction type submited is not supported for this payment method Página 30 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 129 CountryIsNotSupported 130 TransactionDataCollectionIsMandatoryItem TransactionDataCollection is a mandatory item 131 BraspagOrderIdIsMandatoryParameter BraspagOrderId is a mandatory parameter 132 TransactionNotAvailableForCapture 133 BoletoExpirationDateisInvalid 134 Invalid Email Address 135 OrderId was already registered 199 UndefinedError BP900 Falha na Operação BP901 Falha na Autorização BP902 Falha na Captura BP903 Falha no Cancelamento BP904 Falha na Consulta Country is not supported Transaction not available for capture BoletoExpirationDate is invalid Invalid Email Address OrderId was already registered Undefined error Falha na Operação Falha na Autorização Falha na Captura Falha no Cancelamento Falha na Consulta 11. SOAP DE EXEMPLO 11.1. Método AuthorizeTransaction <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <AuthorizeTransaction xmlns="https://www.pagador.com.br/webservice/pagador"> <request> <OrderData> <MerchantId>00000000-0000-0000-0000-000000000000</MerchantId> <OrderId>0000</OrderId> <BraspagOrderId xsi:nil="true" /> </OrderData> <CustomerData> <CustomerIdentity>99999999999</CustomerIdentity> <CustomerIdentityType>CPF</CustomerIdentityType> <CustomerName>Comprador Teste</CustomerName> <CustomerEmail>[email protected]</CustomerEmail> <CustomerAddressData xsi:nil="true" /> <DeliveryAddressData xsi:nil="true" /> </CustomerData> <PaymentDataCollection> Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 31 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno <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>0000000000000001</CardNumber> <CardSecurityCode>123</CardSecurityCode> <CardExpirationDate>05/2018</CardExpirationDate> <AdditionalDataCollection xsi:nil="true" /> </PaymentDataRequest> </PaymentDataCollection> <RequestId>00000000-0000-0000-0000-000000000000</RequestId> <Version>1.0</Version> </request> </AuthorizeTransaction> </soap:Body> 11.1.1. 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="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <AuthorizeTransaction xmlns="https://www.pagador.com.br/webservice/pagador"> <request> <OrderData> <MerchantId>00000000-0000-0000-0000-000000000000</MerchantId> <OrderId>0000</OrderId> <BraspagOrderId xsi:nil="true" /> </OrderData> <CustomerData> <CustomerIdentity>99999999999</CustomerIdentity> <CustomerIdentityType>CPF</CustomerIdentityType> <CustomerName>Comprador Teste</CustomerName> <CustomerEmail>[email protected]</CustomerEmail> <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>0000000000000001</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> Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 32 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno <NumberOfPayments>1</NumberOfPayments> <PaymentPlan>0</PaymentPlan> <TransactionType>2</TransactionType> <CardHolder>Comprador Teste</CardHolder> <CardNumber>0000000000000001</CardNumber> <CardSecurityCode>123</CardSecurityCode> <CardExpirationDate>05/2018</CardExpirationDate> <AdditionalDataCollection xsi:nil="true" /> </PaymentDataRequest> </PaymentDataCollection> <RequestId>00000000-0000-0000-0000-000000000000</RequestId> <Version>1.0</Version> </request> </AuthorizeTransaction> </soap:Body> </soap:Envelope> 11.2. Método CaptureCreditCardTransaction <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <CaptureCreditCardTransaction xmlns="https://www.pagador.com.br/webservice/pagador"> <request> <MerchantId>00000000-0000-0000-0000-000000000000</MerchantId> <TransactionDataCollection> <TransactionDataRequest> <BraspagTransactionId>00000000-0000-0000-0000-000000000000</BraspagTransactionId> <Amount>0</Amount> </TransactionDataRequest> </TransactionDataCollection> <RequestId>00000000-0000-0000-0000-000000000000</RequestId> <Version>1.0</Version> </request> </CaptureCreditCardTransaction> </soap:Body> </soap:Envelope> 11.3. Método VoidCreditCardTransaction <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <VoidCreditCardTransaction xmlns="https://www.pagador.com.br/webservice/pagador"> <request> <MerchantId>00000000-0000-0000-0000-000000000000</MerchantId> <TransactionDataCollection> <TransactionDataRequest> <BraspagTransactionId>00000000-0000-0000-0000-000000000000</BraspagTransactionId> <Amount>0</Amount> </TransactionDataRequest> </TransactionDataCollection> <RequestId>00000000-0000-0000-0000-000000000000</RequestId> <Version>1.0</Version> </request> </VoidCreditCardTransaction > </soap:Body> </soap:Envelope> Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 33 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 11.4. Método RefundCreditCardTransaction <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <RefundCreditCardTransaction xmlns="https://www.pagador.com.br/webservice/pagador"> <request> <MerchantId>00000000-0000-0000-0000-000000000000</MerchantId> <TransactionDataCollection> <TransactionDataRequest> <BraspagTransactionId>00000000-0000-0000-0000-000000000000</BraspagTransactionId> <Amount>0</Amount> </TransactionDataRequest> </TransactionDataCollection> <RequestId>00000000-0000-0000-0000-000000000000</RequestId> <Version>1.0</Version> </request> </RefundCreditCardTransaction > </soap:Body> </soap:Envelope> 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 Sim Value SomenteCielo String (Até 13 caracteres) Sim 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) Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 34 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 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 AdditionalData Collection Descrição Coleção de dados adicionais Url de Homologação: Tipo Obrigatório ArrayOfAddition alDataRequest (Tabela 13.8) Sim https://homologacao.pagador.com.br/webservice/pagadorservices.asmx A integração deve ser feita sempre usando URL e em hipótese alguma por IP ou usando nomes como www.pagador.com.br ou apenas pagador.com.br. Para receber a URL de Produção, solicite à nossa equipe de implantação através da ferramenta Suporte. 14. ONEBUY O OneBuy permitirá a compra online por meio de um token gerado à partir de um dispositivo móvel. O token somente terá validade para uma única transação e irá conter a identificação do comprador, não sendo mais necessário utilizar o número do cartão de crédito para efetuar a compra. ONEBUY BRASPAG - PAGADOR ONEBUY Envia Requisição de Transação Processa Transação do Cliente Recebe a Transação e Processa Autenticação solicitando a senha gerada pelo token do comprador Recebe Resposta da Requisição Processa Resposta e encaminha ao Cliente Processa Transação e encaminha resposta ao Pagador Phase CLIENTE Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 35 de 36 Pagador Transaction Autorização, Captura, Cancelamento e Estorno 15. CARTÃO PRESENTE ALELO O Cartão presente é um cartão pré-pago, em reais, não recarregável para ser utilizado apenas em compras nos estabelecimentos ou lojas virtuais das empresas emissoras do cartão e sem custo adicional para o comprador, tendo o valor apresentado na face do cartão. O cartão será adquirido nos varejistas distribuidores, nas lojas próprias ou via web. A integração para utilizar o Cartão Presente Alelo deve ser feita da mesma forma que é feita para Cartões de Crédito, utilizando o PaymentDataRequest Type="CreditCardDataRequest". Verifique na descrição de cada campo da TABELA 1 as possíveis peculiaridades para este meio de pagamento. Formato dos cartões Alelo: 19 dígitos. Bin = 6 dígitos. 16. CARTÕES DE TESTE Para melhor utilização do Meio de Pagamento Simulado, estamos disponibilizando cartões de testes. Os status das transações serão conforme a utilização de cada cartão. Possuímos cartões onde todas as transações serão Autorizadas, Negadas e resposta aleatória. Tabela 16 – Cartões para Testes Status das Transações Cartões para realização dos testes Código de Retorno Mensagem de Retorno Autorizado 0000.0000.0000.0001* 0000.0000.0000.0004* 0000.0000.0000.0006* 4 Operação realizada com Sucesso Não Autorizado 0000.0000.0000.0002* 2 Não Autorizada Autorização aleatória 0000.0000.0000.0009* 4 / 99 Operation Successful / Timed Out Não Autorizado 0000.0000.0000.0007* 77 Cartão Cancelado Não Autorizado 0000.0000.0000.0008* 70 Problemas com o Cartão de Crédito Não Autorizado 0000.0000.0000.0005* 78 Cartão Bloqueado Não Autorizado 0000.0000.0000.0003* 57 Cartão Expirado *As informações de Cód.Segurança (CVV) e validade podem ser aleatórias, mantendo o formato estabelecido. Tabela 17 – Meios de Pagamento para Cartões de Teste Códigos Meios de Pagamento 997 SIMULADO 998 SIMULADO USD 999 SIMULADO EUR Telefone: (21)2111-4700 / (11) 3320-9050 http://suporte.braspag.com.br Página 36 de 36