pagador transaction autorização, captura, cancelamento e ... · inclusão do meio de pagamento...

Pagador Transaction

Autorização, Captura, Cancelamento e Estorno

Versão 1.15.5

24/01/2017

Pagador Transaction


Telefone: (21) 2111-4700 / (11) 2184-0550 Página 2 de 45

http://suporte.braspag.com.br

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 ............................................................................................. 11

4. REFUND (ESTORNO) ............................................................................................................................................. 12

4.1. MÉTODO REFUNDCREDITCARDTRANSACTION ............................................................................................................ 12

4.2. RETORNO DO MÉTODO REFUNDCREDITCARDTRANSACTION ......................................................................................... 12

5. MUDANÇA DE STATUS (2º POST) ......................................................................................................................... 14

6. ANINHAMENTO DE TRANSAÇÕES ........................................................................................................................ 15

7. RETENTATIVA ....................................................................................................................................................... 16

7.1. RETENTATIVA ONLINE ........................................................................................................................................... 16

7.2. RETENTATIVA OFFLINE .......................................................................................................................................... 16

1. TESTES ................................................................................................................................................................... 17

8. JUSTCLICK (CARTÃO PROTEGIDO) ........................................................................................................................ 18

9. TABELAS DE DOMÍNIO ......................................................................................................................................... 18

10. MAPA DE ERROS .............................................................................................................................................. 31

11. SOAP DE EXEMPLO .......................................................................................................................................... 34

11.1. MÉTODO AUTHORIZETRANSACTION ......................................................................................................................... 34

11.1.1. MÉTODO AUTHORIZETRANSACTIONNPAYMENTS ................................................................................................... 34

11.1.2. MÉTODO AUTHORIZETRANSACTION - PREPAIDCARD............................................................................................... 35

11.2. MÉTODO CAPTURECREDITCARDTRANSACTION .......................................................................................................... 36

11.3. MÉTODO VOIDCREDITCARDTRANSACTION ................................................................................................................ 36

11.4. MÉTODO REFUNDCREDITCARDTRANSACTION ............................................................................................................ 37

12. SOFTDESCRIPTOR ............................................................................................................................................ 38

13. ONEBUY ........................................................................................................................................................... 39

14. BANORTE - CARGOS AUTOMATICOS ............................................................................................................... 40

15. AUTENTICAÇÃO EXTERNA (CIELO) ................................................................................................................... 41

16. CARTÕES DE TESTE .......................................................................................................................................... 44

17. BOLETOS REGISTRADOS .................................................................................................................................. 45

http://suporte.braspag.com.br/

Pagador Transaction




HISTÓRICO DE ALTERAÇÕES

Pagador Transaction – Autorização, Captura, Cancelamento e Estorno

Versão Data Descrição

1.0 16/01/2012 Versão inicial

1.1 04/04/2012 Inclusão: Retentativa;Incusão do exemplo de desenvolvimento;Bloqueio de

duplicidade;IPs;SOAP de exemplo Authorize.

1.2 15/05/2012 Inclusão de novos meios de pagamento: 524 até 532

1.3 23/05/2012 Inclusão do Post de Notificação do serviço de Retentativa; fluxo retentativa

1.4 05/06/2012 Alteração do Método AuthorizeCreditCardTransaction e CreateBoletoTransaction para

AuthorizeTransaction

1.5 29/06/2012 Inclusão de novos meios de pagamento: 995 e 996

1.6 07/08/2012

Alteração da Soap de Exemplo: Método AuthorizeTransaction; Inserção das Soaps de Exemplo: AuthorizeTransactionNPayments,

CaptureCreditCardTransaction, VoidCreditCardTransaction

1.7 27/08/2012 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 Inclusão dos Erros “BP” Inclusão do Método:

InsertTransactionAdditionalDataRequest

1.9.1 16/01/2013 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

1.9.4 04/06/2013

Inserção do item OneBuy; Inserção dos objetos: OneBuyDataRequest e OneBuyDataResponse; Inserção do Parâmetro ProofOfSale 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

1.9.4.1 17/07/2013 Alteração da obrigatoriedade do Parâmetro CustomerIdentity

1.9.5 24/07/2013 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

1.9.5.1 10/09/2013 Alteração da obrigatoriedade do Parâmetro CardNumber

1.9.6 18/09/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

1.9.7 12/11/2013

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


Pagador Transaction




1.9.7.1 22/11/2013 Alteração da obrigatoriedade do campo ServiceTaxAmount

