Pagador Transaction. Consulta. Versão 1.3

Transcrição

1 Pagador Transaction Consulta Versão /09/2013

2 SUMÁRIO HISTÓRICO DE ALTERAÇÕES... 3 INTRODUÇÃO... 4 OBJETIVO MÉTODO GETADDITIONALDATA RETORNO DO MÉTODO GETADDITIONALDATA MÉTODO GETBOLETODATA RETORNO DO MÉTODO GETBOLETODATA MÉTODO GETBRASPAGORDERID RETORNO DO MÉTODO GETBRASPAGORDERID MÉTODO GETCREDITCARDDATA RETORNO DO MÉTODO GETCREDITCARDDATA MÉTODO GETCUSTOMERDATA RETORNO DO MÉTODO GETCUSTOMERDATA MÉTODO GETDELIVERYADDRESSDATA RETORNO DO MÉTODO GETDELIVERYADDRESSDATA MÉTODO GETORDERDATA RETORNO DO MÉTODO GETORDERDATA MÉTODO GETTRANSACTIONDATA RETORNO DO MÉTODO GETTRANSACTIONDATA MÉTODO GETORDERIDDATA RETORNO DO MÉTODO GETORDERIDDATA TABELAS DE DOMÍNIO MAPA DE ERROS Telefone: (21) / (11) Página 2 de 19

3 HISTÓRICO DE ALTERAÇÕES Pagador Transaction - Consulta Versão Data Descrição /01/2012 Versão inicial /09/2012 Inclusão dos Erros BP /06/ /09/2013 Inserção do Método: GetOrderIdData Inserção do Parâmetro ProofofSale, nos métodos: GetOrderData, GetTransactionData Inclusão do Parâmetro TransactionType no objeto TransactionDataResponse; Tabela 18.1 movida para as Tabelas de Domínio, sendo alterada para 19.4; Alteração do Título das Tabelas 19.4 e 19.5 Telefone: (21) / (11) Página 3 de 19

4 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 no processo de consulta utilizando as novas funcionalidades do Pagador Transaction Query. Segue a URL de Homologação, para que possa iniciar a integração com a Braspag. Url de Homologação: Para acesso ao código descritivo do webservice (WSDL), acessar o link Service Description, conforme abaixo: Para receber a url de produção, solicite à nossa equipe de implantação através da ferramenta Suporte. Para realizar consultas no ambiente de produção, será necessário informar os endereços de IP s dos servidores que acessarão o webservice. Telefone: (21) / (11) Página 4 de 19

5 Estão descritos neste manual, nove funcionalidades do Webservice Pagador Transaction Query referente à Plataforma Pagador: GetAdditionalData Obter Dados Adicionais utilizando a Plataforma do Novo Pagador; GetBoletoData Obter Dados do Boleto utilizando a Plataforma do Novo Pagador; GetBraspagOrderId Obter o Número do Pedido da Braspag utilizando a Plataforma do Novo Pagador; GetCredicardData Obter Dados do Cartão de Crédito utilizando a Plataforma do Novo Pagador; GetCustomerData Obter Dados do Cliente utilizando a Plataforma do Novo Pagador; GetDeliveryAddressData Obter Dados do Endereço de Entrega utilizando a Plataforma do Novo Pagador; GetOrderData Obter Dados do Pedido utilizando a Plataforma do Novo Pagador; GetTransactionData Obter Dados da Transação utilizando a Plataforma do Novo Pagador; GetOrderIdData Obter Dados do Pedido dentro da Braspag utilizando a Plataforma do Novo Pagador; Telefone: (21) / (11) Página 5 de 19

6 1. Método GetAdditionalData Este método retorna todos os dados adicionais referentes a uma transação e recebe um objeto AdditionalDataRequest com as seguintes propriedades: Tabela 1 Propriedades do objeto AdditionalDataRequest Obrigatório RequestId É o campo identificador do pedido no formato: Version Versão do contrato do Webservice (ex.: 1.0 ) MerchantId É o campo identificador da loja no formato: Braspag TransactionId Número da transação na Braspag 1.1. Retorno do Método GetAdditionalData O método GetAdditionalData retornará um objeto AdditionalDataResponse com as seguintes propriedades: Tabela 2 Propriedades do objeto AdditionalDataResponse CorrelationId Identificador da requisição do Webservice Success ErrorReportData AdditionalData Se a requisição chegou até a operadora, Success = true, caso contrário Success = false Coleção de itens contendo erros da requisição Coleção de dados adicionais bool ArrayOfErrorReportData Response (Tabela 19) ArrayOfAdditionalTransaction DataResponse (Tabela 19.1) 2. Método GetBoletoData Este método retorna os dados referentes a uma transação de boleto e recebe um objeto BoletoDataRequest com as seguintes propriedades: Tabela 3 Propriedades do objeto BoletoDataRequest Obrigatório RequestId É o campo identificador do pedido no formato: Version Versão do contrato do Webservice (ex.: 1.0 ) MerchantId É o campo identificador da loja no formato: Braspag TransactionId Número da transação na Braspag Telefone: (21) / (11) Página 6 de 19

7 2.1. Retorno do Método GetBoletoData O método GetBoletoData retornará um objeto BoletoDataResponse com as seguintes propriedades: Tabela 4 Propriedades do objeto BoletoDataResponse CorrelationId Identificador da requisição do Webservice. Success ErrorReportData Document Number Se a requisição chegou até a operadora, Success = true, caso contrário Success = false Coleção de itens contendo erros da requisição Número do documento bool ArrayOfErrorReportData Response (Tabela 19) Instructions Instruções do boleto Customer Nome do sacado BoletoNumber Nosso número (utilizado na conciliação) long BarCodeNumber Linha digitável DocumentDate Data do documento (geração do boleto) datetime ExpirationDate Vencimento do boleto datetime BankNumber Número do banco Agency Agência Account Conta BoletoType Carteira Amount Valor do boleto long PaidAmount Valor pago long PaymentDate Data do pagamento (data do crédito) datetime Assignor Campo cedente BoletoUrl Url para montar o boleto Telefone: (21) / (11) Página 7 de 19

8 3. Método GetBraspagOrderId O método GetBraspagOrderId retornará o numero do BraspagOrderId dada uma transação e recebe um objeto BraspagOrderIdDataRequestcom as seguintes propriedades Tabela 5 Propriedades do BraspagOrderIdDataRequest Obrigatório RequestId É o campo identificador do pedido no formato:. Version Versão do contrato do Webservice (ex.: 1.0 ). MerchantId É o campo identificador da loja no formato: Braspag TransactionId Número da transação na Braspag 3.1. Retorno do Método GetBraspagOrderId O método GetBraspagOrderId retorna um objeto BraspagOrderIdDataResponse com as seguintes propriedades: Tabela 6 Propriedades do objeto AdditionalDataResponse CorrelationId Identificador da requisição do Webservice Success ErrorReportData Se a requisição chegou até a operadora, Success = true, caso contrário Success = false Coleção de itens contendo erros da requisição bool ArrayOfErrorReportData Response (Tabela 19) BraspagOrderId Número do BraspagOrderId 4. Método GetCreditCardData Este método retorna todos os dados referentes à um cartão de crédito utilizado em uma compra e recebe um como parâmetro com as seguintes propriedades: Tabela 7 Propriedades do objeto CreditCardDataRequest Obrigatório RequestId É o campo identificador do pedido no formato: Version Versão do contrato do Webservice (ex.: 1.0 ) MerchantId É o campo identificador da loja no formato: Braspag TransactionId Número da transação na Braspag Telefone: (21) / (11) Página 8 de 19