1.9.8 10/12/2013 Inclusão da observação sobre as URLs de Integração

1.9.9 12/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.

1.10 21/02/2014 Alteração do nome do meio de pagamento Cielo Mastercard Maestro para Cielo

Mastercard Débito

1.11 02/07/2014 Inclusão do código de erro BP07 – Timeout para requisição da Redecard

1.12 30/07/2014 Inclusão de novo meio de pagamento: 565

1.13 15/05/2015 Inclusão dos meios de pagamento 567; 568 e 569 Informações sobre a Retentativa Online

1.14

05/08/2015

Atualização da tabela 14 – Mapa de Erros Atualização da tabela 16 – Cartões para Testes

1.14.1

05/08/2015

Inclusão do novo meio de pagamento: 570(EPay); Inclusão do objeto PrepaidCardDataRequest e PrepaidCardDataResponse; Inclusão do Soap de Exemplo: Método AuthorizeTransaction –

PrePaidCardDataRequest;

1.14.2 29/09/2015 Inclusão dos meios de pagamento 572, 573, 574 e 575; Inclusão do Item Banorte – Cargos Automáticos;

1.15 06/10/2015 Funcionalidade: Retentativa MPI externo

1.15.1 06/01/2016 Inclusão do campo Password no objeto PrePaidCardDataRequest

1.15.2 26/02/2016 Inclusão dos novos meios de pagamento E-Rede 578 e 579

1.15.3 07/04/2016 Inclusão do ProofOfSale na resposta do DebitCardDataResponse

1.15.4 21/09/2016 Remoção da referência sobre InsertTransactionAdditionalData. Este serviço foi

descontinuado

1.15.5 24/01/2017 Inclusão das informações sobre Boleto Registrado


Pagador Transaction




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.

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.

Para habilitar essa funcionalidade é necessário solicitar à Equipe de Implantação através da ferramenta de suporte

(http://suporte.braspag.com.br).

Url de Homologação: https://homologacao.pagador.com.br/webservice/pagadorTransaction.asmx



https://homologacao.pagador.com.br/webservice/pagadorTransaction.asmx?WSDL

https://homologacao.pagador.com.br/webservice/pagadorTransaction.asmx

Pagador Transaction




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 A responsabilidade da captura é do cliente. Caracteriza o delay de captura cadastrado via Admin, onde o mesmo realiza a captura no momento mais oportuno.

Cancelamento 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.

Refund (Estorno) 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).


https://transaction.pagador.com.br/webservices/pagador/Pagador.asmx?op=AuthorizeAvs

https://transaction.pagador.com.br/webservices/pagador/Pagador.asmx?op=AuthorizeWithServiceTax

Pagador Transaction




Cliente Pagador Adquirente

AuthorizeTransactionRequest

Request Adquirente

AuthorizeTransactionResponse

Response Adquirente

Save Request

Save Response

AuthorizeTransactionRequest

AuthorizeTransactionResponse

Save Boleto

Fluxo Transacional

CaptureCreditCardTransactionRequest

Request Adquirente

CaptureCreditCardTransactionResponse

Response Adquirente

Save Request

Save Response

Resposta Cliente

Parâmetros 2º Post

RefundCreditCardTransactionRequest

Request Adquirente

Response Adquirente

Save Request

Save Response

RefundCreditCardTransactionResponse

VoidCreditCardTransactionRequest

Request Adquirente

Response Adquirente

Save Request

Save Response

VoidCreditCardTransactionResponse


Pagador Transaction




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 Tamanho Obrigatório

RequestId É o campo identificador desta requisição de autorização no formato: {00000000-0000-0000-0000-000000000000}

Guid

Sim

Version Versão do contrato do Webservice (ex.: “1.0”)

string 3 Sim

OrderData Dados do pedido OrderDataRequest

(Tabela 13)

Sim

PaymentData Collection

Coleção de dados do pagamento ArrayOfPaymentDataReq

uest (Tabela 13.1)

Sim

CustomerData Consultar propriedades do CustomerDataRequest

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 Descrição Tipo

CorrelationId Identificador da requisição do Webservice Guid

Success Se a requisição chegou até a operadora, Success = true, caso contrário Success = false

bool

ErrorReportDataCollection

Coleção de itens contendo erros da requisição ArrayOfErrorReportData Response (Tabela 13.9)

OrderData Dados do pedido OrderDataResponse

(Tabela 13.10)

PaymentData Collection

Coleção de dados do pagamento ArrayOfPaymentDataResponse

(Tabela 13.11)


Pagador Transaction




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


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 3 Sim

MerchantId É o campo identificador da loja no formato: {00000000-0000-0000-0000-

000000000000}

Guid

Sim

TransactionData Collection

Coleção de transações a serem capturadas ArrayOfTransactio

nDataRequest (Tabela 13.16)

Sim

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


CorrelationId Identificador da requisição do Webservice Guid

Success 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 ArrayOfErrorReportData

Response (Tabela 13.9)


Coleção de respostas para as transações enviadas ArrayOf

TransactionDataResponse

(Tabela 13.17)


Pagador Transaction




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

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.

3.1. Método VoidCreditCardTransaction

Este método recebe um objeto VoidCreditCardTransactionRequest com as seguintes propriedades:

Tabela 5 – Propriedades do objeto VoidCreditCardTransactionRequest


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 3 Sim

MerchantId É o campo identificador da loja no formato:

{00000000-0000-0000-0000-000000000000} Guid Sim

TransactionData

Collection Coleção de transações a serem canceladas

ArrayOfTransactio

nDataRequest

(Tabela 13.16)

Sim

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/).



Pagador Transaction




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


CorrelationId Identificador da requisição do Webservice. Guid

Success Se a requisição chegou até a operadora, Success = true, caso contrário Success = false.

bool




Coleção de respostas para as transações enviadas. ArrayOf

TransactionDataResponse (Tabela 13.17)

Tabela 7 – Possíveis status de retorno do método VoidTransaction


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

OBS: Caso o parâmetro amount não seja enviado ou contenha o valor 0, o cancelamento será no valor integral da

transação


Pagador Transaction




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.

4.1. Método RefundCreditCardTransaction

Este método recebe um objeto RefundCreditCardTransactionRequest com as seguintes propriedades:

Tabela 8 – Propriedades do objeto RefundCreditCardTransactionRequest


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 3 Sim

MerchantId

É o campo identificador da loja no formato:

{00000000-0000-0000-0000-

000000000000}

Guid Sim

TransactionData

Collection Coleção de transações a serem estornadas

ArrayOfTransaction

DataRequest (Tabela 13.16)

Sim

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


CorrelationId Identificador da requisição do Webservice. Guid

Success Se a requisição chegou até a operadora, Success = true, caso contrário Success = false.

bool




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


Pagador Transaction




Tabela 10 – Possíveis status de retorno do método RefundCreditCardTransaction


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.


Pagador Transaction




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.

Tabela 11 - Parâmetros enviados pelo 2º Post


NumPedido Número do pedido do cliente String 36 Sim

Status Status do Pagamento = “0” (Pago) string 3 Sim

CODPAGAMENTO 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 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 e-mail ao responsável pela loja, informando que o pedido em questão foi

pago.

Cliente BrasPag

URL MUDANÇA DE STATUS

2º POST

2°POST

Database

Status alterado p/ Capturado?

NÃO

RETORNO STATUS DE PAGAMENTO

OK?

FIM INÍCIO

SIM

SIM

ENVIA (POR 3 VEZES) PARA O FINAL DA FILA

NÃO


Pagador Transaction




Ou seja, o código fonte da página indicando Sucesso deverá conter APENAS <status>OK</status> e

nada mais.

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: 16135

CODPAGAMENTO: 501

RAW BODY

NumPedido=16135&Status=0&CODPAGAMENTO=501

6. 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);

ENVIA TRANSAÇÃO

TEM BOI?CONSULTA

BOISIM

BOI VÁLIDO?

NÃO

COMPRA AUTORIZADA?

SIM

NÃO

NÃO

CLIENTE

REALIZA ANINHAMENTO

SIM

DB

ENVIA RESPONSE

C/ BOI

DB

DB

BO

I D

ATA

BA

SE

CRIA EARMAZENA

BOI

ENVIA RESPOSTA DE BOI INVÁLIDO


Pagador Transaction




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.

7. RETENTATIVA

7.1. Retentativa Online

A Retentativa Online acontece na mesma chamada da transação original. A transação recusada é retentada

automaticamente na adquirente de sua escolha, e a resposta é enviada na sua mesma requisição (request).

É preciso tratar o meio de pagamento que será retornado no response, pois esse pode ser divergente do enviado no

request devido a retentativa em outra adquirente.