9 4.1. Retorno do Método GetCreditCardData O método GetCreditCardData retornará um objeto CreditCardDataResponse com as seguintes propriedades: Tabela 8 Propriedades do objeto CreditCardDataResponse CorrelationId Identificador da requisição do Webservice Success ErrorReportData Se a requisição chegou até a operadora, Success = true, caso contrário Success = false Coleção de itens contendo erros da requisição bool ArrayOfErrorReportData Response (Tabela 19) CardNumber Numero do cartão de crédito utilizado na compra CardHolder Nome do Portador do Cartão CardExpiration Date Data de validade do cartão de crédito datetime 5. Método GetCustomerData Este método retorna os dados referentes ao comprador e recebe um objeto CustomerDataRequest com as seguintes propriedades: Tabela 9 Propriedades do objeto CustomerDataRequest Obrigatório RequestId É o campo identificador do pedido no formato: Version Versão do contrato do Webservice (ex.: 1.0 ) MerchantId É o campo identificador da loja no formato: BraspagOrderId Número do pedido na Braspag 5.1. Retorno do Método GetCustomerData O método GetCustomerData, retornará um objeto CustomerDataResponse com as propriedades abaixo: Tabela 10 Propriedades do objeto CustomerDataResponse CorrelationId Identificador da requisição do Webservice Success ErrorReportData Se a requisição chegou até a operadora, Success = true, caso contrário Success = false Coleção de itens contendo erros da requisição bool ArrayOfErrorReportData Response (Tabela 19) Telefone: (21) / (11) Página 9 de 19

10 CustomerIdentity Identificação do cliente CustomerName Nome do cliente Customer do cliente Street Rua do cliente Number Número do endereço do cliente Complement Complemento do endereço do cliente District Bairro do cliente ZipCode CEP do cliente City Cidade do cliente State Estado do cliente Country País do cliente 6. Método GetDeliveryAddressData Este método retorna os dados referentes ao endereço de entrega do pedido e recebe um objeto DeliveryAddressDataRequest com as seguintes propriedades: Tabela 11 Propriedades do objeto DeliveryAddressDataRequest Obrigatório RequestId É o campo identificador do pedido no formato: Version Versão do contrato do Webservice (ex.: 1.0 ) MerchantId É o campo identificador da loja no formato: BraspagOrderId Número do pedido na Braspag Telefone: (21) / (11) Página 10 de 19

11 6.1. Retorno do Método GetDeliveryAddressData O método GetDeliveryAddressData retornará um objeto DeliveryAddressDataResponse com as seguintes propriedades: Tabela 12 Propriedades do objeto DeliveryAddressDataResponse CorrelationId Identificador da requisição do Webservice Success ErrorReportData Se a requisição chegou até a operadora, Success = true, caso contrário Success = false Coleção de itens contendo erros da requisição bool ArrayOfErrorReportData Response (Tabela 19) Street Rua de entrega Number Número do endereço de entrega Complement Complemento do endereço de entrega District Bairro da entrega ZipCode CEP do endereço a ser entregue City Cidade do endereço a ser entregue State Estado do endereço a ser entregue Country País do endereço a ser entregue 7. Método GetOrderData Este método permite realizar consultas os dados do pedido na Braspag via Webservice. Este método recebe um objeto OrderDataRequest com as seguintes propriedades: Tabela 13 Propriedades do objeto OrderDataRequest Obrigatório RequestId É o campo identificador do pedido no formato: Version Versão do contrato do Webservice (ex.: 1.0 ) MerchantId É o campo identificador da loja no formato: { } BraspagOrderId Número do pedido na Braspag Telefone: (21) / (11) Página 11 de 19