Informações a serem cadastradas:

Adquirente (qual a adquirente será feira a Retentativa)

o Disponível: Cielo; Rede e/ou GetNet

A informação do Status da transação ocorre na resposta do webserice (response), online.

7.2. Retentativa OffLine

A retentativa Offline acontece num período pré-determinado, após a negativa na transação. São retentados códigos de

erros já definidos. As tentativas ocorrem no intervalo determinado, e o lojista é informado do Sucesso ou Insucesso da

transação no final das tentativas ou quando uma tentativa for AUTORIZADA.

O ciclo se encerra com o sucesso de uma transação ou ao fim das tentativas.

Informações a serem cadastradas:

Adquirente (qual a adquirente será feira a Retentativa)

o Disponivel: Cielo; Rede e/ou GetNet

Quantidade de tentativas (quantas vezes será retentada a transação)

o Máximo = 3 Tentativas

Intervalo das Retentativas (o tempo entre uma retentativa e outra)

o Minimo = 1h


Pagador Transaction




o Máximo = 48h

URL de Notificação (URL onde será enviado a informação de Sucesso ou Insucesso da Retentativa)

é enviando nos seguintes cenários:

o Tentativa com Sucesso

o Número de tentativas esgotadas

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 solicitado à equipe de Operações.

As afiliações utilizadas na Retentativa devem está habilitada junto a Adquirente para

transacionar sem CVV;

A URL de Notificação nessa solução é obrigatória;

1. Testes

Os testes dessa funcionalidade devem ser realizados com o meio de pagamento Simulado, como a primeira tentativa,

e as demais adquirentes como a segunda opção.

O Cartão de teste deve ter o final – 8.

O código de retorno será – 30, e será retentando na próxima adquirente (que pode ser qualquer uma das

informadas acima).

As configurações devem ser cadastradas previamente com a nossa equipe de Operações.

Os códigos de erros aptos a serem retetados devem ser solicitados via chamado a nossa equipe de

Operações.


Pagador Transaction




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.

9. TABELAS DE DOMÍNIO

Tabela 13 – Propriedades do objeto OrderDataRequest


MerchantId É o campo identificador da loja no formato: {00000000-0000-0000-0000-000000000000}

Guid Sim

OrderId Numero do pedido no cliente string 36 Sim

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 Sim


Pagador Transaction




Tabela 13.1 – Propriedades do objeto PaymentDataRequest


PaymentMethod Código do meio de pagamento (Tabela 13.20)

short

Sim

Amount Quantia a ser operada long

Sim

Currency Moeda (ex.: “BRL”, “USD”, etc) string 3 Sim

Country País (ex.: “BRA”) Países

(Tabela 13.21) Sim

AdditionalData Collection

Coleção de dados adicionais ArrayOfAdditionalDataR

equest (Tabela 13.8)

Não

*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, Cartão de

Débito – DebitCardDataRequest e Epay - PrepaidCardDataRequest).

Tabela 13.2 – Propriedades do objeto CreditCardDataRequest


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

NumberOf Payments

Número de pagamentos short Sim (Não

PaymentPlan Código do plano de pagamento** byte Sim

TransactionType Tipo da Transação*** byte Sim

CardHolder Nome que consta no cartão de crédito string 50 Sim

CardNumber Numero do cartão de crédito string 30

Sim (Caso seja

enviado

CreditCardToken

ou JustClickAlias,

este parâmetro

não será

obrigatório)

CardSecurityCode Código de segurança do cartão (Utilizar 6 dígitos para Givex)

string 4

Sim (Mas a loja pode ter

habilitar aceitar CVV Nulo)

CardExpiration Date

Data de expiração do cartão string 15

Sim (Não é obrigatório para

Cartão Presente/Alelo)

CreditCardToken Identificador do cartão de crédito a ser usado na transação via JustClick

Guid Não

JustClickAlias Alias (Apelido) do cartão de crédito string 64 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


Pagador Transaction




**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

***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,5

Tabela 13.3 – Propriedades do objeto DebitCardDataRequest

¹ Parcelamento realizado pelo estabelecimento sem juros.

² Parcelamento realizado pelo emissor com juros.

³ Tipo de pagamento exclusivo para companhias aéreas.

4 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. 5 Transações Banorte Cargos Automáticos. 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.


Pagador Transaction




Tabela 13.2.1 – Propriedades do objeto PrepaidCardDataRequest


CardNumber Número do cartão string 30 Sim

Password Senha do cartão numérico 4 Não

Tabela 13.3– Propriedades do objeto DebitCardDataRequest


Card Holder Nome que consta no cartão de crédito string 50 Sim

Card Number Numero do cartão de crédito string 30 Sim

Card Security Code Código de segurança do cartão string 4 Sim

Card Expiration Date

Data de expiração do cartão string 15 Sim

* Propriedades exclusivas para Visa Electron e Mastercard Débito

Tabela 13.4– Propriedades do objeto BoletoDataRequest


BoletoNumber "NossoNumero". Caso não informe esse valor, a

Braspag irá gerar automaticamente String 50 Não

BoletoInstructions Instruções a serem inclusas no boleto String 450 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 10 Não

Tabela 13.5 – Propriedades do objeto OneBuyDataRequest


TokenOneBuy Token fornecido pelo aplicativo instalado em dispositivo mobile (XXXX-XXXX-XXXX-XXXX)

string 19 Sim

NumberOf Payments

Número de pagamentos short Sim

PaymentPlan Código do plano de pagamento** byte Sim


Pagador Transaction




Tabela 13.6 – Propriedades do objeto CustomerDataRequest

Parâmetro Descrição Tipo Tamanho* Obrigatório

CustomerIdentity Identificação do cliente string 18

Opcional /

Obrigatório para

CredSystem e Boleto Registrado

CustomerIdentityType

Tipo de Identificação do Cliente string 3 Não

CustomerName Nome do cliente string 255 Sim

CustomerEmail E-mail do cliente string 255 Não

CustomerAddressData

Endereço de cobrança do cartão AddressDataRequest

(Tabela 13.7)

Opcional /

Obrigatório para

Boleto Registrado

DeliveryAddressData

Endereço de entrega AddressDataRequest

(Tabela 13.7) Não

* Para “Boleto Registrado”, vide as limitações específicas por banco, na seção “Boleto Registrado” Tabela 13.7 – Propriedades do objeto AddressDataRequest

Parâmetro Descrição Tipo Tamanho* Obrigatório

Street Rua string 255 Opcional / Obrigatório para Boleto Registrado

Number Número string 15 Opcional / Obrigatório para Boleto Registrado

Complement Complemento string 50 Opcional

District Bairro string 50 Opcional / Obrigatório para Boleto Registrado

ZipCode CEP string 9 Opcional / Obrigatório para Boleto Registrado

City Cidade string 50 Opcional / Obrigatório para Boleto Registrado

State Estado string 2 Opcional / Obrigatório para Boleto Registrado

Country País Paises (Tabela 13.21)

Opcional

* Para “Boleto Registrado”, vide as limitações específicas por banco, na seção “Boleto Registrado”


Pagador Transaction




Tabela 13.8 – Propriedades do objeto AdditionalDataRequest


Name Nome do campo string 50 Não

Value Valor do campo string 1024 Não

Tabela 13.9 – Propriedades do objeto ErrorReportDataResponse

Parâmetro Descrição Tipo Tamanho

ErrorCode Código do erro na Braspag string 50

ErrorMessage Mensagem descrevendo o motivo do erro string 255

Tabela 13.10 – Propriedades do objeto OrderDataResponse


OrderId Número do pedido no cliente string 36

BraspagOrderId Número do pedido na Braspag Guid

Tabela 13.11 – Propriedades do objeto PaymentDataResponse


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 13.12 – Propriedades do objeto CreditCardDataResponse


AcquirerTransactionId Id da transação na adquirente string 40

AuthorizationCode Código de autorização string 300

ReturnCode Código de retorno da adquirente string 32

ReturnMessage Mensagem de retorno da adquirente string 512


Pagador Transaction




ProofOfSale Número do Comprovante de Venda string 20

Status

Status de retorno AtributoStatusdoobjetoCreditCard (Tabela 13.12.2)

byte


Guid

SerivceTaxAmount Montante do valor da transação a ser destinado como taxa de serviço utilizado pela operadora.

string 450

AuthenticationUrl URL para qual o Lojista deve redirecionar o Cliente para o fluxo de autenticação.

string 256

Tabela 13.12.1 - Propriedades do objeto PrepaidCardDataResponse






Status


byte

Tabela 13.12.2 - Valores do Atributo Status do objeto CreditCardDataResponse/PrepaidCardDataResponse


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.13 – Propriedades do objeto DebitCardDataResponse




Pagador Transaction






Status


byte

AuthenticationUrl URL para qual o Lojista deve redirecionar o Cliente para o fluxo de autenticação.

string 256


Tabela 13.14 – Propriedades do objeto BoletoDataResponse


BoletoNumber "NossoNumero" gerado String 50

BoletoExpiration Date

Data de vencimento String 10

BoletoUrl URL do boleto gerada String 256

BarCodeNumber Representação numérica do código de barras String 44

Assignor Campo cedente String 50

Message Mensagem indicando Sucesso/Falha na geração do boleto String 150

Tabela 13.15 – Propriedades do objeto OneBuyDataResponse





Status

Status de retorno AtributoStatusdoobjetoOneBuy (Tabela 13.15.1)

byte

Tabela 13.15.1 - Valores do Atributo Status do objeto OneBuyDataResponse



Pagador Transaction




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 Descrição Tipo Size Obrigatório

BraspagTransactionId Numero da transação na Braspag Guid Sim

Amount Valor a ser operado (ex.: R$1,00 = 100) long Sim

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 450 Não

Tabela 13.17 – Propriedades do objeto TransactionDataResponse


BraspagTransactionId Numero da transação na Braspag Guid

AcquirerTransactionId Número da transação de captura na Operadora string 36

Amount Valor operado pela operadora, total ou parcial da transação em centavos (ex.: R$1,00 = 100)

long





Status Status de retorno (Captura) statusderetornodométodoCaptureCreditCardTransaction (tabela 4.1)

short

ServiceTaxAmount Montante do valor da transação a ser destinado como taxa de serviço utilizado pela operadora.

string 450

Tabela 13.18 – Propriedades do objeto OrderTransactionDataResponse


Pagador Transaction





BraspagTransactionId Numero da transação na Braspag Guid

OrderId Identificação do pedido no cliente string 36

AcquirerTransactionId Número da transação na Operadora string 40

PaymentMethod Código do meio de pagamento int

PaymentMethodName Nome do meio de pagamento string 100

ErrorCode Código de erro da transação. Caso vazio não houve erro na transação

string 50

ErrorMessage Mensagem de erro da transação. Caso vazio não houve erro na transação

string 255

Amount Valor operado pela operadora, total ou parcial da transação em centavos (ex.: R$1,00 = 100)

long


NumberOfPayments Numero de vezes em que a transação foi parcelada int

Currency Moeda (ex.: “BRL”, “USD”, etc ) string 3

Country País (ex.: “BRA”) string 3

Status Status de retorno short

ReceivedDate Data em que a transação foi recebida na Braspag string 24

CapturedDate Data de captura da transação. Caso vazio a transação não foi capturada

string 24

VoidedDate Data de cancelamento da transação. Caso vazio a transação não foi cancelada

string 24


string 36

Tabela 13.19 – Propriedades do objeto AdditionalTransactionDataResponse


Name Nome do campo do dado adicional string 50

Value Valor do dado adicional string 1024

Tabela 13.20 – Meios de Pagamento


Pagador Transaction




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

520 Banorte Cargos Automáticos VISA

521 Banorte Cargos Automáticos MASTERCARD


Pagador Transaction




523 AMEX 2P

524 Sitef VISA

525 SiTef MASTERCARD

526 SiTef AMEX

527 SiTef 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

540 Sub1 NARANJA

541 Sub1 NEVADA

542 Sub1 CABAL

543 Cielo DISCOVER

544 Cielo JCB

545 Cielo AURA

548 Redecard Webservice HIPERCARD

550 CredSystem

551 Boleto Caixa – SIGCB

552 Cielo Mastercard Débito

559 Credibanco VISA

560 Credibanco MASTERCARD

561 Credibanco CREDENTIAL


Pagador Transaction




562 Credibanco DINERS

563 Credibanco AMEX

564 DM Card

565 Credz

567 Transferência Eletrônica Bradesco SPS

568 Boleto Bradesco SPS

569 SafetyPay Express

570 EPay

572 Banorte V2 VISA

573 Banorte V2 MASTERCARD

574 Banorte V2 Cargos Automáticos VISA

(Verificar Item 17)

575 Banorte V2 Cargos Automáticos MASTERCARD

(Verificar item 17)

576 Sub1 DISCOVER

577 Banese Card

578 E-Rede

579 E-Rede débito

582 Cielo 3.0

584 Boleto Registrado Banco do Brasil

583 Cielo 3.0 débito

585 Boleto Registrado Bradesco

Tabela 13.21 – Países

Sigla País

BRA Brasil

USA Estados Unidos

MEX México

COL Colômbia


Pagador Transaction




CHL Chile

ARG Argentina

PER Peru

VEN Venezuela

ECU Equador

PRY Paraguai

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

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


Pagador Transaction




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

127 CurrencyIsNotSupported Currency submited is not supported for

this payment method

128 TransactionTypeIsNotSupported 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 Email Address Invalid Email Address


Pagador Transaction




135 OrderId was already registered OrderId was already registered

136 CustomerAddressStateInvalidFormat CustomerAddressState Invalid Format

139 RefundIsNotEnabledForThisMerchant Refund Is Not Enabled For This Merchant

140 OrderIdIsNotRegistered OrderId Is Not Registered

141 TransactionIsNotAbleToRefund Transaction Is Not Able To Refund

142 AreaCodeIsMandatoryParameter AreaCode

is a mandatory parameter

143 PhoneNumberIsMandatoryParameter PhoneNumber is a mandatory parameter

144 AreaCodeIsInvalid AreaCode is invalid

145 PhoneNumberIsInvalid PhoneNumber is invalid

146 MerchantNotAvailableForTransaction Merchant Not Available For Transaction

152 BoletoNumberIsAMandatoryParameter BoletoNumber is a mandatory parameter

153 BoletoExpirationDateIsAMandatoryParameter BoletoExpirationDate is a mandatory

parameter

154 TransactionNotAvailableForVoid Transaction not available for void

157 PaymentMethodIsMandatoryParameter PaymentMethod is a mandatory parameter

158 AffiliationNotFound Affiliation not found

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


Pagador Transaction




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> <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>


Pagador Transaction




<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> <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> 11.1.2. Método AuthorizeTransaction - PrepaidCard Obs.: Trata-se do método AuthorizeTransaction utilizando o meio de pagamento 570 – EPay. <?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>


Pagador Transaction




<PaymentDataCollection> <PaymentDataRequest xsi:type="PrepaidCardDataRequest"> <PaymentMethod>570</PaymentMethod> <Amount>500</Amount> <Currency>BRL</Currency> <Country>BRA</Country> <CardNumber>0000000000000001</CardNumber>

<Password>0000</Password> </PaymentDataRequest> </PaymentDataCollection> <RequestId>00000000-0000-0000-0000-000000000000</RequestId>

<Version>1.0</Version> </request> </AuthorizeTransaction> </soap:Body>

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 >


Pagador Transaction




</soap:Body> </soap:Envelope>

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>


Pagador Transaction




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.8).

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)