12 7.1. Retorno do Método GetOrderData O método GetOrderData, retornará um objeto OrderDataResponse com as propriedades abaixo: Tabela 14 Propriedades do objeto OrderDataResponse CorrelationId Identificador da requisição do Webservice Success ErrorReportData TransactionData Se a requisição chegou até a operadora, Success = true, caso contrário Success = false Coleção de itens contendo erros da requisição Coleção de transações para o BraspagOrderId informado bool ArrayOfErrorReportDataResponse (Tabela 19) ArrayOf OrderTransactionDataResponse (Tabela 19.2) Tabela 14.1 Possíveis status de retorno das transações do método GetOrderData Status Cód. Descrição Indefinida 0 A transação está com status indefinido Capturada 1 A transação foi capturada Autorizada 2 A transação foi autorizada Não Autorizada 3 A transação não foi autorizada Cancelada 4 A transação foi cancelada Estornada 5 A transação foi estornada Aguardando 6 A Transação está Aguardando resposta Desqualificada 7 A Transação foi desqualificada O pedido poderá ser tratado como pago apenas quando for retornado status 1 (Pago) Telefone: (21) / (11) Página 12 de 19

13 8. Método GetTransactionData Este método retorna todos os dados relativos à uma transação efetuada e recebe um objeto TransactionDataRequest como parâmetro com as seguintes propriedades: Tabela 15 Propriedades do objeto TransactionDataRequest Obrigatório RequestId É o campo identificador do pedido no formato: Version Versão do contrato do Webservice (ex.: 1.0 ) MerchantId É o campo identificador da loja no formato: Braspag TransactionId Número da transação na Braspag 8.1. Retorno do Método GetTransactionData O método GetTransactionData, retornará um objeto TransactionDataResponse com as propriedades abaixo: Tabela 16 Propriedades do objeto TransactionDataResponse Braspag TransactionId Numero da transação na Braspag OrderId Identificação do pedido no cliente Acquirer TransactionId Número da transação na Operadora PaymentMethod Código do meio de pagamento int PaymentMethod Name Nome do meio de pagamento ErrorCode Código de erro da transação. Caso vazio não houve erro na transação ErrorMessage Amount Authorization Code NumberOf Payments Mensagem de erro da transação. Caso vazio não houve erro na transação Valor operado pela operadora, total ou parcial da transação em centavos (ex.: R$1,00 = 100) Código de autorização Numero de vezes em que a transação foi parcelada long int Currency Moeda (ex.: BRL, USD, etc) Country País (ex.: BRA ) TransactionType Tipo de transação (Tabela 19.4) byte Telefone: (21) / (11) Página 13 de 19

14 Status Status de retorno (Tabela 19.5) short ReceivedDate Data em que a transação foi recebida na Braspag CapturedDate VoidedDate CreditCardToken Data de captura da transação. Caso vazio a transação não foi capturada Data de cancelamento da transação. Caso vazio a transação não foi cancelada Identificador do cartão de crédito a ser usado na transação via JustClick ProofOfSale Número do Comprovante de Venda 9. Método GetOrderIdData Este método permite realizar consultas os dados do pedido com identificação interna Braspag, via Webservice. Este método recebe um objeto OrderIdDataRequest com as seguintes propriedades: Tabela 17 Propriedades do objeto OrderIdDataRequest Obrigatório RequestId É o campo identificador do pedido no formato: Version Versão do contrato do Webservice (ex.: 1.0 ) MerchantId É o campo identificador da loja no formato: { } OrderId Número do pedido 9.1. Retorno do Método GetOrderIdData O método GetOrderIdData, retornará um objeto OrderIdDataResponse com as propriedades abaixo: Tabela 18 Propriedades do objeto OrderIdDataResponse CorrelationId Identificador da requisição do Webservice Success ErrorReportData OrderIdData Se a requisição chegou até a operadora, Success = true, caso contrário Success = false Coleção de itens contendo erros da requisição Coleção de transações para o Order Id informado bool ArrayOfErrorReportDataResponse (Tabela 19) ArrayOf OrderIdTransactionResponse (Tabela 19.3) Telefone: (21) / (11) Página 14 de 19

15 10. TABELAS DE DOMÍNIO Tabela 19 Propriedades do objeto ErrorReportDataResponse ErrorCode Código do erro na Braspag ErrorMessage Mensagem descrevendo o motivo do erro Tabela 19.1 Propriedades do objeto AdditionalTransactionDataResponse Name Nome do campo do dado adicional Value Valor do dado adicional Tabela 19.2 Propriedades do objeto OrderTransactionDataResponse BraspagTransactionId Numero da transação na Braspag OrderId Identificação do pedido no cliente AcquirerTransactionId Número da transação na Operadora PaymentMethod Código do meio de pagamento int PaymentMethodName Nome do meio de pagamento ErrorCode ErrorMessage Amount Código de erro da transação. Caso vazio não houve erro na transação Mensagem de erro da transação. Caso vazio não houve erro na transação Valor operado pela operadora, total ou parcial da transação em centavos (ex.: R$1,00 = 100) long AuthorizationCode Código de autorização NumberOfPayments Numero de vezes em que a transação foi parcelada int Currency Moeda (ex.: BRL, USD, etc ) Country País (ex.: BRA ) TransactionType Tipo de transação (Tabela 19.4) byte Status Status de retorno (Tabela 19.5) short Telefone: (21) / (11) Página 15 de 19

16 ReceivedDate Data em que a transação foi recebida na Braspag CapturedDate VoidedDate CreditCardToken Data de captura da transação. Caso vazio a transação não foi capturada Data de cancelamento da transação. Caso vazio a transação não foi cancelada Identificador do cartão de crédito a ser usado na transação via JustClick ProofOfSale Número da Comprovante de Venda Tabela 19.3 Propriedades do objeto OrderIdTransactionResponse BraspagOrderId Número do BraspagOrderId BraspagTransactionId Identificador da transação na Braspag Tabela 19.4 Status da Transação Status Cód. Descrição Indefinida 0 A transação está com status indefinido Capturada 1 A transação foi capturada Autorizada 2 A transação foi autorizada Não Autorizada 3 A transação não foi autorizada Cancelada 4 A transação foi cancelada Estornada 5 A transação foi estornada Aguardando 6 A Transação está Aguardando resposta Desqualificada 7 A Transação foi desqualificada O pedido poderá ser tratado como pago apenas quando for retornado status 1 (Pago) Telefone: (21) / (11) Página 16 de 19

17 Tabela 19.5 Tipo de Transação 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 Telefone: (21) / (11) Página 17 de 19

18 11. MAPA DE ERROS Tabela 20 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 PaymentDataIsMandatoryItem PaymentData is a mandatory item 108 CreditCardDataIsMandatoryItem CreditCardData is a mandatory item 109 PaymentMethodIsInvalid PaymentMethod is invalid 110 AmountMustBeGreaterThanZero Amount must be greater than or equal to zero 111 CardNumberIsMandatoryParameter CardNumber is a mandatory parameter 112 CardExpirationDateIsMandatoryParameter CardExpirationDate is a mandatory parameter 113 CardExpirationDateIsInvalid CardExpiration is invalid 114 NumberOfPaymentsIsInvalid NumberOfPayments is invalid 115 PaymentPlanIsInvalid PaymentPlan is invalid 116 CurrencyIsMandatoryParameter Currency is a mandatory parameter 117 CountryIsMandatoryParameter Country is a mandatory parameter 118 TransactionTypeIsInvalid TransactionType is invalid 119 CustomerDataIsMandatoryItem CustomerData is mandatory item 120 CustomerIdentityIsMandatoryParameter CustomerIdentity is a mandatory parameter Telefone: (21) / (11) Página 18 de 19

19 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 128 TransactionTypeIsNotSupported Currency submited is not supported for this payment method Transaction type submited is not supported for this payment method 129 CountryIsNotSupported Country is not supported 130 TransactionDataIsMandatoryItem TransactionData is a mandatory item 131 BraspagOrderIdIsMandatoryParameter BraspagOrderId is a mandatory parameter 132 TransactionNotAvailableForCapture Transaction not available for capture 133 BoletoExpirationDateisInvalid BoletoExpirationDate is invalid 134 Invalid Address Invalid Address 135 OrderId was already registered OrderId was already registered 199 UndefinedError Undefined error 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 no Consulta Falha na Consulta Telefone: (21) / (11) Página 19 de 19