Pagador Transaction




13. 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

CLIENTE BRASPAG - PAGADOR ONEBUY

Ph

ase

Envia Requisição de Transação

Processa Transação do Cliente

Recebe a Transação eProcessa Autenticação

solicitando a senha gerada pelo token do

comprador

Processa Transação e encaminha resposta

ao Pagador

Processa Resposta e encaminha ao

Cliente

Recebe Resposta da Requisição


Pagador Transaction




14. BANORTE - CARGOS AUTOMATICOS

Para utilizar a modalidade Recorrência no Banorte, é necessário que o lojista forneça o número de referência do

cliente. Este campo deverá ser enviado para a Braspag através da Tabela AdditionalDataRequest (Tabela 13.8).

O campo “Name” deverá ser preenchido com a palavra “RecurrenceCode”.

Já o campo “Value” deverá conter a identificação da Recorrência, com até 20 caracteres.

Conforme indicado no exemplo abaixo:


Name RecurrenceCode String Sim

Value Exemplo123 String

(Até 20 caracteres) Sim

Obs: O campo TransactionType deve ser obrigatoriamente enviado “6” - Captura Automática Recorrente.


Pagador Transaction




15. AUTENTICAÇÃO EXTERNA (CIELO)

Modalidade em que o estabelecimento envia junto à transação, os dados retornados no processo de autenticação entre

o Titular e o banco. Dados devem ser enviados no PaymentDataRequest.

Suporta apenas as bandeiras VISA e MASTERCARD.

Propriedades do objeto ExternalAuthentication


Cavv Verificação de Autenticação do Titular do Cartão String Sim

Xid Identificador da Transação String Sim

ECI Indicador de Comércio Eletrônico* String Sim

Obs: O campo TransactionType deve ser obrigatoriamente enviado “3” – Pré-Autorização com Autenticação ou

“4” – Captura Automática com Autenticação.

Tabela 18 – Resultado da Autenticação

Resultado da Autenticação Visa Master Outros

Portador autenticado com sucesso 5 2 n/d

Portador não fez autenticação, pois o

emissor não forneceu mecanismos de

autenticação. 6 1 n/d

O Portador não se autenticou com sucesso, pois ocorreu um erro técnico

inesperado 7 1 n/d

O Portador não se autenticou com sucesso

7 0 n/d

A loja optou por autorizar sem passar pela autenticação

7 0 n/d


Pagador Transaction




*O ECI representa o nível de segurança da transação.

Ex.: Autenticada ; Não autenticada etc. Consultar a tabela da adquirente – valor pode variar por bandeira

Exemplo Request:

<?xml version=""1.0"" encoding=""utf-16""?>

<AuthorizeTransactionRequest>

<RequestId>00000000-0000-0000-0000-000000000000</RequestId>

<Version>1.0</Version>

<OrderData>

<MerchantId>00000000-0000-0000-0000-000000000000</MerchantId>

<OrderId>000</OrderId>

<BraspagOrderId d3p1:nil=""true"" xmlns:d3p1=""http://www.w3.org/2001/XMLSchema-instance"" />

</OrderData>

<CustomerData>

<CustomerIdentity>999999999</CustomerIdentity>

<CustomerName>Comprador Teste</CustomerName>

<CustomerEmail>[email protected]</CustomerEmail>

<CustomerAddressData />

<DeliveryAddressData />

</CustomerData>

<PaymentDataCollection>

<PaymentDataRequest d3p1:type=""CreditCardDataRequest""

xmlns:d3p1=""http://www.w3.org/2001/XMLSchema-instance"">

<PaymentMethod>500</PaymentMethod>

<Amount>500</Amount>

<Currency>BRL</Currency>

<Country>BRA</Country>

<ServiceTaxAmount>0</ServiceTaxAmount>

<NumberOfPayments>1</NumberOfPayments>

<PaymentPlan>0</PaymentPlan>


Pagador Transaction




<TransactionType>3</TransactionType>

<CardHolder>Comprador Teste</CardHolder>

<CardNumber>0000000000000001</CardNumber>

<CardSecurityCode>123</CardSecurityCode>

<CardExpirationDate>01/2017</CardExpirationDate>

<CreditCardToken d3p1:nil=""true"" />

<SaveCreditCard d3p1:nil=""true"" />

<ExternalAuthentication>

<Cavv>xxxxxxxxxxxxxxxxxxxxxxxxxxxx</Cavv>

<Xid>xxxxxxxxxxxxxxxxxxxxxxxxxxxx</Xid>

<Eci>x</Eci>

</ExternalAuthentication>

</PaymentDataRequest>

</PaymentDataCollection>

</AuthorizeTransactionRequest>


Pagador Transaction




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*

4 Operação realizada com

Sucesso

Não Autorizado 0000.0000.0000.0002* 2 Não Autorizada

Não Autorizado 0000.0000.0000.0006* 99 Timed Out

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


Pagador Transaction




17. BOLETOS REGISTRADOS

Em alguns casos, bancos podem ter limitações de tamanho diferente do Pagador. Segue abaixo as limitações

específicas de cada um. Demais campos devem seguir a especificação geral contida na documentação.

Banco do Brasil


CustomerName Nome do cliente string 60

Street Rua string Estes três campos devem

totalizar até 60

caracteres

Number Número string

District Bairro string

City Cidade string 18

Outras observações

o No Boleto Registrado Banco do Brasil, a linha digitável não será retornado no response da requisição. Esta informação ficará disponível após conciliação.

o Para todos os campos texto, inclusive o campo de instruções e relacionados ao endereço, são aceitos como caracteres válidos:

as letras de A a Z (MAIÚSCULAS);

caracteres especiais de conjunção: hífen (-), apóstrofo ('). Quando utilizados não pode conter espaços entre as letras;

Exemplos corretos: D'EL-REI, D'ALCORTIVO, SANT'ANA

Exemplos incorretos: D'EL - REI

até um espaço em branco entre palavras

Bradesco


CustomerName Nome do cliente string 40

Street Rua string 70

Number Número string 10

District Bairro string 50

City Cidade string 50


pagador transaction autorização, captura, cancelamento e ... · inclusão do meio de pagamento...

Documents