Introdução ao Pagador API

O objetivo desta documentação é orientar o desenvolvedor sobre como integrar com o API do Pagador, gateway de pagamentos da Braspag, descrevendo os serviços disponíveis com exemplos de requisição e respostas.

Todas as operações requerem credenciais de acesso (Merchant ID e Merchant Key) específicos para respectivos ambientes: Sandbox e Produção. Para executar uma operação, combine o endpoint base do ambiente com o endpoint da operação desejada e envie utilizando o VERBO HTTP conforme descrito na operação.

Ambientes

Ambiente Sandbox

Experimente as nossas APIs sem compromisso!

Informação Descrição
Credenciais de Acesso à API Acesse o Cadastro do Sandbox e crie uma conta de testes.
Ao fim do cadastro você receberá um MerchantId e um MerchantKey,
que deverão ser utilizados para autenticar todas as requisições feitas para os endpoints da API
Endpoint Transacional https://apisandbox.braspag.com.br/
Endpoint para Serviços de Consultas https://apiquerysandbox.braspag.com.br/

Ambiente de Produção

Já estou pronto para entrar em Produção!

Informação Descrição
Credenciais de Acesso à API Envie um email para comercial@braspag.com.br para mais informações sobre a Braspag e sobre como podemos ajudar no seu negócio!
Endpoint Transacional https://api.braspag.com.br/
Endpoint para Serviços de Consultas https://apiquery.braspag.com.br/

Suporte Braspag

Características da Solução

A solução API Pagador foi desenvolvida com a tecnologia REST, que é padrão de mercado e independe da tecnologia utilizada por nossos clientes. Desta forma, é possível integrar-se utilizando as mais variadas linguagens de programação, tais como: ASP, ASP. Net, Java, PHP, Ruby, Python, entre outras.

Entre outras características, os atributos que mais se destacam na plataforma Braspag eCommerce:

Arquitetura

A integração é realizada através de serviços disponibilizados como Web Services. O modelo empregado é bastante simples: Existem duas URLs (endpoints), uma específica para autorização, captura e cancelamento de transações, e uma outra para operações como pesquisa de transações. Essas duas URLs receberão as mensagens HTTP através dos métodos POST, GET ou PUT. Cada tipo de mensagem deve ser enviada para um endereço identificado através do “path”.

Pagamentos com Cartão de Crédito

Para que você possa desfrutar de todos os recursos disponíveis em nossa API, é importante que antes você conheça os conceitos envolvidos no processamento de uma transação de cartão de crédito.

Abaixo segue a lista de adquirentes com as quais temos integração para solicitações de estorno:

Adquirente Prazo Máximo para Solicitação de Estorno
Cielo 300 dias
Rede Tecnologia Komerci: 90 dias; Tecnologia eRede: 60 dias
Getnet 90 dias
Transbank 90 dias
Banorte 30 dias
First Data 90 dias
Alelo 300 dias

Criando uma transação básica

Exemplo de uma transação com dados obrigatórios para um simples processamento de transação de cartão de crédito. Algumas funcionalidades, tais como Captura Automática, Autenticação, Antifraude, Velocity entre outras, requerem preenchimento de mais dados. Neste caso, por favor, consulte os demais exemplos no manual.

Requisição

{
   "MerchantOrderId":"2017051001",
   "Customer":{
      "Name":"Nome do Cliente"
   },
   "Payment":{
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
     "Capture":true,
     "Installments":1,
     "CreditCard":{
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa"
     }
   }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
   "MerchantOrderId":"2017051001",
   "Customer":{
      "Name":"Nome do Cliente"
   },
   "Payment":{
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
     "Capture":true,
     "Installments":1,
     "CreditCard":{
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa"
     }
   }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.Installments Número 2 Sim Número de Parcelas
CreditCard.CardNumber Texto 16 Sim Número do Cartão do comprador
CreditCard.Holder Texto 25 Sim Nome do Comprador impresso no cartão
CreditCard.ExpirationDate Texto 7 Sim Data de validade impresso no cartão, no formato MM/AAAA
CreditCard.SecurityCode Texto 4 Sim Código de segurança impresso no verso do cartão
CreditCard.Brand Texto 10 Sim Bandeira do cartão

Resposta

{
  "MerchantOrderId": "2017051001",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "ProofOfSale": "2539492",
    "AcquirerTransactionId": "0510042539492",
    "AuthorizationCode": "759497",
    "PaymentId": "f8078b32-be17-4c35-b164-ad74c3cd0725",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-10 16:25:38",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "ProviderReturnCode": "4",
    "ProviderReturnMessage": "Operation Successful",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/f8078b32-be17-4c35-b164-ad74c3cd0725"
      },
      {
        "Method": "PUT",
        "Rel": "capture",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/f8078b32-be17-4c35-b164-ad74c3cd0725/capture"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/f8078b32-be17-4c35-b164-ad74c3cd0725/void"
      }
    ]
  }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
  "MerchantOrderId": "2017051001",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "ProofOfSale": "2539493",
    "AcquirerTransactionId": "0510042539492",
    "AuthorizationCode": "759497",
    "PaymentId": "f8078b32-be17-4c35-b164-ad74c3cd0725",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-10 16:25:38",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "ProviderReturnCode": "4",
    "ProviderReturnMessage": "Operation Successful",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/f8078b32-be17-4c35-b164-ad74c3cd0725"
      },
      {
        "Method": "PUT",
        "Rel": "capture",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/f8078b32-be17-4c35-b164-ad74c3cd0725/capture"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/f8078b32-be17-4c35-b164-ad74c3cd0725/void"
      }
    ]
  }
}
Propriedade Descrição Tipo Tamanho Formato
AcquirerTransactionId Id da transação no provedor de meio de pagamento Texto 40 Texto alfanumérico
ProofOfSale Número do Comprovante de Venda Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização Texto 300 Texto alfanumérico
PaymentId Campo Identificador do Pedido Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ReceivedDate Data em que a transação foi recebida pela Brapag Texto 19 AAAA-MM-DD HH:mm:SS
ReasonCode Código de retorno da Operação Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da Operação Texto 512 Texto alfanumérico
Status Status da Transação Byte 2 Ex.
ProviderReturnCode Código retornado pelo provedor do meio de pagamento (adquirente e bancos) Texto 32 57
ProviderReturnMessage Mensagem retornada pelo provedor do meio de pagamento (adquirente e bancos) Texto 512 Transação Aprovada

Criando uma transação com dados do comprador

Este é um exemplo de uma transação com todos os dados preenchidos. Isso inclui os dados do comprador e campos específicos para definir o comportamento de autorização, autenticação e dados extras.

Requisição

{  
   "MerchantOrderId":"2017051002",
   "Customer":{  
      "Name":"Nome do Comprador",
      "Identity":"12345678909",
      "IdentityType":"CPF",
      "Email":"comprador@braspag.com.br",
      "Birthdate":"1991-01-02",
      "Address":{  
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA",
        "District":"Alphaville"
    },
      "DeliveryAddress": {
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA",
        "District":"Alphaville"
    }
   },
   "Payment":{  
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
     "ServiceTaxAmount":0,
     "Currency":"BRL",
     "Country":"BRA",
     "Installments":1,
     "Interest":"ByMerchant",
     "Capture":true,
     "Authenticate":false,    
     "Recurrent": false,
     "SoftDescriptor":"Mensagem",
     "CreditCard":{  
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa",
         "SaveCard":"false"
     },
     "ExtraDataCollection":[{
         "Name":"NomeDoCampo",
         "Value":"ValorDoCampo"
     }]
   }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{  
   "MerchantOrderId":"2017051002",
   "Customer":{  
      "Name":"Nome do Comprador",
      "Identity":"12345678909",
      "IdentityType":"CPF",
      "Email":"comprador@braspag.com.br",
      "Birthdate":"1991-01-02",
      "Address":{  
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA",
       "District":"Alphaville"
    },
    "DeliveryAddress": {
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA",
         "District":"Alphaville"
    }
   },
   "Payment":{  
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
     "ServiceTaxAmount":0,
     "Currency":"BRL",
     "Country":"BRA",
     "Installments":1,
     "Interest":"ByMerchant",
     "Capture":true,
     "Authenticate":false,    
     "Recurrent": false,
     "SoftDescriptor":"Mensagem",
     "CreditCard":{  
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa",
         "SaveCard":"false"
     },
     "ExtraDataCollection":[{
         "Name":"NomeDoCampo",
         "Value":"ValorDoCampo"
     }]
   }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador
Customer.Identity Texto 14 Não Número do RG, CPF ou CNPJ do Cliente
Customer.IdentityType Texto 255 Não Tipo de documento de identificação do comprador (CPF ou CNPJ)
Customer.Email Texto 255 Não Email do comprador
Customer.Birthdate Date 10 Não Data de nascimento do Comprador no formato AAAA-MM-DD
Customer.Address.Street Texto 255 Não Endereço de contato do comprador
Customer.Address.Number Texto 15 Não Número endereço de contato do comprador
Customer.Address.Complement Texto 50 Não Complemento do endereço de contato do Comprador
Customer.Address.ZipCode Texto 9 Não CEP do endereço de contato do comprador
Customer.Address.City Texto 50 Não Cidade do endereço de contato do comprador
Customer.Address.State Texto 2 Não Estado do endereço de contato do comprador
Customer.Address.Country Texto 35 Não Pais do endereço de contato do comprador
Customer.Address.District Texto 50 Não Bairro do Comprador.
Customer.DeliveryAddress.Street Texto 255 Não Endereço do comprador
Customer.DeliveryAddress.Number Texto 15 Não Número do endereço de entrega do pedido
Customer.DeliveryAddress.Complement Texto 50 Não Complemento do endereço de entrega do pedido
Customer.DeliveryAddress.ZipCode Texto 9 Não CEP do endereço de entrega do pedido
Customer.DeliveryAddress.City Texto 50 Não Cidade do endereço de entrega do pedido
Customer.DeliveryAddress.State Texto 2 Não Estado do endereço de entrega do pedido
Customer.DeliveryAddress.Country Texto 35 Não Pais do endereço de entrega do pedido
Customer.DeliveryAddress.District Texto 50 Não Bairro do Comprador.
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.ServiceTaxAmount Número 15 Sim 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
Payment.Currency Texto 3 Não Moeda na qual o pagamento será feito (BRL / USD / MXN / COP / CLP / ARS / PEN / EUR / PYN / UYU / VEB / VEF / GBP)
Payment.Country Texto 3 Não País na qual o pagamento será feito
Payment.Installments Número 2 Sim Número de Parcelas
Payment.Interest Texto 10 Não Tipo de parcelamento - Loja (ByMerchant) ou Emissor (ByIssuer)
Payment.Capture Booleano Não (Default false) Booleano que indica se a autorização deve ser com captura automática (true) ou não (false). Deverá verificar junto à adquirente a disponibilidade desta funcionalidade
Payment.Authenticate Booleano Não (Default false) Booleano que indica se a transação deve ser autenticada (true) ou não (false). Deverá verificar junto à adquirente a disponibilidade desta funcionalidade
Payment.Recurrent Booleano Não (Default false) Booleano que indica se a transação é do tipo recorrente (true) ou não (false). Este com valor true não originará uma nova Recorrência, apenas permitirá a realização de uma transação sem a necessidade de envio do CVV. Somente para transações Cielo. Authenticate deve ser false quando Recurrent é true
Payment.SoftDescriptor Texto 13 Não Texto que será impresso na fatura do portador
Payment.ExtraDataCollection.Name Texto 50 Não Nome do campo que será gravado o Dado Extra
Payment.ExtraDataCollection.Value Texto 1024 Não Valor do campo que será gravado o Dado Extra
CreditCard.CardNumber Texto 16 Sim Número do Cartão do comprador
CreditCard.Holder Texto 25 Sim Nome do portador impresso no cartão
CreditCard.ExpirationDate Texto 7 Sim Data de validade impresso no cartão
CreditCard.SecurityCode Texto 4 Sim Código de segurança impresso no verso do cartão
CreditCard.Brand Texto 10 Sim Bandeira do cartão
CreditCard.SaveCard Booleano Não (Default false) Booleano que identifica se o cartão será salvo para gerar o token (CardToken)

Resposta

{
  "MerchantOrderId": "2017051002",
  "Customer": {
    "Name": "Nome do Comprador",
    "Identity": "12345678909",
    "IdentityType": "CPF",
    "Email": "comprador@braspag.com.br",
    "Birthdate": "1991-01-02",
    "Address": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA",
     "District":"Alphaville"
    },
    "DeliveryAddress": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA",
      "District":"Alphaville"
    }
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "ProofOfSale": "20170510053219433",
    "AcquirerTransactionId": "0510053219433",
    "AuthorizationCode": "936403",
    "SoftDescriptor": "Mensagem",
    "VelocityAnalysis": {
      "Id": "c374099e-c474-4916-9f5c-f2598fec2925",
      "ResultMessage": "Accept",
      "Score": 0
    },
    "PaymentId": "c374099e-c474-4916-9f5c-f2598fec2925",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-10 17:32:19",
    "CapturedAmount": 10000,
    "CapturedDate": "2017-05-10 17:32:19",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ExtraDataCollection": [
      {
        "Name": "NomeDoCampo",
        "Value": "ValorDoCampo"
      }
    ],
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 2,
    "ProviderReturnCode": "6",
    "ProviderReturnMessage": "Operation Successful",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/c374099e-c474-4916-9f5c-f2598fec2925"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/c374099e-c474-4916-9f5c-f2598fec2925/void"
      }
    ]
  }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
  "MerchantOrderId": "2017051002",
  "Customer": {
    "Name": "Nome do Comprador",
    "Identity": "12345678909",
    "IdentityType": "CPF",
    "Email": "comprador@braspag.com.br",
    "Birthdate": "1991-01-02",
    "Address": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA",
      "District":"Alphaville"
    },
    "DeliveryAddress": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA",
     "District":"Alphaville"
    }
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "ProofOfSale": "20170510053219433",
    "AcquirerTransactionId": "0510053219433",
    "AuthorizationCode": "936403",
    "SoftDescriptor": "Mensagem",
    "VelocityAnalysis": {
      "Id": "c374099e-c474-4916-9f5c-f2598fec2925",
      "ResultMessage": "Accept",
      "Score": 0
    },
    "PaymentId": "c374099e-c474-4916-9f5c-f2598fec2925",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-10 17:32:19",
    "CapturedAmount": 10000,
    "CapturedDate": "2017-05-10 17:32:19",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ExtraDataCollection": [
      {
        "Name": "NomeDoCampo",
        "Value": "ValorDoCampo"
      }
    ],
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 2,
    "ProviderReturnCode": "6",
    "ProviderReturnMessage": "Operation Successful",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/c374099e-c474-4916-9f5c-f2598fec2925"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/c374099e-c474-4916-9f5c-f2598fec2925/void"
      }
    ]
  }
}
Propriedade Descrição Tipo Tamanho Formato
AcquirerTransactionId Id da transação no provedor de meio de pagamento Texto 40 Texto alfanumérico
ProofOfSale Número do Comprovante de Venda Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização Texto 300 Texto alfanumérico
PaymentId Campo Identificador do Pedido Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ReceivedDate Data em que a transação foi recebida pela Brapag Texto 19 AAAA-MM-DD HH:mm:SS
CapturedDate Data em que a transação foi capturada a transação Texto 19 AAAA-MM-DD HH:mm:SS
CapturedAmount Valor capturado (sem pontuação) Número 15 100 equivale a R$ 1,00
ECI Eletronic Commerce Indicator. Representa o resultado da autenticação Texto 2 Exemplos: 5
ReasonCode Código de retorno da Operação Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da Operação Texto 512 Texto alfanumérico
Status Status da Transação Byte 2 Ex. 1
ProviderReturnCode Código retornado pelo provedor do meio de pagamento (adquirente e bancos) Texto 32 57
ProviderReturnMessage Mensagem retornada pelo provedor do meio de pagamento (adquirente e bancos) Texto 512 Transação Aprovada

Criando uma transação com credenciais/afiliação

Este é um exemplo de uma transação com as credenciais geradas pelas adquirentes/fornecedores informadas via requisição, as quais permitem o processamento da transação nas operadoras.

Requisição

{
    "MerchantOrderId": "2017051002",
    "Customer": {
        "Name": "Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Email": "comprador@braspag.com.br",
        "Birthdate": "1991-01-02",
        "Address": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        },
        "DeliveryAddress": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        }
    },
    "Payment": {
        "Provider": "Simulado",
        "Type": "CreditCard",
        "Amount": 10000,
        "Currency": "BRL",
        "Country": "BRA",
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "Authenticate": false,
        "Recurrent": false,
        "SoftDescriptor": "Mensagem",
        "CreditCard": {
            "CardNumber": "4551870000000181",
            "Holder": "Nome do Portador",
            "ExpirationDate": "12/2021",
            "SecurityCode": "123",
            "Brand": "Visa",
            "SaveCard": "false"
        },
        "credentials": {
            "code": "9999999",
            "key": "D8888888",
            "password": "LOJA9999999",
            "username": "#Braspag2018@NOMEDALOJA#",
            "signature": "001"
        },
        "ExtraDataCollection": [{
            "Name": "NomeDoCampo",
            "Value": "ValorDoCampo"
        }]
    }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "MerchantOrderId": "2017051002",
    "Customer": {
        "Name": "Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Email": "comprador@braspag.com.br",
        "Birthdate": "1991-01-02",
        "Address": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        },
        "DeliveryAddress": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        }
    },
    "Payment": {
        "Provider": "Simulado",
        "Type": "CreditCard",
        "Amount": 10000,
        "Currency": "BRL",
        "Country": "BRA",
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "Authenticate": false,
        "Recurrent": false,
        "SoftDescriptor": "Mensagem",
        "CreditCard": {
            "CardNumber": "4551870000000181",
            "Holder": "Nome do Portador",
            "ExpirationDate": "12/2021",
            "SecurityCode": "123",
            "Brand": "Visa",
            "SaveCard": "false"
        },
        "credentials": {
            "code": "9999999",
            "key": "D8888888",
            "password": "LOJA9999999",
            "username": "#Braspag2018@NOMEDALOJA#",
            "signature": "001"
        },
        "ExtraDataCollection": [{
            "Name": "NomeDoCampo",
            "Value": "ValorDoCampo"
        }]
    }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador
Customer.Identity Texto 14 Não Número do RG, CPF ou CNPJ do Cliente
Customer.IdentityType Texto 255 Não Tipo de documento de identificação do comprador (CPF ou CNPJ)
Customer.Email Texto 255 Não Email do comprador
Customer.Birthdate Date 10 Não Data de nascimento do Comprador no formato AAAA-MM-DD
Customer.Address.Street Texto 255 Não Endereço de contato do comprador
Customer.Address.Number Texto 15 Não Número endereço de contato do comprador
Customer.Address.Complement Texto 50 Não Complemento do endereço de contato do Comprador
Customer.Address.ZipCode Texto 9 Não CEP do endereço de contato do comprador
Customer.Address.City Texto 50 Não Cidade do endereço de contato do comprador
Customer.Address.State Texto 2 Não Estado do endereço de contato do comprador
Customer.Address.Country Texto 35 Não Pais do endereço de contato do comprador
Customer.Address.District Texto 50 Não Bairro do Comprador.
Customer.DeliveryAddress.Street Texto 255 Não Endereço do comprador
Customer.DeliveryAddress.Number Texto 15 Não Número do endereço de entrega do pedido
Customer.DeliveryAddress.Complement Texto 50 Não Complemento do endereço de entrega do pedido
Customer.DeliveryAddress.ZipCode Texto 9 Não CEP do endereço de entrega do pedido
Customer.DeliveryAddress.City Texto 50 Não Cidade do endereço de entrega do pedido
Customer.DeliveryAddress.State Texto 2 Não Estado do endereço de entrega do pedido
Customer.DeliveryAddress.Country Texto 35 Não Pais do endereço de entrega do pedido
Customer.DeliveryAddress.District Texto 50 Não Bairro do Comprador.
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.ServiceTaxAmount Número 15 Sim 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
Payment.Currency Texto 3 Não Moeda na qual o pagamento será feito (BRL / USD / MXN / COP / CLP / ARS / PEN / EUR / PYN / UYU / VEB / VEF / GBP)
Payment.Country Texto 3 Não País na qual o pagamento será feito
Payment.Installments Número 2 Sim Número de Parcelas
Payment.Interest Texto 10 Não Tipo de parcelamento - Loja (ByMerchant) ou Emissor (ByIssuer)
Payment.Capture Booleano Não (Default false) Booleano que indica se a autorização deve ser com captura automática (true) ou não (false). Deverá verificar junto à adquirente a disponibilidade desta funcionalidade
Payment.Authenticate Booleano Não (Default false) Booleano que indica se a transação deve ser autenticada (true) ou não (false). Deverá verificar junto à adquirente a disponibilidade desta funcionalidade
Payment.Recurrent Booleano Não (Default false) Booleano que indica se a transação é do tipo recorrente (true) ou não (false). Este com valor true não originará uma nova Recorrência, apenas permitirá a realização de uma transação sem a necessidade de envio do CVV. Somente para transações Cielo. Authenticate deve ser false quando Recurrent é true
Payment.SoftDescriptor Texto 13 Não Texto que será impresso na fatura do portador
Payment.ExtraDataCollection.Name Texto 50 Não Nome do campo que será gravado o Dado Extra
Payment.ExtraDataCollection.Value Texto 1024 Não Valor do campo que será gravado o Dado Extra
Payment.Credentials.Code Texto 100 Sim afiliação gerada pela adquirente
Payment.Credentials.Key Texto 100 Sim chave de afiliação/token gerado pela adquirente
Payment.Credentials.Username Texto 50 Não usuário gerado no credenciamento com a adquirente (provedores como Rede e Getnet utilizam usuário e senha nas comunicações, logo o campo deve obrigatoriamente ser enviado.)
Payment.Credentials.Password Texto 50 Não senha gerada no credenciamento com a adquirente (provedores como Rede e Getnet utilizam usuário e senha nas comunicações, logo o campo deve obrigatoriamente ser enviado.)
Payment.Credentials.Signature Texto 3 Não Enviar o TerminalID da adquirete Global Payments (aplicável para lojistas filiados a esta adquirente). Ex.: 001
CreditCard.CardNumber Texto 16 Sim Número do Cartão do comprador
CreditCard.Holder Texto 25 Sim Nome do portador impresso no cartão
CreditCard.ExpirationDate Texto 7 Sim Data de validade impresso no cartão
CreditCard.SecurityCode Texto 4 Sim Código de segurança impresso no verso do cartão
CreditCard.Brand Texto 10 Sim Bandeira do cartão
CreditCard.SaveCard Booleano Não (Default false) Booleano que identifica se o cartão será salvo para gerar o token (CardToken)

Resposta

{
    "MerchantOrderId": "2017051002",
    "Customer": {
        "Name": "Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Email": "comprador@braspag.com.br",
        "Birthdate": "1991-01-02",
        "Address": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        },
        "DeliveryAddress": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        }
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "Authenticate": false,
        "Recurrent": false,
        "CreditCard": {
            "CardNumber": "455187******0181",
            "Holder": "Nome do Portador",
            "ExpirationDate": "12/2021",
            "SaveCard": false,
            "Brand": "Visa"
        },
        "credentials": {
            "code": "9999999",
            "key": "D8888888",
            "password": "LOJA9999999",
            "username": "#Braspag2018@NOMEDALOJA#"
        },
        "ProofOfSale": "20170510053219433",
        "AcquirerTransactionId": "0510053219433",
        "AuthorizationCode": "936403",
        "SoftDescriptor": "Mensagem",
        "VelocityAnalysis": {
            "Id": "c374099e-c474-4916-9f5c-f2598fec2925",
            "ResultMessage": "Accept",
            "Score": 0
        },
        "PaymentId": "c374099e-c474-4916-9f5c-f2598fec2925",
        "Type": "CreditCard",
        "Amount": 10000,
        "ReceivedDate": "2017-05-10 17:32:19",
        "CapturedAmount": 10000,
        "CapturedDate": "2017-05-10 17:32:19",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Simulado",
        "ExtraDataCollection": [{
            "Name": "NomeDoCampo",
            "Value": "ValorDoCampo"
        }],
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "Status": 2,
        "ProviderReturnCode": "6",
        "ProviderReturnMessage": "Operation Successful",
        "Links": [{
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/c374099e-c474-4916-9f5c-f2598fec2925"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.braspag.com.br/v2/sales/c374099e-c474-4916-9f5c-f2598fec2925/void"
            }
        ]
    }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "MerchantOrderId": "2017051002",
    "Customer": {
        "Name": "Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Email": "comprador@braspag.com.br",
        "Birthdate": "1991-01-02",
        "Address": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        },
        "DeliveryAddress": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        }
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "Authenticate": false,
        "Recurrent": false,
        "CreditCard": {
            "CardNumber": "455187******0181",
            "Holder": "Nome do Portador",
            "ExpirationDate": "12/2021",
            "SaveCard": false,
            "Brand": "Visa"
        },
        "credentials": {
            "code": "9999999",
            "key": "D8888888",
            "password": "LOJA9999999",
            "username": "#Braspag2018@NOMEDALOJA#"
        },
        "ProofOfSale": "20170510053219433",
        "AcquirerTransactionId": "0510053219433",
        "AuthorizationCode": "936403",
        "SoftDescriptor": "Mensagem",
        "VelocityAnalysis": {
            "Id": "c374099e-c474-4916-9f5c-f2598fec2925",
            "ResultMessage": "Accept",
            "Score": 0
        },
        "PaymentId": "c374099e-c474-4916-9f5c-f2598fec2925",
        "Type": "CreditCard",
        "Amount": 10000,
        "ReceivedDate": "2017-05-10 17:32:19",
        "CapturedAmount": 10000,
        "CapturedDate": "2017-05-10 17:32:19",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Simulado",
        "ExtraDataCollection": [{
            "Name": "NomeDoCampo",
            "Value": "ValorDoCampo"
        }],
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "Status": 2,
        "ProviderReturnCode": "6",
        "ProviderReturnMessage": "Operation Successful",
        "Links": [{
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/c374099e-c474-4916-9f5c-f2598fec2925"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.braspag.com.br/v2/sales/c374099e-c474-4916-9f5c-f2598fec2925/void"
            }
        ]
    }
}
Propriedade Descrição Tipo Tamanho Formato
AcquirerTransactionId Id da transação no provedor de meio de pagamento Texto 40 Texto alfanumérico
ProofOfSale Número do Comprovante de Venda Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização Texto 300 Texto alfanumérico
PaymentId Campo Identificador do Pedido Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ReceivedDate Data em que a transação foi recebida pela Brapag Texto 19 AAAA-MM-DD HH:mm:SS
CapturedDate Data em que a transação foi capturada a transação Texto 19 AAAA-MM-DD HH:mm:SS
CapturedAmount Valor capturado (sem pontuação) Número 15 100 equivale a R$ 1,00
ECI Eletronic Commerce Indicator. Representa o resultado da autenticação Texto 2 Exemplos: 5
ReasonCode Código de retorno da Operação Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da Operação Texto 512 Texto alfanumérico
Status Status da Transação Byte 2 Ex. 1
ProviderReturnCode Código retornado pelo provedor do meio de pagamento (adquirente e bancos) Texto 32 57
ProviderReturnMessage Mensagem retornada pelo provedor do meio de pagamento (adquirente e bancos) Texto 512 Transação Aprovada

Criando uma transação com AVS

Este é um exemplo de uma transação com dados de AVS. O Sistema de Verificação de Endereço (AVS) valida se o endereço de fatura informado pelo comprador está de acordo com o endereço de fatura registrado na base de dados do emissor. As adquirentes que suportam o AVS são Cielo e Rede.

Requisição

{
    "MerchantOrderId": "2017051002",
    "Customer": {
        "Name": "Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Email": "comprador@braspag.com.br",
        "Birthdate": "1991-01-02",
        "Address": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        },
        "DeliveryAddress": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        }
    },
    "Payment": {
        "Provider": "Simulado",
        "Type": "CreditCard",
        "Amount": 10000,
        "ServiceTaxAmount": 0,
        "Currency": "BRL",
        "Country": "BRA",
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "Authenticate": false,
        "Recurrent": false,
        "SoftDescriptor": "Mensagem",
        "Avs": {
            "Cpf": "12345678912",
            "ZipCode": "04604007",
            "Street": "Av Marechal Camara",
            "Number": "3720",
            "Complement": "Bl 2 Apto 53",
            "District": "Centro"
        },
        "ExtraDataCollection": [{
            "Name": "NomeDoCampo",
            "Value": "ValorDoCampo"
        }]
    }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "MerchantOrderId": "2017051002",
    "Customer": {
        "Name": "Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Email": "comprador@braspag.com.br",
        "Birthdate": "1991-01-02",
        "Address": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        },
        "DeliveryAddress": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        }
    },
    "Payment": {
        "Provider": "Simulado",
        "Type": "CreditCard",
        "Amount": 10000,
        "ServiceTaxAmount": 0,
        "Currency": "BRL",
        "Country": "BRA",
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "Authenticate": false,
        "Recurrent": false,
        "SoftDescriptor": "Mensagem",
        "Avs": {
            "Cpf": "12345678912",
            "ZipCode": "04604007",
            "Street": "Av Marechal Camara",
            "Number": "3720",
            "Complement": "Bl 2 Apto 53",
            "District": "Centro"
        },
        "ExtraDataCollection": [{
            "Name": "NomeDoCampo",
            "Value": "ValorDoCampo"
        }]
    }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador
Customer.Identity Texto 14 Não Número do RG, CPF ou CNPJ do Cliente
Customer.IdentityType Texto 255 Não Tipo de documento de identificação do comprador (CPF ou CNPJ)
Customer.Email Texto 255 Não Email do comprador
Customer.Birthdate Date 10 Não Data de nascimento do Comprador no formato AAAA-MM-DD
Customer.Address.Street Texto 255 Não Endereço de contato do comprador
Customer.Address.Number Texto 15 Não Número endereço de contato do comprador
Customer.Address.Complement Texto 50 Não Complemento do endereço de contato do Comprador
Customer.Address.ZipCode Texto 9 Não CEP do endereço de contato do comprador
Customer.Address.City Texto 50 Não Cidade do endereço de contato do comprador
Customer.Address.State Texto 2 Não Estado do endereço de contato do comprador
Customer.Address.Country Texto 35 Não Pais do endereço de contato do comprador
Customer.Address.District Texto 50 Não Bairro do Comprador.
Customer.DeliveryAddress.Street Texto 255 Não Endereço do comprador
Customer.DeliveryAddress.Number Texto 15 Não Número do endereço de entrega do pedido
Customer.DeliveryAddress.Complement Texto 50 Não Complemento do endereço de entrega do pedido
Customer.DeliveryAddress.ZipCode Texto 9 Não CEP do endereço de entrega do pedido
Customer.DeliveryAddress.City Texto 50 Não Cidade do endereço de entrega do pedido
Customer.DeliveryAddress.State Texto 2 Não Estado do endereço de entrega do pedido
Customer.DeliveryAddress.Country Texto 35 Não Pais do endereço de entrega do pedido
Customer.DeliveryAddress.District Texto 50 Não Bairro do Comprador.
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.ServiceTaxAmount Número 15 Sim 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
Payment.Currency Texto 3 Não Moeda na qual o pagamento será feito (BRL / USD / MXN / COP / CLP / ARS / PEN / EUR / PYN / UYU / VEB / VEF / GBP)
Payment.Country Texto 3 Não País na qual o pagamento será feito
Payment.Installments Número 2 Sim Número de Parcelas
Payment.Interest Texto 10 Não Tipo de parcelamento - Loja (ByMerchant) ou Emissor (ByIssuer)
Payment.Capture Booleano Não (Default false) Booleano que indica se a autorização deve ser com captura automática (true) ou não (false). Deverá verificar junto à adquirente a disponibilidade desta funcionalidade
Payment.Authenticate Booleano Não (Default false) Booleano que indica se a transação deve ser autenticada (true) ou não (false). Deverá verificar junto à adquirente a disponibilidade desta funcionalidade
Payment.Recurrent Booleano Não (Default false) Booleano que indica se a transação é do tipo recorrente (true) ou não (false). Este com valor true não originará uma nova Recorrência, apenas permitirá a realização de uma transação sem a necessidade de envio do CVV. Somente para transações Cielo. Authenticate deve ser false quando Recurrent é true
Payment.SoftDescriptor Texto 13 Não Texto que será impresso na fatura do portador
Payment.ExtraDataCollection.Name Texto 50 Não Nome do campo que será gravado o Dado Extra
Payment.ExtraDataCollection.Value Texto 1024 Não Valor do campo que será gravado o Dado Extra
Payment.AVS.CPF Número 11 Sim CPF do portador do cartão (sem pontuação).
Payment.AVS.ZipCode Número 8 Sim CEP do endereço de fatura do portador (sem traço/hífen).
Payment.AVS.Street Texto 50 Sim Endereço de cobrança do portador.
Payment.AVS.Number Número 6 Sim Número da residência/endereço de cobrança do portador.
Payment.AVS.Complement Texto 30 Não Complemento do endereço de cobrança do portador.
Payment.AVS.District Texto 20 Sim Bairro do endereço de cobrança do portador.
CreditCard.CardNumber Texto 16 Sim Número do Cartão do comprador
CreditCard.Holder Texto 25 Sim Nome do portador impresso no cartão
CreditCard.ExpirationDate Texto 7 Sim Data de validade impresso no cartão
CreditCard.SecurityCode Texto 4 Sim Código de segurança impresso no verso do cartão
CreditCard.Brand Texto 10 Sim Bandeira do cartão
CreditCard.SaveCard Booleano Não (Default false) Booleano que identifica se o cartão será salvo para gerar o token (CardToken)

Resposta

{
    "MerchantOrderId": "2017051002",
    "Customer": {
        "Name": "Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Email": "comprador@braspag.com.br",
        "Birthdate": "1991-01-02",
        "Address": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        },
        "DeliveryAddress": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        }
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "Authenticate": false,
        "Recurrent": false,
        "Avs": {
            "Cpf": "12345678912",
            "ZipCode": "04604007",
            "Street": "Av Marechal Camara",
            "Number": "3720",
            "Complement": "Bl 2 Apto 53",
            "District": "Centro",
            "Status": 0,
            "ReturnCode": "W"
        }
        "ProofOfSale": "20170510053219433",
        "AcquirerTransactionId": "0510053219433",
        "AuthorizationCode": "936403",
        "SoftDescriptor": "Mensagem",
        "VelocityAnalysis": {
            "Id": "c374099e-c474-4916-9f5c-f2598fec2925",
            "ResultMessage": "Accept",
            "Score": 0
        },
        "PaymentId": "c374099e-c474-4916-9f5c-f2598fec2925",
        "Type": "CreditCard",
        "Amount": 10000,
        "ReceivedDate": "2017-05-10 17:32:19",
        "CapturedAmount": 10000,
        "CapturedDate": "2017-05-10 17:32:19",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Simulado",
        "ExtraDataCollection": [{
            "Name": "NomeDoCampo",
            "Value": "ValorDoCampo"
        }],
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "Status": 2,
        "ProviderReturnCode": "6",
        "ProviderReturnMessage": "Operation Successful",
        "Links": [{
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/c374099e-c474-4916-9f5c-f2598fec2925"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.braspag.com.br/v2/sales/c374099e-c474-4916-9f5c-f2598fec2925/void"
            }
        ]
    }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "MerchantOrderId": "2017051002",
    "Customer": {
        "Name": "Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Email": "comprador@braspag.com.br",
        "Birthdate": "1991-01-02",
        "Address": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        },
        "DeliveryAddress": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        }
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "Authenticate": false,
        "Recurrent": false,
        "Avs": {
            "Cpf": "12345678912",
            "ZipCode": "04604007",
            "Street": "Av Marechal Camara",
            "Number": "3720",
            "Complement": "Bl 2 Apto 53",
            "District": "Centro",
            "Status": 0,
            "ReturnCode": "W"
        }
        "ProofOfSale": "20170510053219433",
        "AcquirerTransactionId": "0510053219433",
        "AuthorizationCode": "936403",
        "SoftDescriptor": "Mensagem",
        "VelocityAnalysis": {
            "Id": "c374099e-c474-4916-9f5c-f2598fec2925",
            "ResultMessage": "Accept",
            "Score": 0
        },
        "PaymentId": "c374099e-c474-4916-9f5c-f2598fec2925",
        "Type": "CreditCard",
        "Amount": 10000,
        "ReceivedDate": "2017-05-10 17:32:19",
        "CapturedAmount": 10000,
        "CapturedDate": "2017-05-10 17:32:19",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Simulado",
        "ExtraDataCollection": [{
            "Name": "NomeDoCampo",
            "Value": "ValorDoCampo"
        }],
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "Status": 2,
        "ProviderReturnCode": "6",
        "ProviderReturnMessage": "Operation Successful",
        "Links": [{
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/c374099e-c474-4916-9f5c-f2598fec2925"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.braspag.com.br/v2/sales/c374099e-c474-4916-9f5c-f2598fec2925/void"
            }
        ]
    }
}
Propriedade Descrição Tipo Tamanho Formato
AcquirerTransactionId Id da transação no provedor de meio de pagamento Texto 40 Texto alfanumérico
ProofOfSale Número do Comprovante de Venda Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização Texto 300 Texto alfanumérico
PaymentId Campo Identificador do Pedido Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ReceivedDate Data em que a transação foi recebida pela Brapag Texto 19 AAAA-MM-DD HH:mm:SS
CapturedDate Data em que a transação foi capturada a transação Texto 19 AAAA-MM-DD HH:mm:SS
CapturedAmount Valor capturado (sem pontuação) Número 15 100 equivale a R$ 1,00
ECI Eletronic Commerce Indicator. Representa o resultado da autenticação Texto 2 Exemplos: 5
ReasonCode Código de retorno da Operação Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da Operação Texto 512 Texto alfanumérico
Status Status da Transação Byte 2 Ex. 1
ProviderReturnCode Código retornado pelo provedor do meio de pagamento (adquirente e bancos) Texto 32 57
ProviderReturnMessage Mensagem retornada pelo provedor do meio de pagamento (adquirente e bancos) Texto 512 Transação Aprovada
Payment.AVS.Status Status do resultado do AVS. Número 2 0 - Combinação exata
1 - CEP e CPF combinam
2 - Endereço e CPF combinam
3 - Endereço e CEP combinam
4 - CPF exato
5 - Endereço exato
6 - CEP exato
7 - Não suportado ou não verificado para esta bandeira
9 - Banco emissor com sistema indisponível
11 - Nada combina
12 - Nenhum dado fornecido
14 - Resposta inválida
Payment.AVS.ReturnCode Código de retorno do resultado do AVS. Texto 1 W - Todos os dados coincidem
X - O CEP e CPF coincidem, endereço não coincide
Z - Endereço e CPF coincidem, CEP não coincide
S - O CEP e endereço coincidem, CPF não coincide
A - CPF coincide, CEP e endereço não coincidem
U - O CEP e CPF não coincidem, endereço coincide
Y - O CEP coincide, CPF e endereço não coincidem
P - Não suportado ou não verificado
I - Banco emissor com sistema indisponível
N - Nada coincide
E - Dado(s) com formato(s) não suportado(s)
R - Resposta inválida

Criando uma transação com autenticação externa

Este é um exemplo de uma transação com dados de autenticação externa. Este fluxo é suportado pelas adquirentes Cielo, Global Payments e Banorte.

Requisição

{  
   "MerchantOrderId":"2017051002",
   "Customer":{  
      "Name":"Nome do Comprador",
      "Identity":"12345678909",
      "IdentityType":"CPF",
      "Email":"comprador@braspag.com.br",
      "Birthdate":"1991-01-02",
      "Address":{  
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA",
         "District":"Alphaville"
    },
     "DeliveryAddress": {
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA",
         "District":"Alphaville"
    }
   },
   "Payment":{  
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
     "ServiceTaxAmount":0,
     "Currency":"BRL",
     "Country":"BRA",
     "Installments":1,
     "Interest":"ByMerchant",
     "Capture":true,
     "Authenticate":false,    
     "Recurrent": false,
     "SoftDescriptor":"Mensagem",
     "CreditCard":{  
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa",
         "SaveCard":"false"
     },
     "ExternalAuthentication":{
       "Cavv":"AAABB2gHA1B5EFNjWQcDAAAAAAB=",
       "Xid":"Uk5ZanBHcWw2RjRCbEN5dGtiMTB=",
       "Eci":"5"
     },
     "ExtraDataCollection":[{
         "Name":"NomeDoCampo",
         "Value":"ValorDoCampo"
     }]
   }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{  
   "MerchantOrderId":"2017051002",
   "Customer":{  
      "Name":"Nome do Comprador",
      "Identity":"12345678909",
      "IdentityType":"CPF",
      "Email":"comprador@braspag.com.br",
      "Birthdate":"1991-01-02",
      "Address":{  
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA",
         "District":"Alphaville"
    },
     "DeliveryAddress": {
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA",
         "District":"Alphaville"
    }
   },
   "Payment":{  
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
     "ServiceTaxAmount":0,
     "Currency":"BRL",
     "Country":"BRA",
     "Installments":1,
     "Interest":"ByMerchant",
     "Capture":true,
     "Authenticate":false,    
     "Recurrent": false,
     "SoftDescriptor":"Mensagem",
     "CreditCard":{  
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa",
         "SaveCard":"false"
     },
     "ExternalAuthentication":{
       "Cavv":"AAABB2gHA1B5EFNjWQcDAAAAAAB=",
       "Xid":"Uk5ZanBHcWw2RjRCbEN5dGtiMTB=",
       "Eci":"5"
     },
     "ExtraDataCollection":[{
         "Name":"NomeDoCampo",
         "Value":"ValorDoCampo"
     }]
   }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador
Customer.Identity Texto 14 Não Número do RG, CPF ou CNPJ do Cliente
Customer.IdentityType Texto 255 Não Tipo de documento de identificação do comprador (CPF ou CNPJ)
Customer.Email Texto 255 Não Email do comprador
Customer.Birthdate Date 10 Não Data de nascimento do Comprador no formato AAAA-MM-DD
Customer.Address.Street Texto 255 Não Endereço de contato do comprador
Customer.Address.Number Texto 15 Não Número endereço de contato do comprador
Customer.Address.Complement Texto 50 Não Complemento do endereço de contato do Comprador
Customer.Address.ZipCode Texto 9 Não CEP do endereço de contato do comprador
Customer.Address.City Texto 50 Não Cidade do endereço de contato do comprador
Customer.Address.State Texto 2 Não Estado do endereço de contato do comprador
Customer.Address.Country Texto 35 Não Pais do endereço de contato do comprador
Customer.Address.District Texto 50 Não Bairro do Comprador.
Customer.DeliveryAddress.Street Texto 255 Não Endereço do comprador
Customer.DeliveryAddress.Number Texto 15 Não Número do endereço de entrega do pedido
Customer.DeliveryAddress.Complement Texto 50 Não Complemento do endereço de entrega do pedido
Customer.DeliveryAddress.ZipCode Texto 9 Não CEP do endereço de entrega do pedido
Customer.DeliveryAddress.City Texto 50 Não Cidade do endereço de entrega do pedido
Customer.DeliveryAddress.State Texto 2 Não Estado do endereço de entrega do pedido
Customer.DeliveryAddress.Country Texto 35 Não Pais do endereço de entrega do pedido
Customer.DeliveryAddress.District Texto 50 Não Bairro do Comprador.
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento. Suportado pelas adquirentes Cielo, Global Payments e Banorte
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.ServiceTaxAmount Número 15 Sim 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
Payment.Currency Texto 3 Não Moeda na qual o pagamento será feito (BRL / USD / MXN / COP / CLP / ARS / PEN / EUR / PYN / UYU / VEB / VEF / GBP)
Payment.Country Texto 3 Não País na qual o pagamento será feito
Payment.Installments Número 2 Sim Número de Parcelas
Payment.Interest Texto 10 Não Tipo de parcelamento - Loja (ByMerchant) ou Emissor (ByIssuer)
Payment.Capture Booleano Não (Default false) Booleano que indica se a autorização deve ser com captura automática (true) ou não (false). Deverá verificar junto à adquirente a disponibilidade desta funcionalidade
Payment.Authenticate Booleano Não (Default false) Booleano que indica se a transação deve ser autenticada (true) ou não (false). Para transações autenticadas externamente (fornecedor de autenticação de sua escolha), este campo deve ser enviado com valor “False”, e no nó ExternalAuthentication deve-se enviar os dados retornados pelo mecanismo de autenticação externa escolhido (XID, CAVV e ECI).
Payment.Recurrent Booleano Não (Default false) Booleano que indica se a transação é do tipo recorrente (true) ou não (false). Este com valor true não originará uma nova Recorrência, apenas permitirá a realização de uma transação sem a necessidade de envio do CVV. Somente para transações Cielo. Authenticate deve ser false quando Recurrent é true
Payment.SoftDescriptor Texto 13 Não Texto que será impresso na fatura do portador
Payment.ExternalAuthentication.Cavv Texto 28 Sim O valor Cavv é retornado pelo mecanismo de autenticação
Payment.ExternalAuthentication.Xid Texto 28 Sim O valor Xid é retornado pelo mecanismo de autenticação
Payment.ExternalAuthentication.Eci Número 1 Sim O valor Eci é retornado pelo mecanismo de autenticação
Payment.ExtraDataCollection.Name Texto 50 Não Nome do campo que será gravado o Dado Extra
Payment.ExtraDataCollection.Value Texto 1024 Não Valor do campo que será gravado o Dado Extra
CreditCard.CardNumber Texto 16 Sim Número do Cartão do comprador
CreditCard.Holder Texto 25 Sim Nome do portador impresso no cartão
CreditCard.ExpirationDate Texto 7 Sim Data de validade impresso no cartão
CreditCard.SecurityCode Texto 4 Sim Código de segurança impresso no verso do cartão
CreditCard.Brand Texto 10 Sim Bandeira do cartão
CreditCard.SaveCard Booleano Não (Default false) Booleano que identifica se o cartão será salvo para gerar o token (CardToken)

Resposta

{
  "MerchantOrderId": "2017051002",
  "Customer": {
    "Name": "Nome do Comprador",
    "Identity": "12345678909",
    "IdentityType": "CPF",
    "Email": "comprador@braspag.com.br",
    "Birthdate": "1991-01-02",
    "Address": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA",
      "District":"Alphaville"
    },
    "DeliveryAddress": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA",
      "District":"Alphaville"
    }
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "ProofOfSale": "20170510053219433",
    "AcquirerTransactionId": "0510053219433",
    "AuthorizationCode": "936403",
    "SoftDescriptor": "Mensagem",
    "VelocityAnalysis": {
      "Id": "c374099e-c474-4916-9f5c-f2598fec2925",
      "ResultMessage": "Accept",
      "Score": 0
    },
    "PaymentId": "c374099e-c474-4916-9f5c-f2598fec2925",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-10 17:32:19",
    "CapturedAmount": 10000,
    "CapturedDate": "2017-05-10 17:32:19",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ExternalAuthentication":{
       "Cavv":"AAABB2gHA1B5EFNjWQcDAAAAAAB=",
       "Xid":"Uk5ZanBHcWw2RjRCbEN5dGtiMTB=",
       "Eci":"5",
     },
    "ExtraDataCollection": [
      {
        "Name": "NomeDoCampo",
        "Value": "ValorDoCampo"
      }
    ],
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 2,
    "ProviderReturnCode": "6",
    "ProviderReturnMessage": "Operation Successful",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/c374099e-c474-4916-9f5c-f2598fec2925"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/c374099e-c474-4916-9f5c-f2598fec2925/void"
      }
    ]
  }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
  "MerchantOrderId": "2017051002",
  "Customer": {
    "Name": "Nome do Comprador",
    "Identity": "12345678909",
    "IdentityType": "CPF",
    "Email": "comprador@braspag.com.br",
    "Birthdate": "1991-01-02",
    "Address": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA",
      "District":"Alphaville"
    },
    "DeliveryAddress": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA",
      "District":"Alphaville"
    }
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "ProofOfSale": "20170510053219433",
    "AcquirerTransactionId": "0510053219433",
    "AuthorizationCode": "936403",
    "SoftDescriptor": "Mensagem",
    "VelocityAnalysis": {
      "Id": "c374099e-c474-4916-9f5c-f2598fec2925",
      "ResultMessage": "Accept",
      "Score": 0
    },
    "PaymentId": "c374099e-c474-4916-9f5c-f2598fec2925",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-10 17:32:19",
    "CapturedAmount": 10000,
    "CapturedDate": "2017-05-10 17:32:19",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ExternalAuthentication":{
       "Cavv":"AAABB2gHA1B5EFNjWQcDAAAAAAB=",
       "Xid":"Uk5ZanBHcWw2RjRCbEN5dGtiMTB=",
       "Eci":"5",
     },
    "ExtraDataCollection": [
      {
        "Name": "NomeDoCampo",
        "Value": "ValorDoCampo"
      }
    ],
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 2,
    "ProviderReturnCode": "6",
    "ProviderReturnMessage": "Operation Successful",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/c374099e-c474-4916-9f5c-f2598fec2925"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/c374099e-c474-4916-9f5c-f2598fec2925/void"
      }
    ]
  }
}
Propriedade Descrição Tipo Tamanho Formato
AcquirerTransactionId Id da transação no provedor de meio de pagamento Texto 40 Texto alfanumérico
ProofOfSale Número do Comprovante de Venda Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização Texto 300 Texto alfanumérico
PaymentId Campo Identificador do Pedido Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ReceivedDate Data em que a transação foi recebida pela Brapag Texto 19 AAAA-MM-DD HH:mm:SS
CapturedDate Data em que a transação foi capturada a transação Texto 19 AAAA-MM-DD HH:mm:SS
CapturedAmount Valor capturado (sem pontuação) Número 15 100 equivale a R$ 1,00
ECI Eletronic Commerce Indicator. Representa o resultado da autenticação Texto 2 Exemplos: 5
ReasonCode Código de retorno da Operação Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da Operação Texto 512 Texto alfanumérico
Status Status da Transação Byte 2 Ex. 1
ProviderReturnCode Código retornado pelo provedor do meio de pagamento (adquirente e bancos) Texto 32 57
ProviderReturnMessage Mensagem retornada pelo provedor do meio de pagamento (adquirente e bancos) Texto 512 Transação Aprovada

Criando uma transação com Autenticação

Quando uma transação é submetida ao processo de autenticação, o portador será redirecionado ao ambiente do emissor, onde deverá realizar a confirmação de seus dados. Quando validado corretamente, o “liability” da transação passa a ser do banco, ou seja, em casos de contestação, o banco será o responsável.

Requisição

{  
   "MerchantOrderId":"2017051101",
   "Customer":{  
      "Name":"Nome do Comprador"
   },
   "Payment":{  
      "Provider":"Cielo",
      "Type":"CreditCard",
      "Amount":10000,
      "Capture":true,
      "Installments":1,
      "Authenticate":true,
      "ReturnUrl":"http://www.braspag.com.br",
      "CreditCard":{  
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2015",
         "SecurityCode":"123",
         "Brand":"Visa"
      }
   }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{  
   "MerchantOrderId":"2017051101",
   "Customer":{  
      "Name":"Nome do Comprador"
   },
   "Payment":{  
      "Provider":"Cielo",
      "Type":"CreditCard",
      "Amount":10000,
      "Capture":true,    
      "Installments":1,
      "Authenticate":true,
      "ReturnUrl":"http://www.braspag.com.br",
      "CreditCard":{  
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2015",
         "SecurityCode":"123",
         "Brand":"Visa"
      }
   }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.Installments Número 2 Sim Número de Parcelas
Payment.Authenticate Booleano Não (Default false) Define se o comprador será direcionado ao Banco emissor para autenticação do cartão. Para transaçõe autenticadas, neste campo, deve-se enviar o valor “True”. *Deverá verificar junto à adquirente a disponibilidade desta funcionalidade
Payment.ReturnUrl Texto 1024 Sim (quando Autenticate é true) URL para onde o usuário será redirecionado após o fim da autenticação
CreditCard.CardNumber Texto 16 Sim Número do Cartão do comprador
CreditCard.Holder Texto 25 Sim Nome do Comprador impresso no cartão
CreditCard.ExpirationDate Texto 7 Sim Data de validade impresso no cartão, no formato MM/AAAA
CreditCard.SecurityCode Texto 4 Sim Código de segurança impresso no verso do cartão
CreditCard.Brand Texto 10 Sim Bandeira do cartão

Resposta

{
  "MerchantOrderId": "2017051101",
  "Customer": {
    "Name": "Nome do Comprador"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": true,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2015",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "AuthenticationUrl": "https://qasecommerce.cielo.com.br/web/index.cbmp?id=9e61c78c0b0ca3e5db41fa7e31585eab",
    "AcquirerTransactionId": "10069930690009D2A47A",
    "ReturnUrl": "http://www.braspag.com.br",
    "PaymentId": "b125109f-681b-4338-8450-f3e38bc71b32",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 11:09:49",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Cielo",
    "ReasonCode": 9,
    "ReasonMessage": "Waiting",
    "Status": 0,
    "ProviderReturnCode": "0",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/b125109f-681b-4338-8450-f3e38bc71b32"
      }
    ]
  }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
  "MerchantOrderId": "2017051101",
  "Customer": {
    "Name": "Nome do Comprador"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": true,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2015",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "AuthenticationUrl": "https://qasecommerce.cielo.com.br/web/index.cbmp?id=9e61c78c0b0ca3e5db41fa7e31585eab",
    "AcquirerTransactionId": "10069930690009D2A47A",
    "ReturnUrl": "http://www.braspag.com.br",
    "PaymentId": "b125109f-681b-4338-8450-f3e38bc71b32",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 11:09:49",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Cielo",
    "ReasonCode": 9,
    "ReasonMessage": "Waiting",
    "Status": 0,
    "ProviderReturnCode": "0",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/b125109f-681b-4338-8450-f3e38bc71b32"
      }
    ]
  }
}
Propriedade Descrição Tipo Tamanho Formato
AcquirerTransactionId Id da transação no provedor de meio de pagamento Texto 40 Texto alfanumérico
ProofOfSale Número do Comprovante de Venda Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização Texto 300 Texto alfanumérico
PaymentId Campo Identificador do Pedido Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ReceivedDate Data em que a transação foi recebida pela Brapag Texto 19 AAAA-MM-DD HH:mm:SS
ReasonCode Código de retorno da Operação Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da Operação Texto 512 Texto alfanumérico
Status Status da Transação Byte 2 Ex. 1
ProviderReturnCode Código retornado pelo provedor do meio de pagamento (adquirente e bancos) Texto 32 57
ProviderReturnMessage Mensagem retornada pelo provedor do meio de pagamento (adquirente e bancos) Texto 512 Transação Aprovada
AuthenticationUrl URL para qual o Lojista deve redirecionar o Cliente para o fluxo de autenticação Texto 256 https://qasecommerce.cielo.com.br/web/index.cbmp?id=5f177203bf524c78982ad28f7ece5f08

Criando uma transação que salva o cartão

Caso você tenha contratado o Cartão Protegido, é possível salvar um cartão no formato de um Token, para substituir os dados do cartão numa próxima transação do mesmo comprador. É importante ressaltar que por questões de segurança, o CVV (Código de Segurança) não é tokenizado.

Requisição

{
   "MerchantOrderId":"2017051104",
   "Customer":{
      "Name":"Nome do Cliente"
   },
   "Payment":{
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
     "Capture":true,
     "Installments":1,
     "CreditCard":{
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa",
         "SaveCard":true,
         "Alias": "Cliente1"
     }
   }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
   "MerchantOrderId":"2017051104",
   "Customer":{
      "Name":"Nome do Cliente"
   },
   "Payment":{
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
     "Capture":true,
     "Installments":1,
     "CreditCard":{
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa",
         "SaveCard":true,
         "Alias": "Cliente1"
     }
   }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.Installments Número 2 Sim Número de Parcelas
CreditCard.CardNumber Texto 16 Sim Número do Cartão do comprador
CreditCard.Holder Texto 25 Sim Nome do Comprador impresso no cartão
CreditCard.ExpirationDate Texto 7 Sim Data de validade impresso no cartão, no formato MM/AAAA
CreditCard.SecurityCode Texto 4 Sim Código de segurança impresso no verso do cartão
CreditCard.Brand Texto 10 Sim Bandeira do cartão
CreditCard.SaveCard Booleano 10 Não true se salva o cartão e false para não salvar
CreditCard.Alias Texto 64 Não Alias (Apelido) do cartão de crédito

Resposta

{
  "MerchantOrderId": "2017051104",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": true,
      "CardToken": "250e7c7c-5501-4a7c-aa42-a33d7ad61167",
      "Brand": "Visa",
      "Alias": "Cliente1"
    },
    "ProofOfSale": "3519928",
    "AcquirerTransactionId": "0511023519928",
    "AuthorizationCode": "536934",
    "PaymentId": "3af00b2d-dbd0-42d6-a669-d4937f0881da",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 14:35:19",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "ProviderReturnCode": "4",
    "ProviderReturnMessage": "Operation Successful",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/3af00b2d-dbd0-42d6-a669-d4937f0881da"
      },
      {
        "Method": "PUT",
        "Rel": "capture",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/3af00b2d-dbd0-42d6-a669-d4937f0881da/capture"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/3af00b2d-dbd0-42d6-a669-d4937f0881da/void"
      }
    ]
  }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
  "MerchantOrderId": "2017051104",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": true,
      "CardToken": "250e7c7c-5501-4a7c-aa42-a33d7ad61167",
      "Brand": "Visa",
      "Alias": "Cliente1"
    },
    "ProofOfSale": "3519928",
    "AcquirerTransactionId": "0511023519928",
    "AuthorizationCode": "536934",
    "PaymentId": "3af00b2d-dbd0-42d6-a669-d4937f0881da",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 14:35:19",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "ProviderReturnCode": "4",
    "ProviderReturnMessage": "Operation Successful",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/3af00b2d-dbd0-42d6-a669-d4937f0881da"
      },
      {
        "Method": "PUT",
        "Rel": "capture",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/3af00b2d-dbd0-42d6-a669-d4937f0881da/capture"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/3af00b2d-dbd0-42d6-a669-d4937f0881da/void"
      }
    ]
  }
}
--verbose
Propriedade Descrição Tipo Tamanho Formato
AcquirerTransactionId Id da transação no provedor de meio de pagamento Texto 40 Texto alfanumérico
ProofOfSale Número do Comprovante de Venda Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização Texto 300 Texto alfanumérico
PaymentId Campo Identificador do Pedido Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ReceivedDate Data em que a transação foi recebida pela Brapag Texto 19 AAAA-MM-DD HH:mm:SS
ReasonCode Código de retorno da Operação Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da Operação Texto 512 Texto alfanumérico
Status Status da Transação Byte 2 Ex. 1
ProviderReturnCode Código retornado pelo provedor do meio de pagamento (adquirente e bancos) Texto 32 57
ProviderReturnMessage Mensagem retornada pelo provedor do meio de pagamento (adquirente e bancos) Texto 512 Transação Aprovada
CreditCard.CardToken Token no Cartão Protegido que representa os dados do cartão Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Criando uma transação com Card Token

Este é um exemplo de como utilizar o Card Token, previamente salvo, para criar uma transação. Por questão de segurança, um Card Token não tem guardado o Código de Segurança. Desta forma, é preciso solicitar esta informação ao portador para cada nova transação (exceto em casos de transações recorrentes).

Requisição

{
   "MerchantOrderId":"2017051105",
   "Customer":{
      "Name":"Nome do Cliente"
   },
   "Payment":{
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
     "Capture":true,
     "Installments":1,
     "CreditCard":{
         "CardToken":"250e7c7c-5501-4a7c-aa42-a33d7ad61167",
         "SecurityCode":"123",
         "Brand":"Visa"
     }
   }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
   "MerchantOrderId":"2017051105",
   "Customer":{
      "Name":"Nome do Cliente"
   },
   "Payment":{
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
     "Capture":true,
     "Installments":1,
     "CreditCard":{
         "CardToken":"250e7c7c-5501-4a7c-aa42-a33d7ad61167",
         "SecurityCode":"123",
         "Brand":"Visa"
     }
   }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.Installments Número 2 Sim Número de Parcelas
CreditCard.CardToken Token no Cartão Protegido que representa os dados do cartão Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CreditCard.SecurityCode Texto 4 Não Código de segurança impresso no verso do cartão. Para processar vendar sem o CVV, é necessário solicitar liberação na adquirente.
CreditCard.Brand Texto 10 Sim Bandeira do cartão

Resposta

{
  "MerchantOrderId": "2017051105",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "SaveCard": false,
      "CardToken": "250e7c7c-5501-4a7c-aa42-a33d7ad61167",
      "Brand": "Visa"
    },
    "ProofOfSale": "124305",
    "AcquirerTransactionId": "0511030124305",
    "AuthorizationCode": "065964",
    "PaymentId": "23cd8bf5-2251-4991-9042-533ff5608788",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 15:01:24",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "ProviderReturnCode": "4",
    "ProviderReturnMessage": "Operation Successful",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/23cd8bf5-2251-4991-9042-533ff5608788"
      },
      {
        "Method": "PUT",
        "Rel": "capture",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/23cd8bf5-2251-4991-9042-533ff5608788/capture"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/23cd8bf5-2251-4991-9042-533ff5608788/void"
      }
    ]
  }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
  "MerchantOrderId": "2017051105",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "SaveCard": false,
      "CardToken": "250e7c7c-5501-4a7c-aa42-a33d7ad61167",
      "Brand": "Visa"
    },
    "ProofOfSale": "124305",
    "AcquirerTransactionId": "0511030124305",
    "AuthorizationCode": "065964",
    "PaymentId": "23cd8bf5-2251-4991-9042-533ff5608788",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 15:01:24",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "ProviderReturnCode": "4",
    "ProviderReturnMessage": "Operation Successful",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/23cd8bf5-2251-4991-9042-533ff5608788"
      },
      {
        "Method": "PUT",
        "Rel": "capture",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/23cd8bf5-2251-4991-9042-533ff5608788/capture"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/23cd8bf5-2251-4991-9042-533ff5608788/void"
      }
    ]
  }
}
Propriedade Descrição Tipo Tamanho Formato
AcquirerTransactionId Id da transação no provedor de meio de pagamento Texto 40 Texto alfanumérico
ProofOfSale Número do Comprovante de Venda Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização Texto 300 Texto alfanumérico
PaymentId Campo Identificador do Pedido Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ReceivedDate Data em que a transação foi recebida pela Brapag Texto 19 AAAA-MM-DD HH:mm:SS
ReasonCode Código de retorno da Operação Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da Operação Texto 512 Texto alfanumérico
Status Status da Transação Byte 2 Ex. 1
ProviderReturnCode Código retornado pelo provedor do meio de pagamento (adquirente e bancos) Texto 32 57
ProviderReturnMessage Mensagem retornada pelo provedor do meio de pagamento (adquirente e bancos) Texto 512 Transação Aprovada

Criando uma transação com Alias

Este é um exemplo de como utilizar o Alias, previamente salvo, para criar uma transação. Por questão de segurança, um Alias não tem guardado o Código de Segurança. Desta forma, é preciso solicitar esta informação ao portador para cada nova transação (exceto em casos de transações recorrentes).

Requisição

{
   "MerchantOrderId":"2017051105",
   "Customer":{
      "Name":"Nome do Cliente"
   },
   "Payment":{
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
     "Capture":true,
     "Installments":1,
     "CreditCard":{
         "Alias":"Cliente1",
         "SecurityCode":"123",
         "Brand":"Visa"
     }
   }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
   "MerchantOrderId":"2017051105",
   "Customer":{
      "Name":"Nome do Cliente"
   },
   "Payment":{
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
   "Capture":true,
     "Installments":1,
     "CreditCard":{
         "Alias":"Cliente1",
         "SecurityCode":"123",
         "Brand":"Visa"
     }
   }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.Installments Número 2 Sim Número de Parcelas
CreditCard.CardToken Token no Cartão Protegido que representa os dados do cartão Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CreditCard.SecurityCode Texto 4 Não Código de segurança impresso no verso do cartão. Para processar vendar sem o CVV, é necessário solicitar liberação na adquirente.
CreditCard.Brand Texto 10 Sim Bandeira do cartão
CreditCard.Alias Texto 64 Não Alias (Apelido) do cartão de crédito

Resposta

{
  "MerchantOrderId": "2017051105",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "SaveCard": false,
      "Alias":"Cliente1",
      "Brand": "Visa"
    },
    "ProofOfSale": "124305",
    "AcquirerTransactionId": "0511030124305",
    "AuthorizationCode": "065964",
    "PaymentId": "23cd8bf5-2251-4991-9042-533ff5608788",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 15:01:24",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "ProviderReturnCode": "4",
    "ProviderReturnMessage": "Operation Successful",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/23cd8bf5-2251-4991-9042-533ff5608788"
      },
      {
        "Method": "PUT",
        "Rel": "capture",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/23cd8bf5-2251-4991-9042-533ff5608788/capture"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/23cd8bf5-2251-4991-9042-533ff5608788/void"
      }
    ]
  }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
  "MerchantOrderId": "2017051105",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "SaveCard": false,
      "Alias":"Cliente1",
      "Brand": "Visa"
    },
    "ProofOfSale": "124305",
    "AcquirerTransactionId": "0511030124305",
    "AuthorizationCode": "065964",
    "PaymentId": "23cd8bf5-2251-4991-9042-533ff5608788",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 15:01:24",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "ProviderReturnCode": "4",
    "ProviderReturnMessage": "Operation Successful",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/23cd8bf5-2251-4991-9042-533ff5608788"
      },
      {
        "Method": "PUT",
        "Rel": "capture",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/23cd8bf5-2251-4991-9042-533ff5608788/capture"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/23cd8bf5-2251-4991-9042-533ff5608788/void"
      }
    ]
  }
}
Propriedade Descrição Tipo Tamanho Formato
AcquirerTransactionId Id da transação no provedor de meio de pagamento Texto 40 Texto alfanumérico
ProofOfSale Número do Comprovante de Venda Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização Texto 300 Texto alfanumérico
PaymentId Campo Identificador do Pedido Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ReceivedDate Data em que a transação foi recebida pela Brapag Texto 19 AAAA-MM-DD HH:mm:SS
ReasonCode Código de retorno da Operação Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da Operação Texto 512 Texto alfanumérico
Status Status da Transação Byte 2 Ex. 1
ProviderReturnCode Código retornado pelo provedor do meio de pagamento (adquirente e bancos) Texto 32 57
ProviderReturnMessage Mensagem retornada pelo provedor do meio de pagamento (adquirente e bancos) Texto 512 Transação Aprovada

Capturando uma transação

Uma transação pré-autorizada necessita de uma operação de “Captura” para confirmar a transação. Segue o exemplo.

Requisição

curl
--request PUT "https://apisandbox.braspag.com.br/v2/sales/{PaymentId}/capture?amount=xxx&serviceTaxAmount=xxx"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--verbose
Propriedade Descrição Tipo Tamanho Obrigatório
MerchantId Identificador da loja na API. Guid 36 Sim
MerchantKey Chave Publica para Autenticação Dupla na API. Texto 40 Sim
RequestId Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT Guid 36 Não
PaymentId Campo Identificador do Pedido. Guid 36 Sim
Amount Valor a ser capturado (em centavos). Verificar se a adquirente utilizada suporta uma captura parcial Número 15 Não
ServiceTaxAmount Aplicável para companhias aéreas. Montante do valor da autorização que deve ser destinado à taxa de serviço. Obs.: Esse valor não é adicionado ao valor da autorização. Número 15 Não

Resposta

{
    "Status": 2,
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "ProviderReasonCode": "6",
    "ProviderReasonMessage": "Operation Successful",
    "Links": [
        {
            "Method": "GET",
            "Rel": "self",
            "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/{PaymentId}"
        },
        {
            "Method": "PUT",
            "Rel": "void",
            "Href": "https://apisandbox.braspag.com.br/v2/sales/{PaymentId}/void"
        }
    ]
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "Status": 2,
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "ProviderReasonCode": "6",
    "ProviderReasonMessage": "Operation Successful",
    "Links": [
        {
            "Method": "GET",
            "Rel": "self",
            "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/{PaymentId}"
        },
        {
            "Method": "PUT",
            "Rel": "void",
            "Href": "https://apisandbox.braspag.com.br/v2/sales/{PaymentId}/void"
        }
    ]
}
Propriedade Descrição Tipo Tamanho Formato
Status Status da Transação. Byte 2 Ex. 1
ReasonCode Código de retorno da adquirente. Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da adquirente. Texto 512 Texto alfanumérico

Cancelando/Estornando uma transação

Para cancelar uma transação que utilizou cartão de crédito, é necessário fazer um PUT para o recurso Payment conforme o exemplo.

Requisição

curl
--request PUT "https://apisandbox.braspag.com.br/v2/sales/{PaymentId}/void?amount=xxx"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--verbose
Propriedade Descrição Tipo Tamanho Obrigatório
MerchantId Identificador da loja na API. Guid 36 Sim
MerchantKey Chave Publica para Autenticação Dupla na API. Texto 40 Sim
RequestId Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT Guid 36 Não
PaymentId Campo Identificador do Pedido. Guid 36 Sim
Amount Valor a ser cancelado/estornado (ser enviado em centavos). Verifique se a adquirente contratada suporta a operação de cancelamento ou estorno Número 15 Não

Resposta

{
    "Status": 10,
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "ProviderReasonCode": "9",
    "ProviderReasonMessage": "Operation Successful",
    "Links": [
        {
            "Method": "GET",
            "Rel": "self",
            "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/{PaymentId}"
        }
    ]
}
{
    "Status": 10,
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "ProviderReasonCode": "9",
    "ProviderReasonMessage": "Operation Successful",
    "Links": [
        {
            "Method": "GET",
            "Rel": "self",
            "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/{PaymentId}"
        }
    ]
}
Propriedade Descrição Tipo Tamanho Formato
Status Status da Transação. Byte 2 Ex. 1
ReasonCode Código de retorno da Adquirência. Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da Adquirência. Texto 512 Texto alfanumérico

Transação com Velocity Check

O Velocity Check é um tipo de mecanismo de prevenção às tentativas de fraude, que analisa especificamente o conceito de “velocidade”. Ele analisa a frequência de elementos de rastreabilidade tais como Número do Cartão, CPF, CEP de entrega, entre outros. A funcionalidade deve ser contratada à parte, e posteriormente habilitada em sua loja. Quando o Velocity está ativo, a resposta da transação trará um nó específico chamado “Velocity”, com os datalhes da análise.

No caso da rejeição pela regra de Velocity, o ProviderReasonCode será BP171 - Rejected by fraud risk (velocity, com ReasonCode 16 - AbortedByFraud

Requisição

{
   "MerchantOrderId":"2017051202",
   "Customer":{
      "Name":"Nome do Comprador",
      "Identity":"12345678909",
      "IdentityType":"CPF",
      "Email":"comprador@braspag.com.br",
      "IpAdress":"127.0.01",
      "Address":{  
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA"
      },
      "DeliveryAddress": {
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA"
         }
   },
   "Payment":{
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
     "Capture":true,
     "Installments":1,
     "CreditCard":{
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2027",
         "SecurityCode":"123",
         "Brand":"Visa"
     }
   }
}
curl
--request PUT "https://apisandbox.braspag.com.br/v2/sales/{PaymentId}/void?amount=xxx"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
{
   "MerchantOrderId":"2017051202",
   "Customer":{
      "Name":"Nome do Comprador",
      "Identity":"12345678909",
      "IdentityType":"CPF",
      "Email":"comprador@braspag.com.br",
      "IpAdress":"127.0.01",
      "Address":{  
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA"
      },
      "DeliveryAddress": {
         "Street":"Alameda Xingu",
         "Number":"512",
         "Complement":"27 andar",
         "ZipCode":"12345987",
         "City":"São Paulo",
         "State":"SP",
         "Country":"BRA"
         }
   },
   "Payment":{
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
     "Capture":true,
     "Installments":1,
     "CreditCard":{
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2027",
         "SecurityCode":"123",
         "Brand":"Visa"
     }
   }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador
Customer.Identity Texto 14 Sim Número do RG, CPF ou CNPJ do Cliente
Customer.IdentityType Texto 255 Sim Tipo de documento de identificação do comprador (CPF ou CNPJ)
Customer.Email Texto 255 Sim Email do comprador
Customer.IpAddress Texto 255 Sim Ip do comprador
Customer.Address.Street Texto 255 Não Endereço de contato do comprador
Customer.Address.Number Texto 15 Não Número endereço de contato do comprador
Customer.Address.Complement Texto 50 Não Complemento do endereço de contato do Comprador
Customer.Address.ZipCode Texto 9 Sim CEP do endereço de contato do comprador
Customer.Address.City Texto 50 Não Cidade do endereço de contato do comprador
Customer.Address.State Texto 2 Não Estado do endereço de contato do comprador
Customer.Address.Country Texto 35 Não Pais do endereço de contato do comprador
Customer.Address.District Texto 50 Não Bairro do Comprador.
Customer.DeliveryAddress.Street Texto 255 Não Endereço do comprador
Customer.DeliveryAddress.Number Texto 15 Não Número do endereço de entrega do pedido
Customer.DeliveryAddress.Complement Texto 50 Não Complemento do endereço de entrega do pedido
Customer.DeliveryAddress.ZipCode Texto 9 Sim CEP do endereço de entrega do pedido
Customer.DeliveryAddress.City Texto 50 Não Cidade do endereço de entrega do pedido
Customer.DeliveryAddress.State Texto 2 Não Estado do endereço de entrega do pedido
Customer.DeliveryAddress.Country Texto 35 Não Pais do endereço de entrega do pedido
Customer.DeliveryAddress.District Texto 50 Não Bairro do Comprador.
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.Installments Número 2 Sim Número de Parcelas
CreditCard.CardNumber Texto 16 Sim Número do Cartão do comprador
CreditCard.Holder Texto 25 Sim Nome do Comprador impresso no cartão
CreditCard.ExpirationDate Texto 7 Sim Data de validade impresso no cartão, no formato MM/AAAA
CreditCard.SecurityCode Texto 4 Sim Código de segurança impresso no verso do cartão
CreditCard.Brand Texto 10 Sim Bandeira do cartão

Resposta

{
  "MerchantOrderId": "2017051202",
  "Customer": {
    "Name": "Nome do Comprador",
    "Identity": "12345678909",
    "IdentityType": "CPF",
    "Email": "comprador@braspag.com.br",
    "Address": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA"
    },
    "DeliveryAddress": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA"
    }
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2027",
      "SaveCard": false,
      "Brand": "Undefined"
    },
    "VelocityAnalysis": {
      "Id": "2d5e0463-47be-4964-b8ac-622a16a2b6c4",
      "ResultMessage": "Reject",
      "Score": 100,
      "RejectReasons": [
        {
          "RuleId": 49,
          "Message": "Bloqueado pela regra CardNumber. Name: Máximo de 3 Hits de Cartão em 1 dia. HitsQuantity: 3. HitsTimeRangeInSeconds: 1440. ExpirationBlockTimeInSeconds: 1440"
        }
      ]
    },
    "PaymentId": "2d5e0463-47be-4964-b8ac-622a16a2b6c4",
    "Type": "CreditCard",
    "Amount": 10000,
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 16,
    "ReasonMessage": "AbortedByFraud",
    "Status": 0,
    "ProviderReturnCode": "BP171",
    "ProviderReturnMessage": "Rejected by fraud risk (velocity)",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/2d5e0463-47be-4964-b8ac-622a16a2b6c4"
      }
    ]
  }
}
{
  "MerchantOrderId": "2017051202",
  "Customer": {
    "Name": "Nome do Comprador",
    "Identity": "12345678909",
    "IdentityType": "CPF",
    "Email": "comprador@braspag.com.br",
    "Address": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA"
    },
    "DeliveryAddress": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA"
    }
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2027",
      "SaveCard": false,
      "Brand": "Undefined"
    },
    "VelocityAnalysis": {
      "Id": "2d5e0463-47be-4964-b8ac-622a16a2b6c4",
      "ResultMessage": "Reject",
      "Score": 100,
      "RejectReasons": [
        {
          "RuleId": 49,
          "Message": "Bloqueado pela regra CardNumber. Name: Máximo de 3 Hits de Cartão em 1 dia. HitsQuantity: 3. HitsTimeRangeInSeconds: 1440. ExpirationBlockTimeInSeconds: 1440"
        }
      ]
    },
    "PaymentId": "2d5e0463-47be-4964-b8ac-622a16a2b6c4",
    "Type": "CreditCard",
    "Amount": 10000,
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 16,
    "ReasonMessage": "AbortedByFraud",
    "Status": 0,
    "ProviderReturnCode": "BP171",
    "ProviderReturnMessage": "Rejected by fraud risk (velocity)",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/2d5e0463-47be-4964-b8ac-622a16a2b6c4"
      }
    ]
  }
}
Propriedade Descrição Tipo Tamanho Formato
VelocityAnalysis.Id Identificador da análise efetuada GUID 36  
VelocityAnalysis.ResultMessage Accept ou Reject Texto 25  
VelocityAnalysis.Score 100 Número 10  
VelocityAnalysis.RejectReasons.RuleId Código da Regra que rejeitou Número 10  
VelocityAnalysis.RejectReasons.Message Descrição da Regra que rejeitou Texto 512  

Transação com Renova Fácil

O Renova fácil é um mecanismo desenvolvido pela CIELO junto com os bancos, com o objetivo de aumentar a taxa de conversão de autorização, através da identificação de cartões vencidos e o retorno do novo cartão que substituiu as vencidas. Bancos Emissores participantes: Bradesco, Banco do Brasil, Santander, Panamericano, Citibank

Requisição

{
   "MerchantOrderId":"2017051201",
   "Customer":{
      "Name":"Nome do Cliente"
   },
   "Payment":{
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
     "Capture":true,
     "Installments":1,
     "CreditCard":{
         "CardNumber":"4551870000000183",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2016",
         "SecurityCode":"123",
         "Brand":"Visa"
     }
   }
}
curl
--request PUT "https://apisandbox.braspag.com.br/v2/sales/{PaymentId}/void?amount=xxx"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
{
   "MerchantOrderId":"2017051201",
   "Customer":{
      "Name":"Nome do Cliente"
   },
   "Payment":{
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
     "Capture":true,
     "Installments":1,
     "CreditCard":{
         "CardNumber":"4551870000000183",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2016",
         "SecurityCode":"123",
         "Brand":"Visa"
     }
   }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.Installments Número 2 Sim Número de Parcelas
CreditCard.CardNumber Texto 16 Sim Número do Cartão do comprador
CreditCard.Holder Texto 25 Sim Nome do Comprador impresso no cartão
CreditCard.ExpirationDate Texto 7 Sim Data de validade impresso no cartão, no formato MM/AAAA
CreditCard.SecurityCode Texto 4 Sim Código de segurança impresso no verso do cartão
CreditCard.Brand Texto 10 Sim Bandeira do cartão

Resposta

{
  "MerchantOrderId": "2017051201",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0183",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2016",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "AcquirerTransactionId": "0512105630844",
    "NewCard": {
      "CardNumber": "4551870000512353",
      "Holder": "Nome do Portador",
      "ExpirationDate": "05/2020",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "PaymentId": "ca81c3c9-2dfa-4e6e-9c77-37e33a77ac84",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-12 10:56:30",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 15,
    "ReasonMessage": "CardExpired",
    "Status": 3,
    "ProviderReturnCode": "57",
    "ProviderReturnMessage": "Card Expired",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/ca81c3c9-2dfa-4e6e-9c77-37e33a77ac84"
      }
    ]
  }
}
{
  "MerchantOrderId": "2017051201",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0183",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2016",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "AcquirerTransactionId": "0512105630844",
    "NewCard": {
      "CardNumber": "4551870000512353",
      "Holder": "Nome do Portador",
      "ExpirationDate": "05/2020",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "PaymentId": "ca81c3c9-2dfa-4e6e-9c77-37e33a77ac84",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-12 10:56:30",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 15,
    "ReasonMessage": "CardExpired",
    "Status": 3,
    "ProviderReturnCode": "57",
    "ProviderReturnMessage": "Card Expired",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/ca81c3c9-2dfa-4e6e-9c77-37e33a77ac84"
      }
    ]
  }
}
Propriedade Descrição Tipo Tamanho Formato
NewCard.CardNumber Novo Número do Cartão do comprador Texto 16  
NewCard.Holder Nome do portador impresso no novo cartão Texto 25  
NewCard.ExpirationDate Data de validade impresso no novo cartão Texto 7  
NewCard.SecurityCode Código de segurança impresso no verso do novo cartão Texto 4  
NewCard.Brand Bandeira do novo cartão Texto 10  

Criando uma transação com DCC (conversor de moedas da adquirente Global Payments)

Exemplo de uma transação com DCC (Dynamic Currency Conversion), conversor de moedas da adquirente Global Payments que permite que o portador de um cartão estrangeiro escolha entre pagar em Reais ou em sua moeda Local, convertendo o valor do pedido no momento da compra com total transparência para o comprador. A solução é indicada para estabelecimentos que recebem pagamentos com cartões emitidos no exterior como hotéis, pousadas, polos comerciais e comércios em pontos turísticos.

Processo de autorização com DCC

Quando o estabelecimento possui o produto DCC habilitado, o processo de autorização é realizado em 3 etapas.

Na primeira etapa, quando é solicitada uma autorização com um cartão internacional, a Global Payments identifica o país do cartão e aplica a conversão de moeda seguindo os cálculos específicos de cada bandeira, em seguida retorna as informações de conversão.

Na segunda etapa, o sistema da loja deverá apresentar ao comprador as opções de pagar em Reais ou com a moeda de seu país (moeda do cartão de crédito), seguindo as melhores práticas solicitadas pela bandeira, onde:

DCC Global Payments

Exemplo disponibilizado pela Global Payments

Na terceira etapa, o sistema da loja envia a confirmação da transação com as informações da moeda escolhida pelo comprador. A resposta da autorização será retornada neste ponto.

PASSO 1 - Solicitação de autorização da transação:

Requisição

{
    "MerchantOrderId": "1808201431231",
    "Customer": {
        "Name": "Comprador Teste"
    },
    "Payment": {
        "Type": "CreditCard",
        "Currency": "BRL",
        "Amount": 100,
        "Provider": "GlobalPayments",
        "Installments": 1,
        "Authenticate": false,
        "Capture": false,
        "CreditCard": {
            "CardNumber": "1234123412341234",
            "Holder": "TerteDcc",
            "ExpirationDate": "12/2022",
            "SecurityCode": "123",
            "Brand": "Visa"
        },
        "ReturnUrl": "http://www.braspag.com.br/"
    }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "MerchantOrderId": "1808201431231",
    "Customer": {
        "Name": "Comprador Teste"
    },
    "Payment": {
        "Type": "CreditCard",
        "Currency": "BRL",
        "Amount": 100,
        "Provider": "GlobalPayments",
        "Installments": 1,
        "Authenticate": false,
        "Capture": false,
        "CreditCard": {
            "CardNumber": "1234123412341234",
            "Holder": "Comprador Teste",
            "ExpirationDate": "12/2022",
            "SecurityCode": "123",
            "Brand": "Visa"
        },
        "ReturnUrl": "http://www.braspag.com.br/"
    }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.Installments Número 2 Sim Número de Parcelas
CreditCard.CardNumber Texto 16 Sim Número do Cartão do comprador
CreditCard.Holder Texto 25 Sim Nome do Comprador impresso no cartão
CreditCard.ExpirationDate Texto 7 Sim Data de validade impresso no cartão, no formato MM/AAAA
CreditCard.SecurityCode Texto 4 Sim Código de segurança impresso no verso do cartão
CreditCard.Brand Texto 10 Sim Bandeira do cartão

Resposta

{
    "MerchantOrderId": "1808201431231",
    "Customer": {
        "Name": "Comprador Teste"
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "Authenticate": false,
        "Recurrent": false,
        "CreditCard": {
            "CardNumber": "123412******1234",
            "Holder": "Comprador Teste",
            "ExpirationDate": "12/2022",
            "SaveCard": false,
            "Brand": "Visa"
        },
        "ReturnUrl": "http://www.braspag.com.br/",
        "PaymentId": "fa0c3119-c730-433a-123a-a3b6dfaaad67",
        "Type": "CreditCard",
        "Amount": 100,
        "ReceivedDate": "2018-08-23 10:46:25",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "GlobalPayments",
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "Status": 12,
        "ProviderReturnCode": "0",
        "ProviderReturnMessage": "Transação autorizada",
        "CurrencyExchangeData": {
            "Id": "fab6f3a752d700af1d50fdd19987b95df497652b",
            "CurrencyExchanges": [{
                    "Currency": "EUR",
                    "ConvertedAmount": 31,
                    "ConversionRate": 3.218626,
                    "ClosingDate": "2017-03-09T00:00:00"
                },
                {
                    "Currency": "BRL",
                    "ConvertedAmount": 100
                }
            ]
        },
        "Links": [{
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiqueryhomolog.braspag.com.br/v2/sales/fa0c3119-c730-433a-123a-a3b6dfaaad67"
            },
            {
                "Method": "PUT",
                "Rel": "confirm",
                "Href": "https://apihomolog.braspag.com.br/v2/sales/fa0c3119-c730-433a-123a-a3b6dfaaad67/confirm"
            }
        ]
    }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "MerchantOrderId": "1808201431231",
    "Customer": {
        "Name": "Comprador Teste"
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "Authenticate": false,
        "Recurrent": false,
        "CreditCard": {
            "CardNumber": "123412******1234",
            "Holder": "Comprador Teste",
            "ExpirationDate": "12/2022",
            "SaveCard": false,
            "Brand": "Visa"
        },
        "ReturnUrl": "http://www.braspag.com.br/",
        "PaymentId": "fa0c3119-c730-433a-123a-a3b6dfaaad67",
        "Type": "CreditCard",
        "Amount": 100,
        "ReceivedDate": "2018-08-23 10:46:25",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "GlobalPayments",
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "Status": 12,
        "ProviderReturnCode": "0",
        "ProviderReturnMessage": "Transação autorizada",
        "CurrencyExchangeData": {
            "Id": "fab6f3a752d700af1d50fdd19987b95df497652b",
            "CurrencyExchanges": [{
                    "Currency": "EUR",
                    "ConvertedAmount": 31,
                    "ConversionRate": 3.218626,
                    "ClosingDate": "2017-03-09T00:00:00"
                },
                {
                    "Currency": "BRL",
                    "ConvertedAmount": 100
                }
            ]
        },
        "Links": [{
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiqueryhomolog.braspag.com.br/v2/sales/fa0c3119-c730-433a-123a-a3b6dfaaad67"
            },
            {
                "Method": "PUT",
                "Rel": "confirm",
                "Href": "https://apihomolog.braspag.com.br/v2/sales/fa0c3119-c730-433a-123a-a3b6dfaaad67/confirm"
            }
        ]
    }
}
Propriedade Descrição Tipo Tamanho Formato
AcquirerTransactionId Id da transação no provedor de meio de pagamento Texto 40 Texto alfanumérico
ProofOfSale Número do Comprovante de Venda Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização Texto 300 Texto alfanumérico
PaymentId Campo Identificador do Pedido Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ReceivedDate Data em que a transação foi recebida pela Brapag Texto 19 AAAA-MM-DD HH:mm:SS
ReasonCode Código de retorno da Operação Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da Operação Texto 512 Texto alfanumérico
Status Status da Transação Byte 2 Ex.
ProviderReturnCode Código retornado pelo provedor do meio de pagamento (adquirente e bancos) Texto 32 57
ProviderReturnMessage Mensagem retornada pelo provedor do meio de pagamento (adquirente e bancos) Texto 512 Transação Aprovada
CurrencyExchangeData.Id Id da ação da troca de Moeda Texto 50 1b05456446c116374005602dcbaf8db8879515a0
CurrencyExchangeData.CurrencyExchanges.Currency Moeda local do comprador/cartão de crédito. Numérico 4 EUR
CurrencyExchangeData.CurrencyExchanges.ConvertedAmount Valor convertido. Numérico 12 23
CurrencyExchangeData.CurrencyExchanges.ConversionRate Taxa de conversão. Numérico 9 3.218626
CurrencyExchangeData.CurrencyExchanges.ClosingDate Data de finalização da transação. Texto 19 AAAA-MM-DD HH:mm:SS
CurrencyExchangeData.CurrencyExchanges.Currency Código da moeda Real Texto 3 BRA
CurrencyExchangeData.CurrencyExchanges.ConvertedAmount Valor do pedido em Reais. Numérico 12 100

PASSO 2 - Exibição das opções de pagamento (pagar em Reais ou na moeda do cartão):

DCC Global Payments

Exemplo disponibilizado pela Global Payments

PASSO 3 - Confirmação da transação com a moeda escolhida pelo comprador:

Requisição

{  
  "Id":"1b05456446c116374005602dcbaf8db8879515a0",
  "Currency":"EUR",
  "Amount":23
}
curl
--request POST " https://apisandbox.braspag.com.br/v2/sales/{PaymentId}/confirm"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{  
  "Id":"1b05456446c116374005602dcbaf8db8879515a0",
  "Currency":"EUR",
  "Amount":23
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
Id Text 50 Sim Id da ação da troca de Moeda
Currency Numérico 4 Sim Moeda selecionada pelo comprador
Amount Numérico 12 Sim Valor convertido

Resposta

{
    "MerchantOrderId": "1808201431231",
    "Customer": {
        "Name": "Comprador Teste",
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": false,
        "Authenticate": false,
        "Recurrent": false,
        "CreditCard": {
            "CardNumber": "123412******1234",
            "Holder": "TerteDcc",
            "ExpirationDate": "12/2022",
            "SecurityCode": "***",
            "Brand": "Visa"
        },
        "ProofOfSale": "20170510053219433",
        "AcquirerTransactionId": "0510053219433",
        "AuthorizationCode": "936403",
        "SoftDescriptor": "Mensagem",
        "PaymentId": "fa0c3119-c730-433a-123a-a3b6dfaaad67",
        "Type": "CreditCard",
        "Amount": 23,
        "ReceivedDate": "2017-05-10 17:32:19",
        "CapturedAmount": 23,
        "CapturedDate": "2017-05-10 17:32:19",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "GlobalPayments",
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "Status": 2,
        "ProviderReturnCode": "6",
        "ProviderReturnMessage": "Operation Successful",
        "Links": [{
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/fa0c3119-c730-433a-123a-a3b6dfaaad67"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.braspag.com.br/v2/sales/fa0c3119-c730-433a-123a-a3b6dfaaad67/void"
            }
        ]
    }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "MerchantOrderId": "1808201431231",
    "Customer": {
        "Name": "Comprador Teste",
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": false,
        "Authenticate": false,
        "Recurrent": false,
        "CreditCard": {
            "CardNumber": "123412******1234",
            "Holder": "TerteDcc",
            "ExpirationDate": "12/2022",
            "SecurityCode": "***",
            "Brand": "Visa"
        },
        "ProofOfSale": "20170510053219433",
        "AcquirerTransactionId": "0510053219433",
        "AuthorizationCode": "936403",
        "SoftDescriptor": "Mensagem",
        "PaymentId": "fa0c3119-c730-433a-123a-a3b6dfaaad67",
        "Type": "CreditCard",
        "Amount": 23,
        "ReceivedDate": "2017-05-10 17:32:19",
        "CapturedAmount": 23,
        "CapturedDate": "2017-05-10 17:32:19",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "GlobalPayments",
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "Status": 2,
        "ProviderReturnCode": "6",
        "ProviderReturnMessage": "Operation Successful",
        "Links": [{
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/fa0c3119-c730-433a-123a-a3b6dfaaad67"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.braspag.com.br/v2/sales/fa0c3119-c730-433a-123a-a3b6dfaaad67/void"
            }
        ]
    }
}
Propriedade Descrição Tipo Tamanho Formato
AcquirerTransactionId Id da transação no provedor de meio de pagamento Texto 40 Texto alfanumérico
ProofOfSale Número do Comprovante de Venda Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização Texto 300 Texto alfanumérico
PaymentId Campo Identificador do Pedido Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ReceivedDate Data em que a transação foi recebida pela Brapag Texto 19 AAAA-MM-DD HH:mm:SS
ReasonCode Código de retorno da Operação Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da Operação Texto 512 Texto alfanumérico
Status Status da Transação Byte 2 Ex.
ProviderReturnCode Código retornado pelo provedor do meio de pagamento (adquirente e bancos) Texto 32 57
ProviderReturnMessage Mensagem retornada pelo provedor do meio de pagamento (adquirente e bancos) Texto 512 Transação Aprovada

Pagamentos com Análise de Fraude

Criando uma transação com Análise de Fraude Cybersource

Para que a análise de fraude via Cybersource seja efetuada em tempo de transação, é necessário complementar a mensagem com os dados mencionados no nó “FraudAnalysis”.

Requisição

{
    "MerchantOrderId": "2017051102",
    "Customer": {
        "Name": "Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Email": "comprador@braspag.com.br",
        "Birthdate": "1991-01-02",
        "Mobile": "5521995760078",
        "Phone": "552125553669",
        "Address": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        },
        "DeliveryAddress": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        }
    },
    "Payment": {
        "Provider": "Simulado",
        "Type": "CreditCard",
        "Amount": 10000,
        "Capture": true,
        "ServiceTaxAmount": 0,
        "Currency": "BRL",
        "Country": "BRA",
        "Installments": 1,
        "Interest": "ByMerchant",
        "Authenticate": false,
        "Recurrent": false,
        "SoftDescriptor": "Mensagem",
        "CreditCard": {
            "CardNumber": "4551870000000181",
            "Holder": "Nome do Portador",
            "ExpirationDate": "12/2021",
            "SecurityCode": "123",
            "Brand": "Visa",
            "SaveCard": "false"
        },
        "FraudAnalysis": {
            "Sequence": "AnalyseFirst",
            "SequenceCriteria": "Always",
            "Provider": "Cybersource",
            "CaptureOnLowRisk": false,
            "VoidOnHighRisk": false,
            "TotalOrderAmount": 10000,
            "FingerPrintId": "074c1ee676ed4998ab66491013c565e2",
            "Browser": {
                "CookiesAccepted": false,
                "Email": "comprador@braspag.com.br",
                "HostName": "Teste",
                "IpAddress": "127.0.0.1",
                "Type": "Chrome"
            },
            "Cart": {
                "IsGift": false,
                "ReturnsAccepted": true,
                "Items": [{
                    "GiftCategory": "Undefined",
                    "HostHedge": "Off",
                    "NonSensicalHedge": "Off",
                    "ObscenitiesHedge": "Off",
                    "PhoneHedge": "Off",
                    "Name": "ItemTeste",
                    "Quantity": 1,
                    "Sku": "20170511",
                    "UnitPrice": 10000,
                    "Risk": "High",
                    "TimeHedge": "Normal",
                    "Type": "AdultContent",
                    "VelocityHedge": "High",
                    "Passenger": {
                        "Email": "comprador@braspag.com.br",
                        "Identity": "1234567890",
                        "Name": "Nome do Comprador",
                        "Rating": "Adult",
                        "Phone": "999994444",
                        "Status": "Accepted"
                    }
                }]
            },
            "MerchantDefinedFields": [{
                "Id": 95,
                "Value": "Dado Definido pela Loja"
            }],
            "Shipping": {
                "Addressee": "Alameda Xingu, 512",
                "Method": "LowCost",
                "Phone": "1121840540"
            },
            "Travel": {
                "JourneyType": "OneWayTrip",
                "DepartureDateTime": "2018-01-09 18:00",
                "Passengers": [{
                    "Name": "Passenger Test",
                    "Identity": "212424808",
                    "Status": "Gold",
                    "Rating": "Adult",
                    "Email": "email@mail.com",
                    "Phone": "1234567890",
                    "TravelLegs": [{
                        "Origin": "AMS",
                        "Destination": "GIG"
                    }]
                }]
            }
        }
    }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "MerchantOrderId": "2017051102",
    "Customer": {
        "Name": "Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Email": "comprador@braspag.com.br",
        "Birthdate": "1991-01-02",
        "Mobile": "5521995760078",
        "Phone": "552125553669",
        "Address": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        },
        "DeliveryAddress": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        }
    },
    "Payment": {
        "Provider": "Simulado",
        "Type": "CreditCard",
        "Amount": 10000,
        "Capture": true,
        "ServiceTaxAmount": 0,
        "Currency": "BRL",
        "Country": "BRA",
        "Installments": 1,
        "Interest": "ByMerchant",
        "Authenticate": false,
        "Recurrent": false,
        "SoftDescriptor": "Mensagem",
        "CreditCard": {
            "CardNumber": "4551870000000181",
            "Holder": "Nome do Portador",
            "ExpirationDate": "12/2021",
            "SecurityCode": "123",
            "Brand": "Visa",
            "SaveCard": "false"
        },
        "FraudAnalysis": {
            "Sequence": "AnalyseFirst",
            "SequenceCriteria": "Always",
            "Provider": "Cybersource",
            "CaptureOnLowRisk": false,
            "VoidOnHighRisk": false,
            "TotalOrderAmount": 10000,
            "FingerPrintId": "074c1ee676ed4998ab66491013c565e2",
            "Browser": {
                "CookiesAccepted": false,
                "Email": "comprador@braspag.com.br",
                "HostName": "Teste",
                "IpAddress": "127.0.0.1",
                "Type": "Chrome"
            },
            "Cart": {
                "IsGift": false,
                "ReturnsAccepted": true,
                "Items": [{
                    "GiftCategory": "Undefined",
                    "HostHedge": "Off",
                    "NonSensicalHedge": "Off",
                    "ObscenitiesHedge": "Off",
                    "PhoneHedge": "Off",
                    "Name": "ItemTeste",
                    "Quantity": 1,
                    "Sku": "20170511",
                    "UnitPrice": 10000,
                    "Risk": "High",
                    "TimeHedge": "Normal",
                    "Type": "AdultContent",
                    "VelocityHedge": "High",
                    "Passenger": {
                        "Email": "comprador@braspag.com.br",
                        "Identity": "1234567890",
                        "Name": "Nome do Comprador",
                        "Rating": "Adult",
                        "Phone": "999994444",
                        "Status": "Accepted"
                    }
                }]
            },
            "MerchantDefinedFields": [{
                "Id": 95,
                "Value": "Dado Definido pela Loja"
            }],
            "Shipping": {
                "Addressee": "Alameda Xingu, 512",
                "Method": "LowCost",
                "Phone": "1121840540"
            },
            "Travel": {
                "JourneyType": "OneWayTrip",
                "DepartureDateTime": "2018-01-09 18:00",
                "Passengers": [{
                    "Name": "Passenger Test",
                    "Identity": "212424808",
                    "Status": "Gold",
                    "Rating": "Adult",
                    "Email": "email@mail.com",
                    "Phone": "1234567890",
                    "TravelLegs": [{
                        "Origin": "AMS",
                        "Destination": "GIG"
                    }]
                }]
            }
        }
    }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Número de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador.
Customer.Identity Texto 14 Não Número do RG, CPF ou CNPJ do Cliente
Customer.IdentityType Texto 255 Não Tipo de documento de identificação do comprador (CPF ou CNPJ)
Customer.Email Texto 255 Não Email do comprador
Customer.Birthdate Date 10 Não Data de nascimento do Comprador no formato AAAA-MM-DD
Customer.Mobile Número 19 Não Número do celular do comprador
Customer.Phone Número 19 Não Número do telefone do comprador
Customer.Address.Street Texto 54 Não Logradouro do endereço de contato do comprador
Customer.Address.Number Texto 5 Não Número endereço de contato do comprador
Customer.Address.Complement Texto 14 Não Complemento do endereço de contato do Comprador
Customer.Address.ZipCode Texto 9 Não CEP do endereço de contato do comprador
Customer.Address.City Texto 50 Não Cidade do endereço de contato do comprador
Customer.Address.State Texto 2 Não Estado do endereço de contato do comprador
Customer.Address.Country Texto 2 Não Pais do endereço de contato do comprador
Customer.Address.District Texto 45 Não Bairro do Comprador.
Customer.DeliveryAddress.Street Texto 54 Não Logradouro do endereço de entrega do comprador
Customer.DeliveryAddress.Number Texto 5 Não Número do endereço de entrega do pedido
Customer.DeliveryAddress.Complement Texto 14 Não Complemento do endereço de entrega do pedido
Customer.DeliveryAddress.ZipCode Texto 9 Não CEP do endereço de entrega do pedido
Customer.DeliveryAddress.City Texto 50 Não Cidade do endereço de entrega do pedido
Customer.DeliveryAddress.State Texto 2 Não Estado do endereço de entrega do pedido
Customer.DeliveryAddress.Country Texto 2 Não Pais do endereço de entrega do pedido
Customer.DeliveryAddress.District Texto 45 Não Bairro do Comprador.
Payment.Provider Texto 15 Sim Nome do provedor de pagamento.
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.ServiceTaxAmount Número 15 Sim 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
Payment.Currency Texto 3 Não Moeda na qual o pagamento será feito (BRL / USD / MXN / COP / CLP / ARS / PEN / EUR / PYN / UYU / VEB / VEF / GBP)
Payment.Country Texto 3 Não País na qual o pagamento será feito
Payment.Installments Número 2 Sim Número de Parcelas
Payment.Interest Texto 10 Não Tipo de parcelamento - Loja (ByMerchant) ou Emissor (ByIssuer)
Payment.Capture Booleano Não (Default false) Booleano que indica se a autorização deve ser com captura automática (true) ou não (false). Deverá verificar junto à adquirente a disponibilidade desta funcionalidade
Payment.Authenticate Booleano Não (Default false) Booleano que indica se a transação deve ser autenticada (true) ou não (false). Deverá verificar junto à adquirente a disponibilidade desta funcionalidade
Payment.Recurrent Booleano Não (Default false) Booleano que indica se a transação é do tipo recorrente (true) ou não (false). Este com valor true não originará uma nova Recorrência, apenas permitirá a realização de uma transação sem a necessidade de envio do CVV. Somente para transações Cielo. Authenticate deve ser false quando Recurrent é true
Payment.SoftDescriptor Texto 13 Não Texto que será impresso na fatura do portador
Payment.ExtraDataCollection.Name Texto 50 Não Nome do campo que será gravado o Dado Extra
Payment.ExtraDataCollection.Value Texto 1024 Não Valor do campo que será gravado o Dado Extra
CreditCard.CardNumber Texto 16 Sim Número do Cartão do comprador
CreditCard.Holder Texto 25 Sim Nome do portador impresso no cartão
CreditCard.ExpirationDate Texto 7 Sim Data de validade impresso no cartão
CreditCard.SecurityCode Texto 4 Sim Código de segurança impresso no verso do cartão
CreditCard.Brand Texto 10 Sim Bandeira do cartão
CreditCard.SaveCard Booleano Não (Default false) Booleano que identifica se o cartão será salvo para gerar o token (CardToken)
FraudAnalysis.Sequence Texto 14 Sim Tipo de Fluxo para realização da análise de fraude. Primeiro Analise (AnalyseFirst) ou Primeiro Autorização (AuthorizeFirst)
FraudAnalysis.Provider Texto 10 Sim Provedor de antifraude. Enviar: “Cybersource”.
FraudAnalysis.SequenceCriteria Texto 9 Sim Critério do fluxo.
OnSuccess - Só realiza a analise se tiver sucesso na transaçãoAlways - Sempre realiza a analise
FraudAnalysis.CaptureOnLowRisk Booleano Não Quando true, a autorização deve ser com captura automática quando o risco de fraude for considerado baixo (Accept). Em casos de Reject ou Review, o fluxo permanece o mesmo, ou seja, a captura acontecerá conforme o valor especificado no parâmetro “Capture”. Para a utilização deste parâmetro, a sequência do fluxo de análise de risco deve ser obrigatoriamente “AuthorizeFirst”. Por depender do resutlado de análise de risco, este parâmetro só terá efeito quando o serviço de Antifraude for contratado
FraudAnalysis.VoidOnHighRisk Booleano Não Quando true, o estorno deve acontecer automaticamente quando o risco de fraude for considerado alto (Reject). Em casos de Accept ou Review, o fluxo permanece o mesmo, ou seja, o estorno deve ser feito manualmente. Para a utilização deste parâmetro, a sequência do fluxo de análise de risco deve ser obrigatoriamente “AuthorizeFirst”. Por depender do resutlado de análise de risco, este parâmetro só terá efeito quando o serviço de Antifraude for contratado.
FraudAnalysis.TotalOrderAmount Número 15 Sim Valor total do pedido
FraudAnalysis.FingerPrintId Texto 50 Sim Identificador utilizado para cruzar informações obtidas pelo Browser do internauta com os dados enviados para análise. Este mesmo valor deve ser passado na variável SESSIONID do script do DeviceFingerPrint
FraudAnalysis.Browser.CookiesAccepted Booleano Sim Booleano para identificar se o browser do cliente aceita cookies
FraudAnalysis.Browser.Email Texto 100 Não E-mail registrado no browser do comprador
FraudAnalysis.Browser.HostName Texto 60 Não Nome do host onde o comprador estava antes de entrar no site da loja
FraudAnalysis.Browser.IpAddress Texto 15 Sim Endereço IP do comprador. É altamente recomendável o envio deste campo
FraudAnalysis.Browser.Type Texto 40 Não Nome do browser utilizado pelo comprador. Ex.: Google Chrome, Mozilla Firefox, Safari, etc.
FraudAnalysis.Cart.IsGift Booleano Não Booleano que indica se o pedido é para presente ou não
FraudAnalysis.Cart.ReturnsAccepted Booleano Não Booleano que define se devoluções são aceitas para o pedido
FraudAnalysis.Items.GiftCategory Texto 9 Não Campo que avaliará os endereços de cobrança e entrega para difrentes cidades, estados ou países.
“Yes” (Em caso de divergência entre endereços de cobrança e entrega, marca como risco pequeno)
“No” (Em caso de divergência entre endereços de cobrança e entrega, marca com risco alto)
“Off” (Ignora a análise de risco para endereços divergentes)
FraudAnalysis.Items.HostHedge Texto   Não Nível de importância do e-mail e endereços IP dos clientes em risco de pontuação.
“Low” (Baixa importância do e-mail e endereço IP na análise de risco)
“Normal” (Média importância do e-mail e endereço IP na análise de risco)
“High” (Alta importância do e-mail e endereço IP na análise de risco)
“Off” (E-mail e endereço IP não afetam a análise de risco)
FraudAnalysis.Items.NonSensicalHedge Texto 6 Não Nível dos testes realizados sobre os dados do comprador com pedidos recebidos sem sentido.
“Low” (Baixa importância da verificação feita sobre o pedido do comprador, na análise de risco)
“Normal” (Média importância da verificação feita sobre o pedido do comprador, na análise de risco)
“High” (Alta importância da verificação feita sobre o pedido do comprador, na análise de risco)
“Off” (Verificação do pedido do comprador não afeta a análise de risco)
FraudAnalysis.Items.ObscenitiesHedge Texto 6 Não Nível de obscenidade dos pedidos recebedidos.
“Low” (Baixa importância da verificação sobre obscenidades do pedido do comprador, na análise de risco)
“Normal” (Média importância da verificação sobre obscenidades do pedido do comprador, na análise de risco)
“High” (Alta importância da verificação sobre obscenidades do pedido do comprador, na análise de risco)
“Off” (Verificação de obscenidade no pedido do comprador não afeta a análise de risco)
FraudAnalysis.Items.PhoneHedge Texto 6 Não Nível dos testes realizados com os números de telefones.
“Low” (Baixa importância nos testes realizados com números de telefone)
“Normal” (Média importância nos testes realizados com números de telefone)
“High” (Alta importância nos testes realizados com números de telefone)
“Off” (Testes de números de telefone não afetam a análise de risco)
FraudAnalysis.Items.Name Texto 255 Sim Nome do Produto
FraudAnalysis.Items.Quantity Número 15 Sim Quantidade do produto a ser adquirido
FraudAnalysis.Items.Sku Texto 255 Sim Código comerciante identificador do produto
FraudAnalysis.Items.UnitPrice Número 15 Sim Preço unitário do produto
FraudAnalysis.Items.Risk Texto 6 Não Nível do risco do produto.
Low (O produto tem um histórico de poucos chargebacks)
Normal (O produto tem um histórico de chargebacks considerado normal)
High (O produto tem um histórico de chargebacks acima da média)
FraudAnalysis.Items.TimeHedge Texto   Não Nível de importância da hora do dia do pedido do cliente.
Low (Baixa importância no horário do dia em que foi feita a compra, para a análise de risco)
Normal (Média importância no horário do dia em que foi feita a compra, para a análise de risco)
High (Alta importância no horário do dia em que foi feita a compra, para a análise de risco)
Off (O horário da compra não afeta a análise de risco)
FraudAnalysis.Items.Type Texto   Não Tipo do produto.
AdultContent(Conteúdo adulto)
Coupon(Cupon de desconto)
Default(Opção padrão para análise na CyberSource quando nenhum outro valor é selecionado)
EletronicGood(Produto eletrônico)
EletronicSoftware(Softwares distribuídos eletronicamente via download)
GiftCertificate(Vale presente)
HandlingOnly(Taxa de instalação ou manuseio)
Service(Serviço)
ShippingAndHandling(Frete e taxa de instalação ou manuseio)
ShippingOnly(Frete)
Subscription(Assinatura)
FraudAnalysis.Items.VelocityHedge Texto 6 Não Nível de importância de frequência de compra do cliente.
Low (Baixa importância no número de compras realizadas pelo cliente nos últimos 15 minutos)
Normal (Média importância no número de compras realizadas pelo cliente nos últimos 15 minutos)
High (Alta importância no número de compras realizadas pelo cliente nos últimos 15 minutos)
Off (A frequência de compras realizadas pelo cliente não afeta a análise de fraude)
FraudAnalysis.Items.Passenger.Email Texto 255 Não Email do Passageiro
FraudAnalysis.Items.Passenger.Identity Texto 32 Não Id do passageiro a quem o bilheite foi emitido
FraudAnalysis.Items.Passenger.Name Texto 120 Não Nome do passageiro
FraudAnalysis.Items.Passenger.Rating Texto   Não Classificação do Passageiro.
Adult (Passageiro adulto)
Child(Passageiro criança)
Infant(Passageiro infantil)
Youth(Passageiro adolescente)
Student(Passageiro estudante)
SeniorCitizen(Passageiro idoso)
Military(Passageiro militar)
FraudAnalysis.Items.Passenger.Phone Texto 15 Não Número do telefone do passageiro. Para pedidos fora do U.S., a CyberSource recomenda que inclua o código do país. 552133665599 (Ex. Código do Pais 55, Código da Cidade 21, Telefone 33665599)
FraudAnalysis.Items.Passenger.Status Texto 32 Não Classificação da empresa aérea. Pode-se usar valores como Gold ou Platina
FraudAnalysis.MerchantDefinedFields.Id Texto Sim (se aplicável) Id das informações adicionais a serem enviadas
FraudAnalysis.MerchantDefinedFields.Value Texto 255 Sim (se aplicável) Valor das informações adicionais a serem enviadas
FraudAnalysis.Shipping.Addressee Texto 255 Não Nome do destinatário da entrega
FraudAnalysis.Shipping.Method Texto   Não Tipo de serviço de entrega do produto.
“SameDay” (Serviço de entrega no mesmo dia)
“OneDay” (Serviço de entrega noturna ou no dia seguint)
“TwoDay” (Serviço de entrega em dois dias)
“ThreeDay” (Serviço de entrega em três dias)
“LowCost” (Serviço de entrega de baixo custo)
“Pickup” (Produto retirado na loja)
“Other” (Outro método de entrega)
“None” (Sem serviço de entrega, pois é um serviço ou assinatura)
FraudAnalysis.Shipping.Phone Texto 15 Não Telefone do destinatário da entrega. Ex. 552133665599 (Código do Pais 55, Código da Cidade 21, Telefone 33665599)
FraudAnalysis.Travel.JourneyType Texto 32 Sim, caso o nó Travel seja enviado. Tipo de viagem. Ex. Só Ida, Só Volta, Ida e Volta. Valores: “OneWayTrip”,
FraudAnalysis.Travel.DepartureTime DateTime 23 Não Data, hora e minuto de partida do vôo. Ex: “2018-01-09 18:00:00”
FraudAnalysis.Travel.Passengers.Name Texto 120 Sim, caso o nó Travel seja enviado. Nome do passageiro.
FraudAnalysis.Travel.Passengers.Identity Texto 32 Sim, caso o nó Travel seja enviado. Número do RG, CPF ou CNPJ do passageiro.
FraudAnalysis.Travel.Passengers.Status Texto 32 Sim, caso o nó Travel seja enviado. Classificação da companhia aérea. Valores do campo: “Gold”, “Platina”.
FraudAnalysis.Travel.Passengers.Rating Texto 15 Sim, caso o nó Travel seja enviado. Classificação do Passageiro.
Valores do Campo:
“Adult” (Passageiro adulto)
“Child”(Passageiro criança)
Infant”(Passageiro infantil)
Youth”(Passageiro adolescente)
Student”(Passageiro estudante)
SeniorCitizen“(Passageiro idoso)
Military“(Passageiro militar)
FraudAnalysis.Travel.Passengers.Email Texto 255 Sim, caso o nó Travel seja enviado. E-mail do passageiro.
FraudAnalysis.Travel.Passengers.Phone Texto 15 Não Número do telefone do passageiro. Para pedidos fora do U.S., a CyberSource recomenda que inclua o código do país. 552133665599 (Ex. Código do Pais 55, Código da Cidade 21, Telefone 33665599)
FraudAnalysis.Travel.Passengers.TravelLegs.Origin Texto 3 Sim, caso o nó Travel seja enviado. Código do aeroporto do ponto de origem da viagem
FraudAnalysis.Travel.Passengers.TravelLegs.Destination Texto 3 Sim, caso o nó Travel seja enviado. Código do aeroporto do ponto de destino da viagem

Resposta

{
    "MerchantOrderId": "2017051102",
    "Customer": {
        "Name": "Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Email": "comprador@braspag.com.br",
        "Birthdate": "1991-01-02",
        "Mobile": "5521995760078",
        "Phone": "552125553669",
        "Address": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        },
        "DeliveryAddress": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        }
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "Authenticate": false,
        "Recurrent": false,
        "CreditCard": {
            "CardNumber": "455187******0181",
            "Holder": "Nome do Portador",
            "ExpirationDate": "12/2021",
            "SaveCard": false,
            "Brand": "Undefined"
        },
        "SoftDescriptor": "Mensagem",
        "FraudAnalysis": {
            "Sequence": "AnalyseFirst",
            "SequenceCriteria": "Always",
            "FingerPrintId": "074c1ee676ed4998ab66491013c565e2",
            "MerchantDefinedFields": [{
                "Id": 95,
                "Value": "Eu defini isso"
            }],
            "Cart": {
                "IsGift": false,
                "ReturnsAccepted": true,
                "Items": [{
                    "Type": "AdultContent",
                    "Name": "ItemTeste",
                    "Risk": "High",
                    "Sku": "201411170235134521346",
                    "UnitPrice": 123,
                    "Quantity": 1,
                    "HostHedge": "Off",
                    "NonSensicalHedge": "Off",
                    "ObscenitiesHedge": "Off",
                    "PhoneHedge": "Off",
                    "TimeHedge": "Normal",
                    "VelocityHedge": "High",
                    "GiftCategory": "Undefined",
                    "Passenger": {
                        "Name": "Comprador accept",
                        "Identity": "1234567890",
                        "Status": "Accepted",
                        "Rating": "Adult",
                        "Email": "compradorteste@live.com",
                        "Phone": "999994444"
                    }
                }]
            },
            "Travel": {
                "Route": "MAO-RJO",
                "DepartureTime": "2010-01-02T00:00:00",
                "JourneyType": "Ida",
                "Legs": [{
                    "Destination": "GYN",
                    "Origin": "VCP"
                }]
            },
            "Browser": {
                "HostName": "Teste",
                "CookiesAccepted": false,
                "Email": "compradorteste@live.com",
                "Type": "Chrome",
                "IpAddress": "200.190.150.350"
            },
            "Shipping": {
                "Addressee": "Sr Comprador Teste",
                "Phone": "21114740",
                "Method": "LowCost"
            },
            "Id": "0e4d0a3c-e424-4fa5-a573-4eabbd44da42",
            "Status": 1,
            "CaptureOnLowRisk": false,
            "VoidOnHighRisk": false,
            "FraudAnalysisReasonCode": 100,
            "ReplyData": {
                "AddressInfoCode": "COR-BA^MM-BIN",
                "FactorCode": "B^D^R^Z",
                "Score": 42,
                "BinCountry": "us",
                "CardIssuer": "FIA CARD SERVICES, N.A.",
                "CardScheme": "VisaCredit",
                "HostSeverity": 1,
                "InternetInfoCode": "FREE-EM^RISK-EM",
                "IpRoutingMethod": "Undefined",
                "ScoreModelUsed": "default_lac",
                "CasePriority": 3,
                "ProviderTransactionId": "5220688414326697303008"
            }
        },
        "PaymentId": "4219584b-6d23-49f0-a24c-2b677bc60df8",
        "Type": "CreditCard",
        "Amount": 10000,
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Simulado",
        "ReasonCode": 16,
        "ReasonMessage": "AbortedByFraud",
        "Status": 13,
        "Links": [{
            "Method": "GET",
            "Rel": "self",
            "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/4219584b-6d23-49f0-a24c-2b677bc60df8"
        }]
    }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "MerchantOrderId": "2017051102",
    "Customer": {
        "Name": "Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Email": "comprador@braspag.com.br",
        "Birthdate": "1991-01-02",
        "Mobile": "5521995760078",
        "Phone": "552125553669",
        "Address": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        },
        "DeliveryAddress": {
            "Street": "Alameda Xingu",
            "Number": "512",
            "Complement": "27 andar",
            "ZipCode": "12345987",
            "City": "São Paulo",
            "State": "SP",
            "Country": "BRA",
            "District": "Alphaville"
        }
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "Authenticate": false,
        "Recurrent": false,
        "CreditCard": {
            "CardNumber": "455187******0181",
            "Holder": "Nome do Portador",
            "ExpirationDate": "12/2021",
            "SaveCard": false,
            "Brand": "Undefined"
        },
        "SoftDescriptor": "Mensagem",
        "FraudAnalysis": {
            "Sequence": "AnalyseFirst",
            "SequenceCriteria": "Always",
            "FingerPrintId": "074c1ee676ed4998ab66491013c565e2",
            "MerchantDefinedFields": [{
                "Id": 95,
                "Value": "Eu defini isso"
            }],
            "Cart": {
                "IsGift": false,
                "ReturnsAccepted": true,
                "Items": [{
                    "Type": "AdultContent",
                    "Name": "ItemTeste",
                    "Risk": "High",
                    "Sku": "201411170235134521346",
                    "UnitPrice": 123,
                    "Quantity": 1,
                    "HostHedge": "Off",
                    "NonSensicalHedge": "Off",
                    "ObscenitiesHedge": "Off",
                    "PhoneHedge": "Off",
                    "TimeHedge": "Normal",
                    "VelocityHedge": "High",
                    "GiftCategory": "Undefined",
                    "Passenger": {
                        "Name": "Comprador accept",
                        "Identity": "1234567890",
                        "Status": "Accepted",
                        "Rating": "Adult",
                        "Email": "compradorteste@live.com",
                        "Phone": "999994444"
                    }
                }]
            },
            "Travel": {
                "Route": "MAO-RJO",
                "DepartureTime": "2010-01-02T00:00:00",
                "JourneyType": "Ida",
                "Legs": [{
                    "Destination": "GYN",
                    "Origin": "VCP"
                }]
            },
            "Browser": {
                "HostName": "Teste",
                "CookiesAccepted": false,
                "Email": "compradorteste@live.com",
                "Type": "Chrome",
                "IpAddress": "200.190.150.350"
            },
            "Shipping": {
                "Addressee": "Sr Comprador Teste",
                "Phone": "21114740",
                "Method": "LowCost"
            },
            "Id": "0e4d0a3c-e424-4fa5-a573-4eabbd44da42",
            "Status": 1,
            "CaptureOnLowRisk": false,
            "VoidOnHighRisk": false,
            "FraudAnalysisReasonCode": 100,
            "ReplyData": {
                "AddressInfoCode": "COR-BA^MM-BIN",
                "FactorCode": "B^D^R^Z",
                "Score": 42,
                "BinCountry": "us",
                "CardIssuer": "FIA CARD SERVICES, N.A.",
                "CardScheme": "VisaCredit",
                "HostSeverity": 1,
                "InternetInfoCode": "FREE-EM^RISK-EM",
                "IpRoutingMethod": "Undefined",
                "ScoreModelUsed": "default_lac",
                "CasePriority": 3,
                "ProviderTransactionId": "5220688414326697303008"
            }
        },
        "PaymentId": "4219584b-6d23-49f0-a24c-2b677bc60df8",
        "Type": "CreditCard",
        "Amount": 10000,
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Simulado",
        "ReasonCode": 16,
        "ReasonMessage": "AbortedByFraud",
        "Status": 13,
        "Links": [{
            "Method": "GET",
            "Rel": "self",
            "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/4219584b-6d23-49f0-a24c-2b677bc60df8"
        }]
    }
}
Propriedade Descrição Tipo Tamanho Formato
AcquirerTransactionId Id da transação no provedor de meio de pagamento Texto 40 Texto alfanumérico
ProofOfSale Número do Comprovante de Venda Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização Texto 300 Texto alfanumérico
SoftDescriptor Texto que será impresso na fatura do portador Texto 13 Texto alfanumérico
PaymentId Campo Identificador do Pedido Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ReceivedDate Data em que a transação foi recebida pela Brapag Texto 19 AAAA-MM-DD HH:mm:SS
ReasonCode Código de retorno da Operação Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da Operação Texto 512 Texto alfanumérico
Status Status da Transação Byte 2 Ex. 1
ProviderReturnCode Código retornado pelo provedor do meio de pagamento (adquirente e bancos) Texto 32 57
ProviderReturnMessage Mensagem retornada pelo provedor do meio de pagamento (adquirente e bancos) Texto 512 Transação Aprovada
FraudAnalysis.Id Indentificação da Transação no Antifraud Texto 300 Texto alfanumérico
FraudAnalysis.Status Status da Transação Byte 1 Ex. 1
FraudAnalysis.FraudAnalysisReasonCode Resultado da análise Byte 100 - Operação bem sucedida.101 - O pedido está faltando um ou mais campos necessários. Possível ação: Veja os campos que estão faltando na lista AntiFraudResponse.MissingFieldCollection. Reenviar o pedido com a informação completa.102 - Um ou mais campos do pedido contêm dados inválidos. Possível ação: Veja os campos inválidos na lista AntiFraudResponse.InvalidFieldCollection. Reenviar o pedido com as informações corretas.150 Falha no sistema geral. Possível ação: Aguarde alguns minutos e tente reenviar o pedido.151 - O pedido foi recebido, mas ocorreu time-out no servidor. Este erro não inclui time-out entre o cliente e o servidor. Possível ação: Aguarde alguns minutos e tente reenviar o pedido.152 O pedido foi recebido, mas ocorreu time-out. Possível ação: Aguarde alguns minutos e reenviar o pedido.202 – Prevenção à Fraude recusou o pedido porque o cartão expirou. Você também pode receber este código se a data de validade não coincidir com a data em arquivo do banco emissor. Se o processador de pagamento permite a emissão de créditos para cartões expirados, a CyberSource não limita essa funcionalidade. Possível ação: Solicite um cartão ou outra forma de pagamento.231 O número da conta é inválido. Possível ação: Solicite um cartão ou outra forma de pagamento.234 - Há um problema com a configuração do comerciante. Possível ação: Não envie o pedido. Entre em contato com o Suporte ao Cliente para corrigir o problema de configuração.400 A pontuação de fraude ultrapassa o seu limite. Possível ação: Reveja o pedido do cliente.480 O pedido foi marcado para revisão pelo Gerenciador de Decisão.481 - O pedido foi rejeitado pelo Gerenciador de Decisão
FraudAnalysis.ReplyData.AddressInfoCode Combinação de códigos que indicam erro no endereço de cobrança e/ou entrega. Os códigos são concatenados usando o caractere ^ Texto 255 Ex: COR-BA^MM-BIN
COR-BA - O endereço de cobrança pode ser normalizado.COR-SA - O endereço de entrega pode ser normalizado.INTL-BA - O país de cobrança é fora dos U.S.INTL-SA - O país de entrega é fora dos U.S.MIL-USA - Este é um endereço militar nos U.S.MM-A - Os endereços de cobrança e entrega usam nomes de ruas diferentes.MM-BIN - O BIN do cartão (os seis primeiros dígitos do número) não corresponde ao país.MM-C - Os endereços de cobrança e entrega usam cidades diferentes.MM-CO - Os endereços de cobrança e entrega usam países diferentes.MM-ST - Os endereços de cobrança e entrega usam estados diferentes.MM-Z - Os endereços de cobrança e entrega usam códidos postais diferentes.UNV-ADDR - O endereço é inverificável.
FraudAnalysis.ReplyData.FactorCode Combinação de códigos que indicam o score do pedido. Os códigos são concatenados usando o caractere ^ Texto 100 Ex: B^D^R^Z
A - Mudança de endereço excessiva. O cliente mudou o endereço de cobrança duas ou mais vezes nos últimos seis meses.B - BIN do cartão ou autorização de risco. Os fatores de risco estão relacionados com BIN de cartão de crédito e/ou verificações de autorização do cartão.C - Elevado números de cartões de créditos. O cliente tem usado mais de seis números de cartões de créditos nos últimos seis meses.D - Impacto do endereço de e-mail. O cliente usa um provedor de e-mail gratuito ou o endereço de email é arriscado.E - Lista positiva. O cliente está na sua lista positiva.F - Lista negativa. O número da conta, endereço, endereço de e-mail ou endereço IP para este fim aparece sua lista negativa.G - Inconsistências de geolocalização. O domínio do cliente de e-mail, número de telefone, endereço de cobrança, endereço de envio ou endereço IP é suspeito.H - Excessivas mudanças de nome. O cliente mudou o nome duas ou mais vezes nos últimos seis meses.I - Inconsistências de internet. O endereço IP e de domínio de e-mail não são consistentes com o endereço de cobrança.N - Entrada sem sentido. O nome do cliente e os campos de endereço contém palavras sem sentido ou idioma.O - Obscenidades. Dados do cliente contém palavras obscenas.P - Identidade morphing. Vários valores de um elemento de identidade estão ligados a um valor de um elemento de identidade diferentes. Por exemplo, vários números de telefone estão ligados a um número de conta única.Q - Inconsistências do telefone. O número de telefone do cliente é suspeito.R - Ordem arriscada. A transação, o cliente e o lojista mostram informações correlacionadas de alto risco.T - Cobertura Time. O cliente está a tentar uma compra fora do horário esperado.U - Endereço não verificável. O endereço de cobrança ou de entrega não pode ser verificado.V - Velocity. O número da conta foi usado muitas vezes nos últimos 15 minutos.W - Marcado como suspeito. O endereço de cobrança ou de entrega é semelhante a um endereço previamente marcado como suspeito.Y - O endereço, cidade, estado ou país dos endereços de cobrança e entrega não se correlacionam.Z - Valor inválido. Como a solicitação contém um valor inesperado, um valor padrão foi substituído. Embora a transação ainda possa ser processada, examinar o pedido com cuidado para detectar anomalias.
FraudAnalysis.ReplyData.Score Score total calculado para o pedido Número Número
FraudAnalysis.ReplyData.BinCountry Sigla do país de origem da compra Texto 2 us
FraudAnalysis.ReplyData.CardIssuer Nome do banco ou entidade emissora do cartão Texto 128 Bradesco
FraudAnalysis.ReplyData.CardScheme Tipo da bandeira Texto 20 MaestroInternational - Maestro InternationalMaestroUkDomestic - Maestro UK DomesticMastercardCredit - MasterCard CreditMastercardDebit - MasterCard DebitVisaCredit - Visa CreditVisaDebit - Visa DebitVisaElectron - Visa Electron
FraudAnalysis.ReplyData.HostSeverity Nível de risco do domínio de e-mail do comprador, de 0 a 5, onde 0 é risco indeterminado e 5 representa o risco mais alto Número 5
FraudAnalysis.ReplyData.InternetInfoCode Sequência de códigos que indicam que existe uma excessiva alteração de identidades do comprador. Os códigos são concatenados usando o caractere ^ Texto 255 Ex:
MORPH-B - O mesmo endereço de cobrança tem sido utilizado várias vezes com identidades de clientes múltiplos.MORPH-C - O mesmo número de conta tem sido utilizado várias vezes com identidades de clientes múltiplos.MORPH-E - O mesmo endereço de e-mail tem sido utilizado várias vezes com identidades de clientes múltiplos. MORPH-I O mesmo endereço IP tem sido utilizado várias vezes com identidades de clientes múltiplos.MORPH-P - O mesmo número de telefone tem sido usado várias vezes com identidades de clientes múltiplos.MORPH-S - O mesmo endereço de entrega tem sido utilizado várias vezes com identidades de clientes múltiplos.
FraudAnalysis.ReplyData.IpRoutingMethod Tipo de roteamento de IP utilizado pelo computador Texto AnonymizerAolBasedCacheProxyFixedInternationalProxyMobileGatewayPopRegionalProxySatelliteSuperPop
FraudAnalysis.ReplyData.ScoreModelUsed Nome do modelo de score utilizado Texto 20 Ex: default_lac
FraudAnalysis.ReplyData.CasePriority Caso o lojista seja assinante do Enhanced Case Management, ele recebe este valor com o nível de prioridade, sendo 1 o mais alto e 5 o mais baixo Número 3
FraudAnalysis.ReplyData.ProviderTransactionId Identificador da transação no provedor de fraude. Texto 100 Ex: “5206061832306553904009”

Criando uma transação com Análise de Fraude ReD Shield

Para que a análise de fraude seja efetuada em tempo de transação, é necessário complementar a mensagem com os dados mencionados no nó “FraudAnalysis”.

Requisição

{
    "MerchantOrderId": "201411170314344356",
    "Customer": {
        "Name": "Comprador Teste",
        "Identity": "46286005030",
        "IdentityType": "CPF",
        "Email": "comprador_teste@live.com",
        "Birthdate": "1986-08-01",
        "WorkPhone": "552121544788",
        "Mobile": "5521995760078",
        "Phone": "552125553669",
        "Address": {
            "Street": "Rua Teste",
            "Number": "500",
            "Complement": "AP 205",
            "District": "Tijuca",
            "ZipCode": "21002320",
            "City": "Rio de Janeiro",
            "State": "RJ",
            "Country": "BR"
        },
        "DeliveryAddress": {
            "Street": "Av Marechal Camara",
            "Number": "160",
            "Complement": "Sala 934",
            "District": "Centro",
            "ZipCode": "20020080",
            "City": "Rio de Janeiro",
            "State": "RJ",
            "Country": "BR",
            "Comment": "Ao lado do banco Santander"
        },
        "Status": "New"
    },
    "Payment": {
        "Type": "CreditCard",
        "Amount": 15700,
        "Provider": "Simulado",
        "Installments": 1,
        "CreditCard": {
            "CardNumber": "****6310",
            "Holder": "Teste Holder",
            "ExpirationDate": "12/2021",
            "SecurityCode": "***",
            "Brand": "visa"
        },
        "FraudAnalysis": {
            "Sequence": "AnalyseFirst",
            "SequenceCriteria": "Always",
            "Provider": "RedShield",
            "CaptureOnLowRisk": true,
            "VoidOnHighRisk": true,
            "TotalOrderAmount": 16700,
            "OrderDate": "2016-12-09T19:16:38",
            "IsRetryTransaction": false,
            "SplitingPaymentMethod": "None",
            "FingerPrintId": "04003hQUMXGB0poNf94lis1ztuLYRFk+zJ17aP79a9O8mWOBmEnKs6ziAo94ggAtBvKEN6/FI8Vv2QMAyHLnc295s0Nn8akZzRJtHwsEilYx1P+NzuNQnyK6+7x2OpjJZkl4NlfPt7h9d96X/miNlYT65UIY2PeH7sUAh9vKxMn1nlPu2MJCSi12NBBoiZbfxP1Whlz5wlRFwWJi0FRulruXQQGCQaJkXU7GWWZGI8Ypycnf7F299GIR12G/cdkIMFbm6Yf0/pTJUUz1vNp0X2Zw8QydKgnOIDKXq4HnEqNOos1c6njJgQh/4vXJiqy0MXMQOThNipDmXv9I185O+yC2f3lLEO0Tay66NZEyiLNePemJKSIdwO9O5ZtntuUkG6NTqARuHStXXfwp8cyGF4MPWLuvNvEfRkJupBy3Z8hSEMEK7ZWd2T2HOihQxRh4qp+NANqYKBTl3v6fQJAEKikeSQVeBN8sQqAL0BZFaIMzbrnMivi6m6JRQUIdvEt+MbJEPFc0LjRycC5ApUmJO+Aoo9VKL1B8ftMSQ1iq1uTKn16ZOmDpzZrZhMPbH83aV0rfB2GDXcjpghm9klVFOw7EoYzV7IDBIIRtgqG9KZ+8NH/z6D+YNUMLEUuK1N2ddqKbS5cKs2hplVRjwSv7x8lMXWE7VDaOZWB8+sD1cMLQtEUC0znzxZ4bpRaiSy4dJLxuJpQYAFUrDlfSKRv/eHV3QiboXLuw9Lm6xVBK8ZvpD5d5olGQdc+NgsqjFnAHZUE+OENgY4kVU9wB84+POrI4MkoD4iHJ5a1QF8AZkZDFo1m1h9Bl+J2Ohr6MkBZq8DG5iVaunHfxUdHou5GL7lS1H7r+8ctfDXi8AfOPjzqyODJQ74Aiel35TKTOWG8pq1WO6yzJ1GNmMuMWZBamlGXoG/imnjwHY9HQtQzpGfcm0cR8X2Fd1ngNFGLDGZlWOX0jWtOwU6XVGT37JFD9W/cx4kzI+mPNi65X5WFPYlDG9N0Lbh5nOj3u3DXqRCiKCUrsEkMt8z9fxO9pLLGVQUKIYR2wTw53CiWK96FOpPevDWtH2XR0QkfOd02D73n81x6hEMCy0s3hRLn08Th9FlNHDMJBqLj+Tz8rG2TtNki3mJC7Ass1MT2qnKBI77n6vsQkAp59TfbZm/tBXwAoYdLJXge8F/numhd5AvQ+6I8ZHGJfdN3qWndvJ2I7s5Aeuzb8t9//eNsm73fIa05XreFsNyfOq1vG2COftC6EEsoJWe5h5Nwu1x6PIKuCaWxLY+npfWgM0dwJPmSgPx7TNM31LyVNS65m83pQ+qMTRH6GRVfg7HAcS5fnS/cjdbgHxEkRmgkRq1Qs48sbX9QC8nOTD0ntb6FcJyEOEOVzmJtDqimkzDq+SXR1/63AYe4LEj+ogRgN+Z8HAFhGFzd/m6snVviELfRqJ4LLQIk9Y/fzqnsF6I5OGxfdT2sxxK2Vokpi3jWhCcEknw7dYlHYpOnCHZO7QVgjQTngF2mzKf4GeOF4ECFsWTgLy6HFEitfauYJt1Xh1NfZZerBMwXLFzdhzoTQxGlcXc8lZIoEG1BLYv/ScICf8Ft9PEtpEa+j0cDSlU99UoH2xknwR1W9MRGc5I/euE63/IMJTqguZ3YcnJpjSVnAGSpyz/0gKjypJ3L86rHFRGXt0QbmaXtSl2UmmjI0p0LCCdx7McatCFEVI6FwPpPV0ZSMv/jM75eBid1X/lTV4XNzjowzR/iFlKYMzHZtVO9hCBPKlTwblRXNn4MlvNm/XeSRQ+Mr0YV5w5CL5Z/tGyzqnaLPj/kOVdyfj8r2m5Bcrz4g/ieUIo8qRFv2T2mET46ydqaxi27G4ZYHj7hbiaIqTOxWaE07qMCkJw==",
            "Browser": {
                "IpAddress": "187.32.163.105"
            },
            "Cart": {
                "Items": [{
                    "Name": "Nome do produto",
                    "Sku": "201411170235",
                    "UnitPrice": 10950,
                    "OriginalPrice": 11490,
                    "Quantity": 1,
                    "MerchantItemId": "45584",
                    "GiftMessage": "Mensagem para presente",
                    "Description": "Descricao do produto",
                    "ShippingInstructions": "Proximo ao 546",
                    "ShippingMethod": "SameDay",
                    "ShippingTrackingNumber": "123456",
                    "Passenger": {
                        "Name": "Passageiro Teste1",
                        "Identity": "1234567891",
                        "Status": "Platinum",
                        "Rating": "Student",
                        "Email": "passageiro_teste1@live.com",
                        "Phone": "55999993333",
                        "DateOfBirth": "1988-01-06"
                    }
                }, {
                    "Name": "Nome do produto",
                    "Sku": "20141117023",
                    "UnitPrice": 10950,
                    "OriginalPrice": 11490,
                    "Quantity": 2,
                    "MerchantItemId": "45585",
                    "GiftMessage": "Mensagem para presente",
                    "Description": "Descricao do produto",
                    "ShippingInstructions": "Proximo ao 160",
                    "ShippingMethod": "NextDay",
                    "ShippingTrackingNumber": "654321",
                    "Passenger": {
                        "Name": "Passageiro Teste2",
                        "Identity": "1234567892",
                        "Status": "Gold",
                        "Rating": "Adult",
                        "Email": "passageiro_teste2@live.com",
                        "Phone": "5521999994444",
                        "DateOfBirth": "1958-07-06"
                    }
                }]
            },
            "MerchantDefinedFields": [{
                "Id": "95",
                "Value": "Definido pelo cliente junto ao provedor"
            }, {
                "Id": "96",
                "Value": "Definido pelo cliente junto ao provedor"
            }],
            "Shipping": {
                "Addressee": "Destinatario Teste",
                "Email": "destinatario_teste@live.com",
                "Method": "LowCost",
                "Phone": "5521995950277"
            },
            "CustomConfiguration": {
                "MerchantWebsite": "http://www.test.com"
            },
            "Travel": {
                "ThirdPartyBooking": true,
                "BookingType": "Corporate",
                "TicketDeliveryMethod": "Delivery",
                "BookingReferenceNumber": "L5W4NW",
                "Passengers": [{
                    "Name": "Passenger Test",
                    "Identity": "212424808",
                    "Status": "Gold",
                    "Rating": "Adult",
                    "Email": "email@mail.com",
                    "Phone": "1234567890",
                    "TicketNumber": "123541",
                    "FrequentFlyerNumber": "159753852",
                    "TravelLegs": [{
                        "Origin": "AMS",
                        "Destination": "GIG",
                        "ArrivalCountry": "NLD",
                        "DepartureCountry": "BRA",
                        "AirlineCode": "KLM",
                        "DepartureDate": "2018-01-09 18:00",
                        "ClassOfService": "Standard"
                    }]
                }]
            }

        }
    }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "MerchantOrderId": "201411170314344356",
    "Customer": {
        "Name": "Comprador Teste",
        "Identity": "46286005030",
        "IdentityType": "CPF",
        "Email": "comprador_teste@live.com",
        "Birthdate": "1986-08-01",
        "WorkPhone": "552121544788",
        "Mobile": "5521995760078",
        "Phone": "552125553669",
        "Address": {
            "Street": "Rua Teste",
            "Number": "500",
            "Complement": "AP 205",
            "District": "Tijuca",
            "ZipCode": "21002320",
            "City": "Rio de Janeiro",
            "State": "RJ",
            "Country": "BR"
        },
        "DeliveryAddress": {
            "Street": "Av Marechal Camara",
            "Number": "160",
            "Complement": "Sala 934",
            "District": "Centro",
            "ZipCode": "20020080",
            "City": "Rio de Janeiro",
            "State": "RJ",
            "Country": "BR",
            "Comment": "Ao lado do banco Santander"
        },
        "Status": "New"
    },
    "Payment": {
        "Type": "CreditCard",
        "Amount": 15700,
        "Provider": "Simulado",
        "Installments": 1,
        "CreditCard": {
            "CardNumber": "****6310",
            "Holder": "Teste Holder",
            "ExpirationDate": "12/2021",
            "SecurityCode": "***",
            "Brand": "visa"
        },
        "FraudAnalysis": {
            "Sequence": "AnalyseFirst",
            "SequenceCriteria": "Always",
            "Provider": "RedShield",
            "CaptureOnLowRisk": true,
            "VoidOnHighRisk": true,
            "TotalOrderAmount": 16700,
            "OrderDate": "2016-12-09T19:16:38",
            "IsRetryTransaction": false,
            "SplitingPaymentMethod": "None",
            "FingerPrintId": "04003hQUMXGB0poNf94lis1ztuLYRFk+zJ17aP79a9O8mWOBmEnKs6ziAo94ggAtBvKEN6/FI8Vv2QMAyHLnc295s0Nn8akZzRJtHwsEilYx1P+NzuNQnyK6+7x2OpjJZkl4NlfPt7h9d96X/miNlYT65UIY2PeH7sUAh9vKxMn1nlPu2MJCSi12NBBoiZbfxP1Whlz5wlRFwWJi0FRulruXQQGCQaJkXU7GWWZGI8Ypycnf7F299GIR12G/cdkIMFbm6Yf0/pTJUUz1vNp0X2Zw8QydKgnOIDKXq4HnEqNOos1c6njJgQh/4vXJiqy0MXMQOThNipDmXv9I185O+yC2f3lLEO0Tay66NZEyiLNePemJKSIdwO9O5ZtntuUkG6NTqARuHStXXfwp8cyGF4MPWLuvNvEfRkJupBy3Z8hSEMEK7ZWd2T2HOihQxRh4qp+NANqYKBTl3v6fQJAEKikeSQVeBN8sQqAL0BZFaIMzbrnMivi6m6JRQUIdvEt+MbJEPFc0LjRycC5ApUmJO+Aoo9VKL1B8ftMSQ1iq1uTKn16ZOmDpzZrZhMPbH83aV0rfB2GDXcjpghm9klVFOw7EoYzV7IDBIIRtgqG9KZ+8NH/z6D+YNUMLEUuK1N2ddqKbS5cKs2hplVRjwSv7x8lMXWE7VDaOZWB8+sD1cMLQtEUC0znzxZ4bpRaiSy4dJLxuJpQYAFUrDlfSKRv/eHV3QiboXLuw9Lm6xVBK8ZvpD5d5olGQdc+NgsqjFnAHZUE+OENgY4kVU9wB84+POrI4MkoD4iHJ5a1QF8AZkZDFo1m1h9Bl+J2Ohr6MkBZq8DG5iVaunHfxUdHou5GL7lS1H7r+8ctfDXi8AfOPjzqyODJQ74Aiel35TKTOWG8pq1WO6yzJ1GNmMuMWZBamlGXoG/imnjwHY9HQtQzpGfcm0cR8X2Fd1ngNFGLDGZlWOX0jWtOwU6XVGT37JFD9W/cx4kzI+mPNi65X5WFPYlDG9N0Lbh5nOj3u3DXqRCiKCUrsEkMt8z9fxO9pLLGVQUKIYR2wTw53CiWK96FOpPevDWtH2XR0QkfOd02D73n81x6hEMCy0s3hRLn08Th9FlNHDMJBqLj+Tz8rG2TtNki3mJC7Ass1MT2qnKBI77n6vsQkAp59TfbZm/tBXwAoYdLJXge8F/numhd5AvQ+6I8ZHGJfdN3qWndvJ2I7s5Aeuzb8t9//eNsm73fIa05XreFsNyfOq1vG2COftC6EEsoJWe5h5Nwu1x6PIKuCaWxLY+npfWgM0dwJPmSgPx7TNM31LyVNS65m83pQ+qMTRH6GRVfg7HAcS5fnS/cjdbgHxEkRmgkRq1Qs48sbX9QC8nOTD0ntb6FcJyEOEOVzmJtDqimkzDq+SXR1/63AYe4LEj+ogRgN+Z8HAFhGFzd/m6snVviELfRqJ4LLQIk9Y/fzqnsF6I5OGxfdT2sxxK2Vokpi3jWhCcEknw7dYlHYpOnCHZO7QVgjQTngF2mzKf4GeOF4ECFsWTgLy6HFEitfauYJt1Xh1NfZZerBMwXLFzdhzoTQxGlcXc8lZIoEG1BLYv/ScICf8Ft9PEtpEa+j0cDSlU99UoH2xknwR1W9MRGc5I/euE63/IMJTqguZ3YcnJpjSVnAGSpyz/0gKjypJ3L86rHFRGXt0QbmaXtSl2UmmjI0p0LCCdx7McatCFEVI6FwPpPV0ZSMv/jM75eBid1X/lTV4XNzjowzR/iFlKYMzHZtVO9hCBPKlTwblRXNn4MlvNm/XeSRQ+Mr0YV5w5CL5Z/tGyzqnaLPj/kOVdyfj8r2m5Bcrz4g/ieUIo8qRFv2T2mET46ydqaxi27G4ZYHj7hbiaIqTOxWaE07qMCkJw==",
            "Browser": {
                "IpAddress": "187.32.163.105"
            },
            "Cart": {
                "Items": [{
                    "Name": "Nome do produto",
                    "Sku": "201411170235",
                    "UnitPrice": 10950,
                    "OriginalPrice": 11490,
                    "Quantity": 1,
                    "MerchantItemId": "45584",
                    "GiftMessage": "Mensagem para presente",
                    "Description": "Descricao do produto",
                    "ShippingInstructions": "Proximo ao 546",
                    "ShippingMethod": "SameDay",
                    "ShippingTrackingNumber": "123456",
                    "Passenger": {
                        "Name": "Passageiro Teste1",
                        "Identity": "1234567891",
                        "Status": "Platinum",
                        "Rating": "Student",
                        "Email": "passageiro_teste1@live.com",
                        "Phone": "55999993333",
                        "DateOfBirth": "1988-01-06"
                    }
                }, {
                    "Name": "Nome do produto",
                    "Sku": "20141117023",
                    "UnitPrice": 10950,
                    "OriginalPrice": 11490,
                    "Quantity": 2,
                    "MerchantItemId": "45585",
                    "GiftMessage": "Mensagem para presente",
                    "Description": "Descricao do produto",
                    "ShippingInstructions": "Proximo ao 160",
                    "ShippingMethod": "NextDay",
                    "ShippingTrackingNumber": "654321",
                    "Passenger": {
                        "Name": "Passageiro Teste2",
                        "Identity": "1234567892",
                        "Status": "Gold",
                        "Rating": "Adult",
                        "Email": "passageiro_teste2@live.com",
                        "Phone": "5521999994444",
                        "DateOfBirth": "1958-07-06"
                    }
                }]
            },
            "MerchantDefinedFields": [{
                "Id": "95",
                "Value": "Definido pelo cliente junto ao provedor"
            }, {
                "Id": "96",
                "Value": "Definido pelo cliente junto ao provedor"
            }],
            "Shipping": {
                "Addressee": "Destinatario Teste",
                "Email": "destinatario_teste@live.com",
                "Method": "LowCost",
                "Phone": "5521995950277"
            },
            "CustomConfiguration": {
                "MerchantWebsite": "http://www.test.com"
            },
            "Travel": {
                "ThirdPartyBooking": true,
                "BookingType": "Corporate",
                "TicketDeliveryMethod": "Delivery",
                "BookingReferenceNumber": "L5W4NW",
                "Passengers": [{
                    "Name": "Passenger Test",
                    "Identity": "212424808",
                    "Status": "Gold",
                    "Rating": "Adult",
                    "Email": "email@mail.com",
                    "Phone": "1234567890",
                    "TicketNumber": "123541",
                    "FrequentFlyerNumber": "159753852",
                    "TravelLegs": [{
                        "Origin": "AMS",
                        "Destination": "GIG",
                        "ArrivalCountry": "NLD",
                        "DepartureCountry": "BRA",
                        "AirlineCode": "KLM",
                        "DepartureDate": "2018-01-09 18:00",
                        "ClassOfService": "Standard"
                    }]
                }]
            }

        }
    }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição              
MerchantId Guid 36 Sim Identificador da loja na Braspag              
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag              
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT              
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido              
Customer.Name Texto 61 Sim Nome do comprador              
Customer.Identity Número 14 Sim Número do RG, CPF ou CNPJ do Cliente              
Customer.IdentityType Texto 25 Sim Tipo de documento de identificação do comprador (CPF ou CNPJ)              
Customer.Email Texto 60 Sim Email do comprador              
Customer.Birthdate Date 10 Não Data de nascimento do Comprador no formato AAAA-MM-DD              
Customer.WorkPhone Número 19 Não Número do telefone de trabalho do comprador              
Customer.Mobile Número 19 Não Número do celular do comprador              
Customer.Phone Número 19 Não Número do telefone do comprador              
Customer.Address.Street Texto 24 Sim Endereço de contato do comprador              
Customer.Address.Number Texto 5 Sim Número endereço de contato do comprador              
Customer.Address.Complement Texto 14 Sim Complemento do endereço de contato do Comprador              
Customer.Address.District Texto 15 Sim Bairro do Comprador              
Customer.Address.ZipCode Texto 9 Sim CEP do endereço de contato do comprador              
Customer.Address.City Texto 20 Sim Cidade do endereço de contato do comprador              
Customer.Address.State Texto 2 Sim Estado do endereço de contato do comprador              
Customer.Address.Country Texto 2 Sim Pais do endereço de contato do comprador              
Customer.DeliveryAddress.Street Texto 24 Sim Endereço de entrega do pedido              
Customer.DeliveryAddress.Number Texto 5 Sim Número do endereço de entrega do pedido              
Customer.DeliveryAddress.Complement Texto 14 Não Complemento do endereço de entrega do pedido              
Customer.DeliveryAddress.District Texto 15 Sim Bairro do Comprador.              
Customer.DeliveryAddress.ZipCode Texto 9 Sim CEP do endereço de entrega do pedido              
Customer.DeliveryAddress.City Texto 20 Sim Cidade do endereço de entrega do pedido              
Customer.DeliveryAddress.State Texto 2 Sim Estado do endereço de entrega do pedido              
Customer.DeliveryAddress.Country Texto 2 Sim Pais do endereço de entrega do pedido              
Customer.DeliveryAddress.Comment Texto 160 Não Referências do endereço de entrega              
Customer.Status Texto 8 Não Status do comprador na loja. New -> Identifica quando o comprador é novo na loja, nunca fez uma compra. Existing -> identifica quando o comprador já é existente na loja, já realizou uma compra.              
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento              
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)              
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento              
Payment.Installments Número 2 Sim Número de Parcelas              
CreditCard.CardNumber Texto 16 Sim Número do Cartão do comprador              
CreditCard.Holder Texto 25 Sim Nome do portador impresso no cartão              
CreditCard.ExpirationDate Texto 7 Sim Data de validade impresso no cartão              
CreditCard.SecurityCode Texto 4 Sim Código de segurança impresso no verso do cartão              
CreditCard.Brand Texto 10 Sim Bandeira do cartão              
Payment.Interest Texto 10 Não Tipo de parcelamento - Loja (ByMerchant - opção default) ou Emissor (ByIssuer)              
Payment.Capture Booleano Não (Default false) Booleano que indica se a autorização deve ser com captura automática (true) ou não (false). Deverá verificar junto à adquirente a disponibilidade desta funcionalidade              
Payment.Authenticate Booleano Não (Default false) Booleano que indica se a transação deve ser autenticada (true) ou não (false). Deverá verificar junto à adquirente a disponibilidade desta funcionalidade              
Payment.Recurrent Booleano Não (Default false) Booleano que indica se a transação é do tipo recorrente (true) ou não (false). Este com valor true não originará uma nova Recorrência, apenas permitirá a realização de uma transação sem a necessidade de envio do CVV. Somente para transações Cielo. Authenticate deve ser false quando Recurrent é true              
Payment.SoftDescriptor Texto 13 Não Texto que será impresso na fatura do portador              
Payment.ExtraDataCollection.Name Texto 50 Não Nome do campo que será gravado o Dado Extra              
Payment.ExtraDataCollection.Value Texto 1024 Não Valor do campo que será gravado o Dado Extra              
CreditCard.SaveCard Booleano Não (Default false) Booleano que identifica se o cartão será salvo para gerar o token (CardToken)              
FraudAnalysis.Sequence Texto 14 Sim Tipo de Fluxo para realização da análise de fraude. Primeiro Analise (AnalyseFirst) ou Primeiro Autorização (AuthorizeFirst)              
FraudAnalysis.SequenceCriteria Texto 9 Sim Critério do fluxo.
OnSuccess - Só realiza a analise se tiver sucesso na transaçãoAlways - Sempre realiza a analise
             
FraudAnalysis.Provider Texto 15 Sim Nome do provedor de Antifraude. Enviar “RedShield”.              
FraudAnalysis.CaptureOnLowRisk Booleano Booleano que identifica se a autorização deve ser com captura automática quando o risco de fraude for considerado baixo (Accept). Em casos de Reject ou Review, o fluxo permanece o mesmo, ou seja, a captura acontecerá conforme o valor especificado no parâmetro “Capture”. Para a utilização deste parâmetro, a sequência do fluxo de análise de risco deve ser obrigatoriamente “AuthorizeFirst”. Por depender do resutlado de análise de risco, este parâmetro só terá efeito quando o serviço de Antifraude for contratado.                
FraudAnalysis.VoidOnHighRisk Booleano Não Booleano que identifica se o estorno deve acontecer automaticamente quando o risco de fraude for considerado alto (Reject). Em casos de Accept ou Review, o fluxo permanece o mesmo, ou seja, o estorno deve ser feito manualmente. Para a utilização deste parâmetro, a sequência do fluxo de análise de risco deve ser obrigatoriamente “AuthorizeFirst”. Por depender do resutlado de análise de risco, este parâmetro só terá efeito quando o serviço de Antifraude for contratado.              
FraudAnalysis.TotalOrderAmount Número 15 Sim Valor total do pedido              
FraudAnalysis.OrderDate Datetime Sim Data do pedido              
FraudAnalysis.IsRetryTransaction Booleano Não Identifica que é uma retentativa de uma análise. Este campo deve ser enviado com valor igual a TRUE quando o código de retorno na primeira tentativa for igual a BP900, que identifica timeout entre Braspag e o Provedor. Este campo deve ser enviado somente quando Provedor igual a ReDShield.              
FraudAnalysis.SplitingPaymentMethod Texto 23 Não Identifica se a autorização da transação é com um ou dois cartões ou com mais de um meio de pagamento, por exemplo, cartão de crédito e boleto bancário. Enum: None -> Pagamento com um cartão apenas. (default) CardSplit -> Pagamento com mais de um cartão. MixedPaymentMethodSplit -> Pagamento com mais de um meio de pagamento.              
FraudAnalysis.FingerPrintId Texto 6005 Sim Impressão digital de dispositivos e geolocalização real do IP do comprador.              
FraudAnalysis.Browser.IpAddress Texto 15 Sim Endereço IP do comprador. É altamente recomendável o envio deste campo              
Cart.Items[n].Name Texto 50 Sim Nome do produto              
Cart.Items[n].Sku Texto 12 Sim Código comerciante identificador do produto              
Cart.Items[n].UnitPrice Número 15 Sim Preço unitário do produto              
Cart.Items[n].OriginalPrice Número 50 Sim Nome do produto              
Cart.Items[n].Quantity Número 15 Sim Quantidade de produtos              
Cart.Items[n].MerchantItemId Texto 30 Não Id do produto na loja              
Cart.Items[n].GiftMessage Texto 160 Não Mensagem de presente              
Cart.Items[n].Description Texto 76 Não Descrição do produto              
Cart.Items[n].ShippingInstructions Texto 160 Não Instruções de entrega do produto.              
Cart.Items[n].ShippingMethod Texto 27 Não Meio de entrega do produto. Ex.: SameDay = Meio de entrega no mesmo dia, NextDay = Meio de entrega no próximo dia, TwoDay = Meio de entrega em dois dias, ThreeDay = Meio de entrega em três dias, LowCost = Meio de entrega de baixo custo, Pickup = Retirada na loja, CarrierDesignatedByCustomer = Meio de entrega designada pelo comprador, International = Meio de entrega internacional, Military = Meio de entrega militar, Other = Outro meio de entrega, None = Sem meio de entrega, pois é um serviço ou assinatura.              
Cart.Items[n].ShippingTrackingNumber Texto 19 Não Número de rastreamento da transportadora              
Cart.Items[n].Passenger.Name Texto 61 Sim Nome do passageiro              
Cart.Items[n].Passenger.Identity Número 14 Sim Documento do comprador              
Cart.Items[n].Passenger.IdentityType Número 14 Sim Documento do comprador              
Cart.Items[n].Passenger.Status Texto 15 Não Classificação da empresa aérea. Ex.: Gold, Platinum              
Cart.Items[n].Passenger.Rating Texto 15 Sim Classificação do passageiro              
Cart.Items[n].Passenger.Email Texto 60 Sim Email do comprador              
Cart.Items[n].Passenger.Phone Numero 14 Não Número de telefone do passageiro              
Cart.Items[n].Passenger.DateOfBirth Date 10 Não Data de nascimento do passageiro              
FraudAnalysis.MerchantDefinedFields.Id Texto Sim (se aplicável) Id das informações adicionais a serem enviadas              
FraudAnalysis.MerchantDefinedFields.Value Texto 255 Sim (se aplicável) Valor das informações adicionais a serem enviadas              
FraudAnalysis.Items.GiftCategory Texto 9 Não Campo que avaliará os endereços de cobrança e entrega para difrentes cidades, estados ou países
Yes (Em caso de divergência entre endereços de cobrança e entrega, marca como risco pequeno)No (Em caso de divergência entre endereços de cobrança e entrega, marca com risco alto)Off (Ignora a análise de risco para endereços divergentes)
             
FraudAnalysis.Items.HostHedge Texto   Não Nível de importância do e-mail e endereços IP dos clientes em risco de pontuação.
Low (Baixa importância do e-mail e endereço IP na análise de risco)Normal (Média importância do e-mail e endereço IP na análise de risco)High (Alta importância do e-mail e endereço IP na análise de risco)Off (E-mail e endereço IP não afetam a análise de risco)
             
FraudAnalysis.Items.NonSensicalHedge Texto 6 Não Nível dos testes realizados sobre os dados do comprador com pedidos recebidos sem sentido.
Low (Baixa importância da verificação feita sobre o pedido do comprador, na análise de risco)Normal (Média importância da verificação feita sobre o pedido do comprador, na análise de risco)High (Alta importância da verificação feita sobre o pedido do comprador, na análise de risco)Off (Verificação do pedido do comprador não afeta a análise de risco)
             
FraudAnalysis.Items.ObscenitiesHedge Texto 6 Não Nível de obscenidade dos pedidos recebedidos.
Low (Baixa importância da verificação sobre obscenidades do pedido do comprador, na análise de risco)Normal (Média importância da verificação sobre obscenidades do pedido do comprador, na análise de risco)High (Alta importância da verificação sobre obscenidades do pedido do comprador, na análise de risco)Off (Verificação de obscenidade no pedido do comprador não afeta a análise de risco)
             
FraudAnalysis.Items.PhoneHedge Texto 6 Não Nível dos testes realizados com os números de telefones.
Low (Baixa importância nos testes realizados com números de telefone)Normal (Média importância nos testes realizados com números de telefone)High (Alta importância nos testes realizados com números de telefone)Off (Testes de números de telefone não afetam a análise de risco)
             
FraudAnalysis.Items.Name Texto 255 Sim Nome do Produto              
FraudAnalysis.Items.Quantity Número 15 Sim Quantidade do produto a ser adquirido              
FraudAnalysis.Items.Sku Texto 255 Sim Código comerciante identificador do produto              
FraudAnalysis.Items.UnitPrice Número 15 Sim Preço unitário do produto              
FraudAnalysis.Items.Risk Texto 6 Não Nível do risco do produto.
Low (O produto tem um histórico de poucos chargebacks)Normal (O produto tem um histórico de chargebacks considerado normal)High (O produto tem um histórico de chargebacks acima da média)
             
FraudAnalysis.Items.TimeHedge Texto   Não Nível de importância da hora do dia do pedido do cliente.
Low (Baixa importância no horário do dia em que foi feita a compra, para a análise de risco)Normal (Média importância no horário do dia em que foi feita a compra, para a análise de risco)High (Alta importância no horário do dia em que foi feita a compra, para a análise de risco)Off (O horário da compra não afeta a análise de risco)
             
FraudAnalysis.Items.Type Texto   Não Tipo do produto.
AdultContent(Conteúdo adulto)Coupon(Cupon de desconto)Default(Opção padrão para análise na CyberSource quando nenhum outro valor é selecionado)EletronicGood(Produto eletrônico)EletronicSoftware(Softwares distribuídos eletronicamente via download)GiftCertificate(Vale presente)HandlingOnly(Taxa de instalação ou manuseio)Service(Serviço)ShippingAndHandling(Frete e taxa de instalação ou manuseio)ShippingOnly(Frete)Subscription(Assinatura)
             
FraudAnalysis.Items.VelocityHedge Texto 6 Não Nível de importância de frequência de compra do cliente.
Low (Baixa importância no número de compras realizadas pelo cliente nos últimos 15 minutos)Normal (Média importância no número de compras realizadas pelo cliente nos últimos 15 minutos)High (Alta importância no número de compras realizadas pelo cliente nos últimos 15 minutos)Off (A frequência de compras realizadas pelo cliente não afeta a análise de fraude)
             
FraudAnalysis.Items.Passenger.Email Texto 255 Não Email do Passageiro              
FraudAnalysis.Items.Passenger.Identity Texto 32 Não Id do passageiro a quem o bilheite foi emitido              
FraudAnalysis.Items.Passenger.Name Texto 120 Não Nome do passageiro              
FraudAnalysis.Items.Passenger.Rating Texto   Não Classificação do Passageiro.
Adult (Passageiro adulto)Child(Passageiro criança)Infant(Passageiro infantil)Youth(Passageiro adolescente)Student(Passageiro estudante)SeniorCitizen(Passageiro idoso)Military(Passageiro militar)
             
FraudAnalysis.Items.Passenger.Phone Texto 15 Não Número do telefone do passageiro. Para pedidos fora do U.S., a CyberSource recomenda que inclua o código do país. 552133665599 (Ex. Código do Pais 55, Código da Cidade 21, Telefone 33665599)              
FraudAnalysis.Items.Passenger.Status Texto 32 Não Classificação da empresa aérea. Pode-se usar valores como Gold ou Platina              
FraudAnalysis.Shipping.Addressee Texto 61 Não Nome do destinatário da entrega              
FraudAnalysis.Shipping.Email Texto 60 Não E-mail do responsável por receber o produto              
FraudAnalysis.Shipping.Method Texto   Não Tipo de serviço de entrega do produto.
SameDay(Serviço de entrega no mesmo dia)OneDay(Serviço de entrega noturna ou no dia seguint)TwoDay(Serviço de entrega em dois dias)ThreeDay(Serviço de entrega em três dias)LowCost(Serviço de entrega de baixo custo)Pickup(Produto retirado na loja)Other(Outro método de entrega)None(Sem serviço de entrega, pois é um serviço ou assinatura)
    FraudAnalysis.Shipping.Phone Texto 15 Não Telefone do destinatário da entrega. Ex. 552133665599 (Código do Pais 55, Código da Cidade 21, Telefone 33665599)
FraudAnalysis.Shipping.Phone Número 19 Não Telefone do responsável por receber o produto              
FraudAnalysis.CustomConfiguration.MerchantWebsite Texto 60 Não Website da loja              
FraudAnalysis.Travel.ThirdPartyBooking Booleano Não (Default false) Booleano que indica se a passagem destina-se a um terceiro (true) ou não (false).              
FraudAnalysis.Travel.BookingType Texto 100 Sim, caso o nó “Travel” seja enviado. Tipo da reserva. Valores: “Corporate”              
FraudAnalysis.Travel.TicketDeliveryMethod Texto 100 Sim, caso o nó “Travel” seja enviado. Método de entrega do bilhete. Valores: “Delivery” ,            
FraudAnalysis.Travel.BookingReferenceNumber Texto 10 Sim, caso o nó “Travel” seja enviado. Número de referência da reserva.              
FraudAnalysis.Travel.Passengers.Name Texto 61 Sim, caso o nó “Travel” seja enviado. Nome do passageiro.              
FraudAnalysis.Travel.Passengers.Identity Texto 14 Sim, caso o nó “Travel” seja enviado. Documento de identificação do passageiro.              
FraudAnalysis.Travel.Passengers.Status Texto 15 Sim, caso o nó “Travel” seja enviado. Classificação da empresa aérea. Ex.: “Gold”, “Platinum”.              
FraudAnalysis.Travel.Passengers.Rating Texto 15 Sim, caso o nó “Travel” seja enviado. Classificação do Passageiro.
Valores do Campo:
“Adult” (Passageiro adulto)
“Child”(Passageiro criança)
Infant”(Passageiro infantil)
Youth”(Passageiro adolescente)
Student”(Passageiro estudante)
SeniorCitizen“(Passageiro idoso)
Military“(Passageiro militar)
             
FraudAnalysis.Travel.Passengers.Email Texto 60 Sim, caso o nó “Travel” seja enviado. E-mail do passageiro.              
FraudAnalysis.Travel.Passengers.Phone Texto 14 Sim, caso o nó “Travel” seja enviado. Número de telefone do passageiro.              
FraudAnalysis.Travel.Passengers.TicketNumber Texto 20 Sim, caso o nó “Travel” seja enviado. Número do bilhete. Ex.: “123456”.              
FraudAnalysis.Travel.Passengers.FrequentFlyerNumber Texto 50 Sim, caso o nó “Travel” seja enviado. Número de fidelidade do passageiro. Ex: “159753852”.              
FraudAnalysis.Travel.Passengers.TravelLegs.Origin Texto 3 Sim, caso o nó “Travel” seja enviado. Código do aeroporto do ponto de origem da viagem. Ex.: “AMS”.              
FraudAnalysis.Travel.Passengers.TravelLegs.Destination Texto 3 Sim, caso o nó “Travel” seja enviado. Código do aeroporto do ponto de destino da viagem. Ex.: “GIG”.              
FraudAnalysis.Travel.Passengers.TravelLegs.DepartureCountry Texto 3 Sim, caso o nó “Travel” seja enviado. País de partida. Ex.: “BRA”.              
FraudAnalysis.Travel.Passengers.TravelLegs.ArrivalCountry Texto 3 Sim, caso o nó “Travel” seja enviado. País de chegada. Ex.: “NLD”.              
FraudAnalysis.Travel.Passengers.TravelLegs.AirlineCode Texto 3 Sim, caso o nó “Travel” seja enviado. Código da companhia aérea. Ex.: “KLM”.              
FraudAnalysis.Travel.Passengers.TravelLegs.DepartureDate DateTime Sim, caso o nó “Travel” seja enviado. Data, hora e minuto de partida do vôo. Ex: “2018-01-09 18:00:00”.              
FraudAnalysis.Travel.Passengers.TravelLegs.ClassOfService Texto 30 Sim, caso o nó “Travel” seja enviado. Classe do serviço. Ex: “Standard”.              

Resposta

{
    "MerchantOrderId": "201411170314344356",
    "Customer": {
        "Name": "Comprador Teste",
        "Identity": "46286005030",
        "IdentityType": "CPF",
        "Email": "comprador_teste@live.com",
        "Phone": "552125553669",
        "Birthdate": "1986-08-01",
        "Address": {
            "Street": "Rua Teste",
            "Number": "500",
            "Complement": "AP 205",
            "ZipCode": "21002320",
            "City": "Rio de Janeiro",
            "State": "RJ",
            "Country": "BR",
            "District": "Tijuca"
        },
        "DeliveryAddress": {
            "Street": "Av Marechal Camara",
            "Number": "160",
            "Complement": "Sala 934",
            "ZipCode": "20020080",
            "City": "Rio de Janeiro",
            "State": "RJ",
            "Country": "BR",
            "District": "Centro",
            "Comment": "Ao lado do banco Santander"
        },
        "Status": "New",
        "WorkPhone": "552121544788",
        "Mobile": "5521995760078"
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "Authenticate": false,
        "Recurrent": false,
        "CreditCard": {
            "CardNumber": "471622******6310",
            "Holder": "Teste Holder",
            "ExpirationDate": "12/2021",
            "SaveCard": false,
            "Brand": "Visa"
        },
        "ProofOfSale": "2110886",
        "AcquirerTransactionId": "0619022110886",
        "AuthorizationCode": "595071",
        "FraudAnalysis": {
            "Sequence": "AnalyseFirst",
            "SequenceCriteria": "Always",
            "FingerPrintId": "04003hQUMXGB0poNf94lis1ztuLYRFk+zJ17aP79a9O8mWOBmEnKs6ziAo94ggAtBvKEN6/FI8Vv2QMAyHLnc295s0Nn8akZzRJtHwsEilYx1P+NzuNQnyK6+7x2OpjJZkl4NlfPt7h9d96X/miNlYT65UIY2PeH7sUAh9vKxMn1nlPu2MJCSi12NBBoiZbfxP1Whlz5wlRFwWJi0FRulruXQQGCQaJkXU7GWWZGI8Ypycnf7F299GIR12G/cdkIMFbm6Yf0/pTJUUz1vNp0X2Zw8QydKgnOIDKXq4HnEqNOos1c6njJgQh/4vXJiqy0MXMQOThNipDmXv9I185O+yC2f3lLEO0Tay66NZEyiLNePemJKSIdwO9O5ZtntuUkG6NTqARuHStXXfwp8cyGF4MPWLuvNvEfRkJupBy3Z8hSEMEK7ZWd2T2HOihQxRh4qp+NANqYKBTl3v6fQJAEKikeSQVeBN8sQqAL0BZFaIMzbrnMivi6m6JRQUIdvEt+MbJEPFc0LjRycC5ApUmJO+Aoo9VKL1B8ftMSQ1iq1uTKn16ZOmDpzZrZhMPbH83aV0rfB2GDXcjpghm9klVFOw7EoYzV7IDBIIRtgqG9KZ+8NH/z6D+YNUMLEUuK1N2ddqKbS5cKs2hplVRjwSv7x8lMXWE7VDaOZWB8+sD1cMLQtEUC0znzxZ4bpRaiSy4dJLxuJpQYAFUrDlfSKRv/eHV3QiboXLuw9Lm6xVBK8ZvpD5d5olGQdc+NgsqjFnAHZUE+OENgY4kVU9wB84+POrI4MkoD4iHJ5a1QF8AZkZDFo1m1h9Bl+J2Ohr6MkBZq8DG5iVaunHfxUdHou5GL7lS1H7r+8ctfDXi8AfOPjzqyODJQ74Aiel35TKTOWG8pq1WO6yzJ1GNmMuMWZBamlGXoG/imnjwHY9HQtQzpGfcm0cR8X2Fd1ngNFGLDGZlWOX0jWtOwU6XVGT37JFD9W/cx4kzI+mPNi65X5WFPYlDG9N0Lbh5nOj3u3DXqRCiKCUrsEkMt8z9fxO9pLLGVQUKIYR2wTw53CiWK96FOpPevDWtH2XR0QkfOd02D73n81x6hEMCy0s3hRLn08Th9FlNHDMJBqLj+Tz8rG2TtNki3mJC7Ass1MT2qnKBI77n6vsQkAp59TfbZm/tBXwAoYdLJXge8F/numhd5AvQ+6I8ZHGJfdN3qWndvJ2I7s5Aeuzb8t9//eNsm73fIa05XreFsNyfOq1vG2COftC6EEsoJWe5h5Nwu1x6PIKuCaWxLY+npfWgM0dwJPmSgPx7TNM31LyVNS65m83pQ+qMTRH6GRVfg7HAcS5fnS/cjdbgHxEkRmgkRq1Qs48sbX9QC8nOTD0ntb6FcJyEOEOVzmJtDqimkzDq+SXR1/63AYe4LEj+ogRgN+Z8HAFhGFzd/m6snVviELfRqJ4LLQIk9Y/fzqnsF6I5OGxfdT2sxxK2Vokpi3jWhCcEknw7dYlHYpOnCHZO7QVgjQTngF2mzKf4GeOF4ECFsWTgLy6HFEitfauYJt1Xh1NfZZerBMwXLFzdhzoTQxGlcXc8lZIoEG1BLYv/ScICf8Ft9PEtpEa+j0cDSlU99UoH2xknwR1W9MRGc5I/euE63/IMJTqguZ3YcnJpjSVnAGSpyz/0gKjypJ3L86rHFRGXt0QbmaXtSl2UmmjI0p0LCCdx7McatCFEVI6FwPpPV0ZSMv/jM75eBid1X/lTV4XNzjowzR/iFlKYMzHZtVO9hCBPKlTwblRXNn4MlvNm/XeSRQ+Mr0YV5w5CL5Z/tGyzqnaLPj/kOVdyfj8r2m5Bcrz4g/ieUIo8qRFv2T2mET46ydqaxi27G4ZYHj7hbiaIqTOxWaE07qMCkJw==",
            "Provider": "RedShield",
            "CaptureOnLowRisk": true,
            "VoidOnHighRisk": true,
            "TotalOrderAmount": 16700,
            "IsRetryTransaction": false,
            "SplitingPaymentMethod": "None",
            "CustomConfiguration": {
                "RiskAmount": 0,
                "MerchantWebsite": "http://www.test.com"
            },
            "MerchantDefinedFields": [{
                "Id": "95",
                "Value": "Definido pelo cliente junto ao provedor"
            }, {
                "Id": "96",
                "Value": "Definido pelo cliente junto ao provedor"
            }],
            "Cart": {
                "IsGift": false,
                "ReturnsAccepted": false,
                "Items": [{
                    "Type": "Undefined",
                    "Name": "Nome do produto",
                    "Risk": "Undefined",
                    "Sku": "201411170235",
                    "UnitPrice": 10950,
                    "Quantity": 1,
                    "HostHedge": "Undefined",
                    "NonSensicalHedge": "Undefined",
                    "ObscenitiesHedge": "Undefined",
                    "PhoneHedge": "Undefined",
                    "TimeHedge": "Undefined",
                    "VelocityHedge": "Undefined",
                    "GiftCategory": "Undefined",
                    "Passenger": {
                        "Name": "Passageiro Teste1",
                        "Identity": "1234567891",
                        "Status": "Platinum",
                        "Rating": "Student",
                        "Email": "passageiro_teste1@live.com",
                        "Phone": "55999993333",
                        "DateOfBirth": "1988-01-06"
                    },
                    "OriginalPrice": 11490,
                    "Description": "Descricao do produto",
                    "Weight": 0,
                    "GiftMessage": "Mensagem para presente",
                    "ShippingInstructions": "Proximo ao 546",
                    "ShippingMethod": "SameDay",
                    "ShippingTrackingNumber": "123456",
                    "CartType": 0,
                    "MerchantItemId": "45584"
                }, {
                    "Type": "Undefined",
                    "Name": "Nome do produto",
                    "Risk": "Undefined",
                    "Sku": "20141117023",
                    "UnitPrice": 10950,
                    "Quantity": 2,
                    "HostHedge": "Undefined",
                    "NonSensicalHedge": "Undefined",
                    "ObscenitiesHedge": "Undefined",
                    "PhoneHedge": "Undefined",
                    "TimeHedge": "Undefined",
                    "VelocityHedge": "Undefined",
                    "GiftCategory": "Undefined",
                    "Passenger": {
                        "Name": "Passageiro Teste2",
                        "Identity": "1234567892",
                        "Status": "Gold",
                        "Rating": "Adult",
                        "Email": "passageiro_teste2@live.com",
                        "Phone": "5521999994444",
                        "DateOfBirth": "1958-07-06"
                    },
                    "OriginalPrice": 11490,
                    "Description": "Descricao do produto",
                    "Weight": 0,
                    "GiftMessage": "Mensagem para presente",
                    "ShippingInstructions": "Proximo ao 160",
                    "ShippingMethod": "NextDay",
                    "ShippingTrackingNumber": "654321",
                    "CartType": 0,
                    "MerchantItemId": "45585"
                }]
            },
            "Travel": {
                "Route": "GIG-CGH-EZE",
                "DepartureTime": "2016-12-10T15:10:15",
                "JourneyType": "OneWayTrip",
                "Legs": [{
                    "Destination": "CGH",
                    "Origin": "GIG"
                }, {
                    "Destination": "EZE",
                    "Origin": "CGH"
                }]
            },
            "Browser": {
                "CookiesAccepted": false,
                "IpAddress": "187.32.163.105"
            },
            "Shipping": {
                "Addressee": "Destinatario Teste",
                "Phone": "5521995950277",
                "Method": "LowCost",
                "Email": "destinatario_teste@live.com"
            },
            "Id": "a97eb2ae-1355-e711-93ff-000d3ac03bed",
            "Status": 0,
            "StatusDescription": "Unknown",
            "ReplyData": {
                "FactorCode": "200.300.404",
                "ReturnMessage": "invalid or missing parameter",
                "ProviderOrderId": "000548000001XBU20180326092505379",
                "ReturnCode": "0100"

            }
        },
        "PaymentId": "949e33e4-d410-4212-b111-d9c8fdc0580d",
        "Type": "CreditCard",
        "Amount": 15700,
        "ReceivedDate": "2017-06-19 14:21:07",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Simulado",
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "Status": 1,
        "ProviderReturnCode": "4",
        "ProviderReturnMessage": "Operation Successful",
        "Links": [{
            "Method": "GET",
            "Rel": "self",
            "Href": "https://apiquerydev.braspag.com.br/v2/sales/949e33e4-d410-4212-b111-d9c8fdc0580d"
        }, {
            "Method": "PUT",
            "Rel": "capture",
            "Href": "https://apidev.braspag.com.br/v2/sales/949e33e4-d410-4212-b111-d9c8fdc0580d/capture"
        }, {
            "Method": "PUT",
            "Rel": "void",
            "Href": "https://apidev.braspag.com.br/v2/sales/949e33e4-d410-4212-b111-d9c8fdc0580d/void"
        }]
    }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "MerchantOrderId": "201411170314344356",
    "Customer": {
        "Name": "Comprador Teste",
        "Identity": "46286005030",
        "IdentityType": "CPF",
        "Email": "comprador_teste@live.com",
        "Phone": "552125553669",
        "Birthdate": "1986-08-01",
        "Address": {
            "Street": "Rua Teste",
            "Number": "500",
            "Complement": "AP 205",
            "ZipCode": "21002320",
            "City": "Rio de Janeiro",
            "State": "RJ",
            "Country": "BR",
            "District": "Tijuca"
        },
        "DeliveryAddress": {
            "Street": "Av Marechal Camara",
            "Number": "160",
            "Complement": "Sala 934",
            "ZipCode": "20020080",
            "City": "Rio de Janeiro",
            "State": "RJ",
            "Country": "BR",
            "District": "Centro",
            "Comment": "Ao lado do banco Santander"
        },
        "Status": "New",
        "WorkPhone": "552121544788",
        "Mobile": "5521995760078"
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": "ByMerchant",
        "Capture": true,
        "Authenticate": false,
        "Recurrent": false,
        "CreditCard": {
            "CardNumber": "471622******6310",
            "Holder": "Teste Holder",
            "ExpirationDate": "12/2021",
            "SaveCard": false,
            "Brand": "Visa"
        },
        "ProofOfSale": "2110886",
        "AcquirerTransactionId": "0619022110886",
        "AuthorizationCode": "595071",
        "FraudAnalysis": {
            "Sequence": "AnalyseFirst",
            "SequenceCriteria": "Always",
            "FingerPrintId": "04003hQUMXGB0poNf94lis1ztuLYRFk+zJ17aP79a9O8mWOBmEnKs6ziAo94ggAtBvKEN6/FI8Vv2QMAyHLnc295s0Nn8akZzRJtHwsEilYx1P+NzuNQnyK6+7x2OpjJZkl4NlfPt7h9d96X/miNlYT65UIY2PeH7sUAh9vKxMn1nlPu2MJCSi12NBBoiZbfxP1Whlz5wlRFwWJi0FRulruXQQGCQaJkXU7GWWZGI8Ypycnf7F299GIR12G/cdkIMFbm6Yf0/pTJUUz1vNp0X2Zw8QydKgnOIDKXq4HnEqNOos1c6njJgQh/4vXJiqy0MXMQOThNipDmXv9I185O+yC2f3lLEO0Tay66NZEyiLNePemJKSIdwO9O5ZtntuUkG6NTqARuHStXXfwp8cyGF4MPWLuvNvEfRkJupBy3Z8hSEMEK7ZWd2T2HOihQxRh4qp+NANqYKBTl3v6fQJAEKikeSQVeBN8sQqAL0BZFaIMzbrnMivi6m6JRQUIdvEt+MbJEPFc0LjRycC5ApUmJO+Aoo9VKL1B8ftMSQ1iq1uTKn16ZOmDpzZrZhMPbH83aV0rfB2GDXcjpghm9klVFOw7EoYzV7IDBIIRtgqG9KZ+8NH/z6D+YNUMLEUuK1N2ddqKbS5cKs2hplVRjwSv7x8lMXWE7VDaOZWB8+sD1cMLQtEUC0znzxZ4bpRaiSy4dJLxuJpQYAFUrDlfSKRv/eHV3QiboXLuw9Lm6xVBK8ZvpD5d5olGQdc+NgsqjFnAHZUE+OENgY4kVU9wB84+POrI4MkoD4iHJ5a1QF8AZkZDFo1m1h9Bl+J2Ohr6MkBZq8DG5iVaunHfxUdHou5GL7lS1H7r+8ctfDXi8AfOPjzqyODJQ74Aiel35TKTOWG8pq1WO6yzJ1GNmMuMWZBamlGXoG/imnjwHY9HQtQzpGfcm0cR8X2Fd1ngNFGLDGZlWOX0jWtOwU6XVGT37JFD9W/cx4kzI+mPNi65X5WFPYlDG9N0Lbh5nOj3u3DXqRCiKCUrsEkMt8z9fxO9pLLGVQUKIYR2wTw53CiWK96FOpPevDWtH2XR0QkfOd02D73n81x6hEMCy0s3hRLn08Th9FlNHDMJBqLj+Tz8rG2TtNki3mJC7Ass1MT2qnKBI77n6vsQkAp59TfbZm/tBXwAoYdLJXge8F/numhd5AvQ+6I8ZHGJfdN3qWndvJ2I7s5Aeuzb8t9//eNsm73fIa05XreFsNyfOq1vG2COftC6EEsoJWe5h5Nwu1x6PIKuCaWxLY+npfWgM0dwJPmSgPx7TNM31LyVNS65m83pQ+qMTRH6GRVfg7HAcS5fnS/cjdbgHxEkRmgkRq1Qs48sbX9QC8nOTD0ntb6FcJyEOEOVzmJtDqimkzDq+SXR1/63AYe4LEj+ogRgN+Z8HAFhGFzd/m6snVviELfRqJ4LLQIk9Y/fzqnsF6I5OGxfdT2sxxK2Vokpi3jWhCcEknw7dYlHYpOnCHZO7QVgjQTngF2mzKf4GeOF4ECFsWTgLy6HFEitfauYJt1Xh1NfZZerBMwXLFzdhzoTQxGlcXc8lZIoEG1BLYv/ScICf8Ft9PEtpEa+j0cDSlU99UoH2xknwR1W9MRGc5I/euE63/IMJTqguZ3YcnJpjSVnAGSpyz/0gKjypJ3L86rHFRGXt0QbmaXtSl2UmmjI0p0LCCdx7McatCFEVI6FwPpPV0ZSMv/jM75eBid1X/lTV4XNzjowzR/iFlKYMzHZtVO9hCBPKlTwblRXNn4MlvNm/XeSRQ+Mr0YV5w5CL5Z/tGyzqnaLPj/kOVdyfj8r2m5Bcrz4g/ieUIo8qRFv2T2mET46ydqaxi27G4ZYHj7hbiaIqTOxWaE07qMCkJw==",
            "Provider": "RedShield",
            "CaptureOnLowRisk": true,
            "VoidOnHighRisk": true,
            "TotalOrderAmount": 16700,
            "IsRetryTransaction": false,
            "SplitingPaymentMethod": "None",
            "CustomConfiguration": {
                "RiskAmount": 0,
                "MerchantWebsite": "http://www.test.com"
            },
            "MerchantDefinedFields": [{
                "Id": "95",
                "Value": "Definido pelo cliente junto ao provedor"
            }, {
                "Id": "96",
                "Value": "Definido pelo cliente junto ao provedor"
            }],
            "Cart": {
                "IsGift": false,
                "ReturnsAccepted": false,
                "Items": [{
                    "Type": "Undefined",
                    "Name": "Nome do produto",
                    "Risk": "Undefined",
                    "Sku": "201411170235",
                    "UnitPrice": 10950,
                    "Quantity": 1,
                    "HostHedge": "Undefined",
                    "NonSensicalHedge": "Undefined",
                    "ObscenitiesHedge": "Undefined",
                    "PhoneHedge": "Undefined",
                    "TimeHedge": "Undefined",
                    "VelocityHedge": "Undefined",
                    "GiftCategory": "Undefined",
                    "Passenger": {
                        "Name": "Passageiro Teste1",
                        "Identity": "1234567891",
                        "Status": "Platinum",
                        "Rating": "Student",
                        "Email": "passageiro_teste1@live.com",
                        "Phone": "55999993333",
                        "DateOfBirth": "1988-01-06"
                    },
                    "OriginalPrice": 11490,
                    "Description": "Descricao do produto",
                    "Weight": 0,
                    "GiftMessage": "Mensagem para presente",
                    "ShippingInstructions": "Proximo ao 546",
                    "ShippingMethod": "SameDay",
                    "ShippingTrackingNumber": "123456",
                    "CartType": 0,
                    "MerchantItemId": "45584"
                }, {
                    "Type": "Undefined",
                    "Name": "Nome do produto",
                    "Risk": "Undefined",
                    "Sku": "20141117023",
                    "UnitPrice": 10950,
                    "Quantity": 2,
                    "HostHedge": "Undefined",
                    "NonSensicalHedge": "Undefined",
                    "ObscenitiesHedge": "Undefined",
                    "PhoneHedge": "Undefined",
                    "TimeHedge": "Undefined",
                    "VelocityHedge": "Undefined",
                    "GiftCategory": "Undefined",
                    "Passenger": {
                        "Name": "Passageiro Teste2",
                        "Identity": "1234567892",
                        "Status": "Gold",
                        "Rating": "Adult",
                        "Email": "passageiro_teste2@live.com",
                        "Phone": "5521999994444",
                        "DateOfBirth": "1958-07-06"
                    },
                    "OriginalPrice": 11490,
                    "Description": "Descricao do produto",
                    "Weight": 0,
                    "GiftMessage": "Mensagem para presente",
                    "ShippingInstructions": "Proximo ao 160",
                    "ShippingMethod": "NextDay",
                    "ShippingTrackingNumber": "654321",
                    "CartType": 0,
                    "MerchantItemId": "45585"
                }]
            },
            "Travel": {
                "Route": "GIG-CGH-EZE",
                "DepartureTime": "2016-12-10T15:10:15",
                "JourneyType": "OneWayTrip",
                "Legs": [{
                    "Destination": "CGH",
                    "Origin": "GIG"
                }, {
                    "Destination": "EZE",
                    "Origin": "CGH"
                }]
            },
            "Browser": {
                "CookiesAccepted": false,
                "IpAddress": "187.32.163.105"
            },
            "Shipping": {
                "Addressee": "Destinatario Teste",
                "Phone": "5521995950277",
                "Method": "LowCost",
                "Email": "destinatario_teste@live.com"
            },
            "Id": "a97eb2ae-1355-e711-93ff-000d3ac03bed",
            "Status": 0,
            "StatusDescription": "Unknown",
            "ReplyData": {
                "FactorCode": "200.300.404",
                "ReturnMessage": "invalid or missing parameter",
                "ProviderOrderId": "000548000001XBU20180326092505379",
                "ReturnCode": "0100"

            }
        },
        "PaymentId": "949e33e4-d410-4212-b111-d9c8fdc0580d",
        "Type": "CreditCard",
        "Amount": 15700,
        "ReceivedDate": "2017-06-19 14:21:07",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Simulado",
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "Status": 1,
        "ProviderReturnCode": "4",
        "ProviderReturnMessage": "Operation Successful",
        "Links": [{
            "Method": "GET",
            "Rel": "self",
            "Href": "https://apiquerydev.braspag.com.br/v2/sales/949e33e4-d410-4212-b111-d9c8fdc0580d"
        }, {
            "Method": "PUT",
            "Rel": "capture",
            "Href": "https://apidev.braspag.com.br/v2/sales/949e33e4-d410-4212-b111-d9c8fdc0580d/capture"
        }, {
            "Method": "PUT",
            "Rel": "void",
            "Href": "https://apidev.braspag.com.br/v2/sales/949e33e4-d410-4212-b111-d9c8fdc0580d/void"
        }]
    }
}
Propriedade Descrição Tipo Tamanho Formato
AcquirerTransactionId Id da transação no provedor de meio de pagamento Texto 40 Texto alfanumérico
ProofOfSale Número do Comprovante de Venda Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização Texto 300 Texto alfanumérico
SoftDescriptor Texto que será impresso na fatura do portador Texto 13 Texto alfanumérico
PaymentId Campo Identificador do Pedido Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ReceivedDate Data em que a transação foi recebida pela Brapag Texto 19 AAAA-MM-DD HH:mm:SS
ReasonCode Código de retorno da Operação Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da Operação Texto 512 Texto alfanumérico
Status Status da Transação Byte 2 Ex. 1
ProviderReturnCode Código retornado pelo provedor do meio de pagamento (adquirente e bancos) Texto 32 57
ProviderReturnMessage Mensagem retornada pelo provedor do meio de pagamento (adquirente e bancos) Texto 512 Transação Aprovada
FraudAnalysis.Id Indentificação da Transação no Antifraud Texto 300 Texto alfanumérico
FraudAnalysis.Status Status da Transação Byte 1 Ex. 1
FraudAnalysis.ReplyData.FactorCode Combinação de códigos que indicam o score do pedido. Os códigos são concatenados usando o caractere ^ Texto 100 Ex: B^D^R^Z
A - Mudança de endereço excessiva. O cliente mudou o endereço de cobrança duas ou mais vezes nos últimos seis meses.B - BIN do cartão ou autorização de risco. Os fatores de risco estão relacionados com BIN de cartão de crédito e/ou verificações de autorização do cartão.C - Elevado números de cartões de créditos. O cliente tem usado mais de seis números de cartões de créditos nos últimos seis meses.D - Impacto do endereço de e-mail. O cliente usa um provedor de e-mail gratuito ou o endereço de email é arriscado.E - Lista positiva. O cliente está na sua lista positiva.F - Lista negativa. O número da conta, endereço, endereço de e-mail ou endereço IP para este fim aparece sua lista negativa.G - Inconsistências de geolocalização. O domínio do cliente de e-mail, número de telefone, endereço de cobrança, endereço de envio ou endereço IP é suspeito.H - Excessivas mudanças de nome. O cliente mudou o nome duas ou mais vezes nos últimos seis meses.I - Inconsistências de internet. O endereço IP e de domínio de e-mail não são consistentes com o endereço de cobrança.N - Entrada sem sentido. O nome do cliente e os campos de endereço contém palavras sem sentido ou idioma.O - Obscenidades. Dados do cliente contém palavras obscenas.P - Identidade morphing. Vários valores de um elemento de identidade estão ligados a um valor de um elemento de identidade diferentes. Por exemplo, vários números de telefone estão ligados a um número de conta única.Q - Inconsistências do telefone. O número de telefone do cliente é suspeito.R - Ordem arriscada. A transação, o cliente e o lojista mostram informações correlacionadas de alto risco.T - Cobertura Time. O cliente está a tentar uma compra fora do horário esperado.U - Endereço não verificável. O endereço de cobrança ou de entrega não pode ser verificado.V - Velocity. O número da conta foi usado muitas vezes nos últimos 15 minutos.W - Marcado como suspeito. O endereço de cobrança ou de entrega é semelhante a um endereço previamente marcado como suspeito.Y - O endereço, cidade, estado ou país dos endereços de cobrança e entrega não se correlacionam.Z - Valor inválido. Como a solicitação contém um valor inesperado, um valor padrão foi substituído. Embora a transação ainda possa ser processada, examinar o pedido com cuidado para detectar anomalias.
FraudAnalysis.ReplyData.ProviderOrderId Indentificação da Transação no provedor de antifraude. Texto 100 Ex: “000548000001XAT20180618101841546”
FraudAnalysis.ReplyData.ReturnCode Código retornado pelo provedor do antifraude. Texto 100 Ex: “0100”

Configuração do Fingerprint

Esta página descreve como funciona e como configurar o fingerprint em sua página de checkout e mobiles.

ReDShield

Integração com sua página de checkout(site)

Como funciona?

Fluxo

1 - A página de checkout da loja envia os atributos do dispositivo do comprador para a Iovation, criando assim a caixa preta
2 - O lojista recebe a sequência de caracteres criptografados da Iovation e escreve o mesmo na página de checkout em um campo do tipo hidden
3 - O lojista envia para a Braspag, junto com os demais dados da transação a ser analisada, a caixa preta
4 - A Braspag recebe todos os dados, valida e envia para a ReD Shield
5 - A ReD Shield recebe todos os dados, envia a caixa preta para a Iovation descriptografar
6 - A Red Shield recebe da Iovation os atributos do dispositivo do comprador

Como configurar?

1 - Inclua o javascript da Iovation em sua página de checkout
2 - Adicione parâmetros de configuração no javascript
3 - Crie um campo do tipo hidden em sua página para escrever a caixa preta nele e enviá-lo junto com os dados da transação a ser analisada

Obs.: Não realize cache do script, pois pode ocorrer de vários dispositovos sejam identificados como sendo o mesmo.

Para incluir o javascript, adicione o seguinte elemento <script> na sua página de checkout.

Esta é a URL da versão do snare.js da Iovation: <script type=”text/javascript” src=”https://mpsnare.iesnare.com/snare.js”></script>

Parâmetro Descrição Default
io_install_flash Determina se será solicitado ao usuário a instalação do Flash ou atualização da versão false
io_flash_needs_handler Este parâmetro só terá validade se o parâmetro io_install_flash estiver configurado como TRUE, caso contrário não será executado
É possível aqui customizar sua própria mensagem caso o Flash não esteja instalado
Ex.: var io_flash_needs_handler = “Alert(‘Instalar Flash’);”
-
io_install_stm Determina se será solicitado ao usuário a instalação do Active X, que ajuda a coletar informações do hardware
Este controle está disponível somente para o Internet Explorer, e caso o Active X já se encontre instalado, esta configuração não terá efeito
false
io_exclude_stm Determina se o Active X deverá ser executado quando instalado
É possível optar por desativar o controle para plataformas específicas
Possíveis valores:
0 - executa em todas as plataformas
1 - não executa no Windows 9.x (incluindo as versões 3.1, 95, 98 e ME)
2 - não executa no Windows CE
4 - não executa no Windows XP (incluindo as versões NT, 2000, 2003 e 8)
8 - não executa no Windows Vista
Obs.: Os valores são a combinação de somas dos valores acima, por exemplo: 12 - não executa no Windows XP (4) ou no Windows Vista (8)
15
io_bbout_element_id Id do elemento HTML para preencher com a caixa preta
Se o parâmetro io_bb_callback for definido, este não terá efeito
-
io_enable_rip Determina se tentará coletar informações para obter o IP real do usuário true
io_bb_callback Parâmetro para customizar a checagem da coleta da caixa preta foi concluída
Ao utilizar, escrever a função conforme com a seguinte sintaxe:
io_callback(bb, complete), onde:
bb - valor da caixa preta
complete - valor booleano que indica que a coleta foi concluída
-

IMPORTANTE! Os parâmetros de configuração devem ser colocados antes da chamada da tag acima. Eles determinam como javascript do iovation funcionará, e podem ocorrer erros caso os mesmos sejam colocados antes da chamada do javascript.

Exemplo Exemplo HTML

Integração em aplicativos mobile

Visão Geral Este tópico explica como integrar o mobile SDK da Iovation em seus aplicativos para iOS e Android.

Baixando o SDK Se você ainda não baixou o SDK do iOS ou do Android, deve fazê-lo antes de continuar. Para isso acesse um dos links abaixo de acordo com o desejado.
Download Deviceprint SDK iOS
Download Deviceprint SDK Android

Sobre a integração Adicione o Iovation Mobile SDK aos seus aplicativos para coletar informações sobre os dispositivos dos usuários finais. Será gerada uma caixa preta que contém todas as informações do dispositivo disponíveis.

Fluxo da coleta do fingerprint mobile

Integrando com aplicativos iOS

Arquivos e requisitos de integração do iOS Detalhes integração iOS

Esta versão suporta iOS 5.1.1 ou superior nos seguintes dispositivos:

1 - Baixe e descompacte o SDK

2 - No Xcode, arraste iovation.framework na área de navegação do seu projeto Detalhes instalação SDK

3 - Na caixa de diálogo que aparece:

4 - Clique em Finish

5 - Adicione os frameworks a seguir ao destino da aplicação no XCode: ExternalAccessory.framework. Se você verificar que o Wireless Accessory Configuration está ativado no Xcode 6 ou superior e não precisa, desativa e adicione novamente o ExternalAccessory.framework CoreTelephony.framework Detalhes instalação SDK

6 - Opcionalmente, adicione esses frameworks se o seu aplicativo fizer uso deles: AdSupport.framework. Se o seu aplicativo exibe anúncios Obs.: Não incluir se o seu aplicativo não utilizar anúncios, pois a App Store rejeita aplicativos que incluem o framework mas não usam anúncios CoreLocation.framework. Se o seu aplicativo usa monitoramento local Obs.: Não incluir, a menos que seu aplicativo solicite permissão de geolocalização do usuário

A função +ioBegin coleta informações sobre o dispositivo e gera uma caixa preta. Esta caixa preta deverá ser enviada através do campo CustomerData.BrowserFingerPrint em conjunto com os outros dados para análise.

NSSstring * bbox = [iovation ioBegin]

bbox - string que contem a caixa preta

IMPORTANTE! A caixa preta que retornou de +ioBegin nunca deve estar vazio. Uma caixa preta vazia indica que a proteção oferecida pelo sistema pode ter sido comprometida.

Exemplo Exemplo Código

Integrando com aplicativos Android

Arquivos e requisitos de integração do Android Detalhes

NOTA Se as permissões listadas não são necessárias pelo aplicativo, os valores obtidos obtidos utilizando essas permissões serão ignorados. As permissões não são necessárias para obter uma caixa preta, mas ajudam a obter mais informações do dispositivo.

A versão 1.2.0 do Iovation Mobile SDK para Android suporta versões do Android 2.1 ou superior.

1 - Baixe e descompacte o deviceprint-lib-1.2.0.aar
2 - Inicie o IDE de sua escolha
3 - No Eclipse e Maven, faça o deploy do arquivo de extensão .aar no repositório Maven local, usando o maven-deploy. Mais detalhes em: Maven Guide
4 - No Android Studio, selecione File -> New Module. Expande More Modules e escolha Import existing .jar or .aar package
5 - Selecione o arquivo deviceprint-lib-1.2.0.aar, e clique em Finish
6 - Certifique-se de que o device-lib é uma dependência de compilação no arquivo build.gradle

Detalhes

A função ioBegin coleta informações sobre o dispositivo e gera uma caixa preta. Esta caixa preta deverá ser enviada através do campo CustomerData.BrowserFingerPrint em conjunto com os outros dados para análise.

public static String ioBegin(Context context)

context - uma instância da classe android.content.Context usado para acessar informações sobre o dispositivo

string que contem a caixa preta

IMPORTANTE! A caixa preta que retornou de ioBegin nunca deve estar vazio. Uma caixa preta vazia indica que contem apenas 0500 indica que a proteção oferecida pelo sistema pode ter sido comprometida.

IMPORTANTE! O arquivo device-lib-1.2.0.aar deverá ser empacotado com o aplicativo.

IMPORTANTE! Se a opção para executar o módulo não aparecer, selecione File -> Project Structure e abra o painel Modules. A partir disso, defina na lista a versão do Android SDK.

Exemplo Código

1 - Baixe e descompacte o deviceprint-lib-1.2.0.aar
2 - No Android Studio, selecione File -> Open ou clique em Open Project através da opção quick-start
3 - No diretório em que você descompactou o deviceprint-lib-1.2.0.aar, abra diretório android-studio-sample-app do aplicativo de exemplo
4 - Abra o arquivo DevicePrintSampleActivity
5 - Com algumas configurações, o Android Studio pode detectar um Android Framework no projeto e não configurá-lo. Neste caso, abra o Event Log e clique em Configure
6 - Uma pop-up irá abrir para você selecionar o Android Framework. Clique em OK para corrigir os erros
7 - No Android Studio, selecione File -> New Module. Expande More Modules e escolha Import existing .jar or .aar package
8 - Selecione o arquivo deviceprint-lib-1.2.0.aar, e clique em Finish
9 - Certifique-se de que o device-lib é uma dependência de compilação no arquivo build.gradle
Detalhes integração Android
10 - Abra a pasta DevicePrintSampleActivity 11 - Na opção de navegação do projeto, abra src/main/java/com/iovation/mobile/android/sample/DevicePrintSampleActivity.java
12 - Clique com o botão direito e selecione Run DevicePrintSampleAct
13 - Selecione um dispositivo físico conectado ou um Android virtual para executar o aplicativo
14 - O aplicativo irá compilar e executar

O exemplo ao lado é simples, onde o mesmo possui um botão e ao clicar uma caixa de texto é preenchida com a caixa preta. Para obter um exemplo mais rico, consulte o aplicativo de exemplo do Android Studio incluído no SDK.

Cybersource

Será necessário adicionar duas tags, a script dentro da tag head para uma performance correta e a noscript dentro da tag body, para que a coleta dos dados do dispositivo seja realizada mesmo se o Javascript do browser estiver desabilitado.

IMPORTANTE!

Se os 2 segmentos de código não forem colocados na página de checkout, os resultados podem não ser precisos.

Domain

Ambiente Descrição
Testing Use h.online-metrix.net, que é o DNS do servidor de fingerprint, como apresentado no exemplo de HTML abaixo
Production Altere o domínio para uma URL local, e configure seu servidor Web para redirecionar esta URL para h.online-metrix.net

Variáveis

Variável Descrição
ProviderOrgId Sandbox = 1snn5n9w
Produção = k8vif92e
ProviderMerchantId Identificador da sua loja na Cybersource. Caso não possua, entre em contato com a Braspag
ProviderIdentifier Identificador utilizado para cruzar informações obtidas do dispositivo do comprador. Este mesmo identificador deve ser atribuído ao campo Customer.BrowserFingerprint que será enviado na requisição da análise.
O resultado da concatenação entre o campo ProviderMerchantId e este, deve ser atribuído ao campo session_id do(s) script(s) que serão incluídos na página de checkout.
Exemplo:
ProviderMerchantId = braspag
ProviderIdentifier = 123456789
Resultado = braspag123456789

Obs.: Este identificador poderá ser qualquer valor ou o número do pedido, mas deverá ser único durante 48 horas.

Javascript Code

Exemplo Código

IMPORTANTE! Certifique-se de copiar todos os dados corretamente e de ter substituído as variáveis corretamente pelos respectivos valores.

Configurando seu Servidor Web

Todos os objetos se referem a h.online-metrix.net, que é o DNS do servidor de fingerprint. Quando você estiver pronto para produção, você deve alterar o nome do servidor para uma URL local, e configurar no seu servidor Web um redirecionamento de URL para h.online-metrix.net.

IMPORTANTE! Se você não completar essa seção, você não receberá resultados corretos, e o domínio (URL) do fornecedor de fingerprint ficará visível, sendo mais provável que seu consumidor o bloqueie.

Integração em aplicativos mobile

Baixando o SDK Se você ainda não baixou o SDK do iOS ou do Android, deve fazê-lo antes de continuar. Para isso acesse um dos links abaixo de acordo com o desejado.
Download Deviceprint SDK iOS
Download Deviceprint SDK Android

Pagamentos com Cartão de Débito

Criando uma transação com cartão de débito

Uma transação com um Cartão de Débito se efetua de uma forma semelhante a um Cartão de Crédito, porém, é obrigatório submetê-la ao processo de autenticação.

Requisição

{
   "MerchantOrderId":"2017051107",
   "Customer":{
      "Name":"Nome do Cliente"
   },
   "Payment":{
     "Provider":"Cielo",
     "Type":"DebitCard",
     "Amount":10000,
     "Installments":1,
     "ReturnUrl":"http://www.braspag.com.br",
     "DebitCard":{
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa"
     }
   }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
   "MerchantOrderId":"2017051107",
   "Customer":{
      "Name":"Nome do Cliente"
   },
   "Payment":{
     "Provider":"Cielo",
     "Type":"DebitCard",
     "Amount":10000,
     "Installments":1,
     "ReturnUrl":"http://www.braspag.com.br",
     "DebitCard":{
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa"
     }
   }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento. Atualmente somente a “Cielo” suporta esta forma de pagamento via Pagador
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento. No caso do cartão de débito (DebitCard)
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.Installments Número 2 Sim Número de Parcelas
Payment.ReturnUrl URL para onde o usuário será redirecionado após o fim do pagamento Texto 1024 Sim
DebitCard.CardNumber Texto 16 Sim Número do Cartão do comprador
DebitCard.Holder Texto 25 Sim Nome do Comprador impresso no cartão
DebitCard.ExpirationDate Texto 7 Sim Data de validade impresso no cartão, no formato MM/AAAA
DebitCard.SecurityCode Texto 4 Sim Código de segurança impresso no verso do cartão
DebitCard.Brand Texto 10 Sim Bandeira do cartão

Resposta

{
  "MerchantOrderId": "2017051107",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "DebitCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "AuthenticationUrl": "https://qasecommerce.cielo.com.br/web/index.cbmp?id=13fda1da8e3d90d3d0c9df8820b96a7f",
    "AcquirerTransactionId": "10069930690009D366FA",
    "PaymentId": "21423fa4-6bcf-448a-97e0-e683fa2581ba",
    "Type": "DebitCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 15:19:58",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Cielo",
    "ReturnUrl": "http://www.braspag.com.br",
    "ReasonCode": 9,
    "ReasonMessage": "Waiting",
    "Status": 0,
    "ProviderReturnCode": "0",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/21423fa4-6bcf-448a-97e0-e683fa2581ba"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/21423fa4-6bcf-448a-97e0-e683fa2581ba/void"
      }
    ]
  }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
  "MerchantOrderId": "2017051107",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "DebitCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "AuthenticationUrl": "https://qasecommerce.cielo.com.br/web/index.cbmp?id=13fda1da8e3d90d3d0c9df8820b96a7f",
    "AcquirerTransactionId": "10069930690009D366FA",
    "PaymentId": "21423fa4-6bcf-448a-97e0-e683fa2581ba",
    "Type": "DebitCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 15:19:58",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Cielo",
    "ReturnUrl": "http://www.braspag.com.br",
    "ReasonCode": 9,
    "ReasonMessage": "Waiting",
    "Status": 0,
    "ProviderReturnCode": "0",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/21423fa4-6bcf-448a-97e0-e683fa2581ba"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/21423fa4-6bcf-448a-97e0-e683fa2581ba/void"
      }
    ]
  }
}
Propriedade Descrição Tipo Tamanho Formato
AcquirerTransactionId Id da transação no provedor de meio de pagamento Texto 40 Texto alfanumérico
ProofOfSale Número do Comprovante de Venda Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização Texto 300 Texto alfanumérico
PaymentId Campo Identificador do Pedido Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ReceivedDate Data em que a transação foi recebida pela Brapag Texto 19 AAAA-MM-DD HH:mm:SS
ReasonCode Código de retorno da Operação Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da Operação Texto 512 Texto alfanumérico
Status Status da Transação Byte 2 Ex. 1
ProviderReturnCode Código retornado pelo provedor do meio de pagamento (adquirente e bancos) Texto 32 57
ProviderReturnMessage Mensagem retornada pelo provedor do meio de pagamento (adquirente e bancos) Texto 512 Transação Aprovada
AuthenticationUrl URL para o qual o portador será redirecionado para autenticação Texto 56 https://qasecommerce.cielo.com.br/web/index.cbmp?id=13fda1da8e3d90d3d0c9df8820b96a7f

Criando uma transação com cartão de débito sem autenticação

Uma transação com um Cartão de Débito sem Autenticação é processada de forma semehante a transações de Cartão de Crédito, pois não é necessário autenticar-se na tela do banco emissor do cartão para finalizar a compra.
Para esta modalidade é obrigatório o envio do parâmetro Authenticate como “false”.

Requisição

{
   "MerchantOrderId":"2017051107",
   "Customer":{
      "Name":"Nome do Cliente"
   },
   "Payment":{
     "Provider":"Cielo",
     "Type":"DebitCard",
     "Amount":10000,
     "Installments":1,
     "Authenticate":false,
     "ReturnUrl":"http://www.braspag.com.br",
     "DebitCard":{
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa"
     }
   }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
   "MerchantOrderId":"2017051107",
   "Customer":{
      "Name":"Nome do Cliente"
   },
   "Payment":{
     "Provider":"Cielo",
     "Type":"DebitCard",
     "Amount":10000,
     "Installments":1,
     "Authenticate":false,
     "ReturnUrl":"http://www.braspag.com.br",
     "DebitCard":{
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa"
     }
   }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento. Atualmente somente a “Cielo” suporta esta forma de pagamento via Pagador
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento. No caso do cartão de débito (DebitCard)
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.Installments Número 2 Sim Número de Parcelas
Payment.Authenticate Booleano que indica se a transação deve ser autenticada (true) ou não (false). Deverá verificar junto à adquirente a disponibilidade desta funcionalidade Booleano Sim (enviar false)
Payment.ReturnUrl URL para onde o usuário será redirecionado após o fim do pagamento Texto 1024 Sim
DebitCard.CardNumber Texto 16 Sim Número do Cartão do comprador
DebitCard.Holder Texto 25 Sim Nome do Comprador impresso no cartão
DebitCard.ExpirationDate Texto 7 Sim Data de validade impresso no cartão, no formato MM/AAAA
DebitCard.SecurityCode Texto 4 Sim Código de segurança impresso no verso do cartão
DebitCard.Brand Texto 10 Sim Bandeira do cartão

Resposta

{
  "MerchantOrderId": "2017051107",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "DebitCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "AcquirerTransactionId": "10069930690009D366FA",
    "PaymentId": "21423fa4-6bcf-448a-97e0-e683fa2581ba",
    "Type": "DebitCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 15:19:58",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Cielo",
    "ReturnUrl": "http://www.braspag.com.br",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "ProviderReturnCode": "4",
    "ProviderReturnMessage": "Operation Successful",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/21423fa4-6bcf-448a-97e0-e683fa2581ba"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/21423fa4-6bcf-448a-97e0-e683fa2581ba/void"
      }
    ]
  }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
  "MerchantOrderId": "2017051107",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "DebitCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "AcquirerTransactionId": "10069930690009D366FA",
    "PaymentId": "21423fa4-6bcf-448a-97e0-e683fa2581ba",
    "Type": "DebitCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 15:19:58",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Cielo",
    "ReturnUrl": "http://www.braspag.com.br",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "ProviderReturnCode": "4",
    "ProviderReturnMessage": "Operation Successful",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/21423fa4-6bcf-448a-97e0-e683fa2581ba"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/21423fa4-6bcf-448a-97e0-e683fa2581ba/void"
      }
    ]
  }
}
Propriedade Descrição Tipo Tamanho Formato
AcquirerTransactionId Id da transação no provedor de meio de pagamento Texto 40 Texto alfanumérico
ProofOfSale Número do Comprovante de Venda Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização Texto 300 Texto alfanumérico
PaymentId Campo Identificador do Pedido Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ReceivedDate Data em que a transação foi recebida pela Brapag Texto 19 AAAA-MM-DD HH:mm:SS
ReasonCode Código de retorno da Operação Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da Operação Texto 512 Texto alfanumérico
Status Status da Transação Byte 2 Ex. 1
ProviderReturnCode Código retornado pelo provedor do meio de pagamento (adquirente e bancos) Texto 32 57
ProviderReturnMessage Mensagem retornada pelo provedor do meio de pagamento (adquirente e bancos) Texto 512 Transação Aprovada
AuthenticationUrl URL para o qual o portador será redirecionado para autenticação Texto 56 https://qasecommerce.cielo.com.br/web/index.cbmp?id=13fda1da8e3d90d3d0c9df8820b96a7f

Pagamentos com e-Wallets

O que são e-Wallets (Carteiras Digitais)

São repositórios de cartões e dados de pagamentos para consumidores do e-commerce e mundo físico. As Carteiras digitais permitem que um consumidor realize o cadastro de seus dados de pagamento, tornando o processo de compra mais conveniente e seguro.

Para utilizar carteiras no Pagador, o lojista deverá possuir as carteiras integradas em seu checkout.

Para maiores informações, entre em contato com o provedor de sua preferência para contratar o serviço.

e-Wallets Disponíveis

O Pagador possui suporte para:

  Carteira  
  Apple Pay  
  Samsung Pay  
  Android Pay  
  VisaCheckout  
  MasterPass  

Integração

Requisição Padrão

{
  "MerchantOrderId": "2014111708",
  "Customer": {
    "Name": "Exemplo Wallet Padrão",
    "Identity": "11225468954",
    "IdentityType": "CPF"
  },
  "Payment": {
    "Type": "CreditCard",
    "Amount": 100,
    "Provider": "Cielo",
    "Installments": 1,
    "Currency": "BRL",
    "Wallet": {
      "Type": "TIPO DE WALLET",
      "WalletKey": "IDENTIFICADOR DA LOJA NA WALLET",
      "AdditionalData": {
        "EphemeralPublicKey": "TOKEN INFORMADO PELA WALLET"
      }
    }
  }
}

Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT.
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido.
Customer.Name Texto 255 Não Nome do Comprador.
Customer.Status Texto 255 Não Status de cadastro do comprador na loja (NEW / EXISTING)
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento.
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos).
Payment.Provider Texto 15 Sim Somente providers Cielo (Cielo / Cielo30)
Payment.Installments Número 2 Sim Número de Parcelas.
Wallet.Type Texto Sim indica qual o tipo de carteira: ApplePay / SamsungPay / AndroidPay / VisaCheckout/ Masterpass
Wallet.Walletkey Texto Sim Chave criptografica que identifica lojas nas Wallets - Ver tabela WalletKey para mais informações
Wallet.AdditionalData.EphemeralPublicKey Texto Sim Token retornado pela Wallet. Deve ser enviado em Integrações: ApplePay/ AndroidPay
Wallet.AdditionalData.capturecode Texto Sim Código informado pela MasterPass ao lojista

Walletkey

Formato de WalletKeys que devem ser repassados ao Pagador API

Carteira Exemplo .
Apple Pay 9zcCAciwoTS+qBx8jWb++64eHT2QZTWBs6qMVJ0GO+AqpcDVkxGPNpOR/D1bv5AZ62+5lKvucati0+eu7hdilwUYT3n5swkHuIzX2KO80Apx/SkhoVM5dqgyKrak5VD2/drcGh9xqEanWkyd7wl200sYj4QUMbeLhyaY7bCdnnpKDJgpOY6J883fX3TiHoZorb/QlEEOpvYcbcFYs3ELZ7QVtjxyrO2LmPsIkz2BgNm5f+JaJUSAOectahgLZnZR+easdhghrsa/E9A6DwjMd0fDYnxjj0bQDfaZpBPeGGPFLu5YYn1IDc .
Samsung Pay eyJhbGciOiJSU0ExXzUiLCJraWQiOiIvam1iMU9PL2hHdFRVSWxHNFpxY2VYclVEbmFOUFV1ZUR5M2FWeHBzYXVRPSIsInR5cCI6IkpPU0UiLCJjaGFubmVsU2VjdXJpdHlDb250ZXh0IjoiUlNBX1BLSSIsImVuYyI6IkExMjhHQ00ifQ.cCsGbqgFdzVb1jhXNR–gApzoXH-fdafddfa-Bo_utsmDN_DuGm69Kk2_nh6txa7ML9PCI59LFfOMniAf7ZwoZUBDCY7Oh8kx3wsZ0kxNBwfyLBCMEYzET0qcIYxePezQpkNcaZ4oogmdNSpYY-KbZGMcWpo1DKhWphDVp0lZcLxA6Q25K78e5AtarR5whN4HUAkurQ.CFjWpHkAVoLCG8q0.NcsTuauebemJXmos_mLMTyLhEHL-p5Wv6J88WkgzyjAt_DW7laiPMYw2sqRXkOiMJLwhifRzbSp8ZgJBM25IX05dKKSS4XfFjJQQjOBHw6PYtEF5pUDMLHML3jcddCrX07abfef_DuP41PqOQYsjwesLZ8XsRj-R0TH4diOZ_GQop8_oawjRIo9eJr9Wbtho0h8kAzHYpfuhamOPT718EaGAY6SSrR7t6nBkzGNkrKAmHkC7aRwe.AbZG53wRqgF0XRG3wUK_UQ` .
Android Pay En6NrAzy/V9l7U9FukJTlOkXLx8lsHJ9Lp3aO16WbZuXX+dHI6fy3G8PES5Leu63x+ZSAKQTQxJC/+hFCU3N3Vzl2Eo0bhQDv9pZwU9oghS1rx0QlqNPslspQ8ufTqfDDg2IlsVh7ANh8BXC1pi4YzhUXhAB5J2xSu7ivJwWL4/9FVJ2u0mZIK6QHtuGJXdvol54HtNn9Cik9IA7xeh/gutJ/z9K8rVk1KrCBSSTE1cgxbUbpBp535IXsP//okqXIf7qlTi/sUkfIjXVWLPVP/JPcm+MHE0s/37aVyprz0xfkJjHkUExsJ2h1v7LU5nnK7uYmyUdEI42wUuzfGkwvjvfS3xllxGwqy3Of4ts5mkPLNXdLnPNGvP8RE4uYyrQM4hXdie3tTPgW6FK5ExDsKyw8Qm0ikvbb4Clo9JvALTjqJkr1VkT20UITdetra/8JUWOX/PbcxDYv2oOPLG9hDumRExuifi04cNtwzFvyFVBnV1SO3GKp+k/fdfdfdfdafda= .
VisaCheckout 1140812334225873901 .
Masterpass a561da1c18a89cfdafas875f9d43fc46cd9bf3e1 .

EphemeralPublicKey

Formato de EphemeralPublicKey que devem ser repassados ao Pagador API

Carteira Exemplo
Apple Pay MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEoedz1NqI6hs9hEO6dBsnn0X0xp5/DKj3gXirjEqxNIJ8JyhGxVB3ITd0E+6uG4W6Evt+kugG8gOhCBrdUU6JwQ==
Android Pay BG9mGFe2/kSo6PJDEoO5bRXRS4RKQ4b3jikXio0FUhZPqQe5f6SMlZQI3sfyiKteM0PRSeNDnQQ10XYeobN9avM=

Respostas

{
    "MerchantOrderId": "2014111703",
    "Customer": {
        "Name": "[Guest]"
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": 0,
        "Capture": false,
        "Authenticate": false,
        "Recurrent": false,
        "CreditCard": {
            "CardNumber": "453211******1521",
            "Holder": "BJORN IRONSIDE",
            "ExpirationDate": "08/2020",
            "SaveCard": false,
            "Brand": "Visa"
        },
        "Tid": "0319040817883",
        "ProofOfSale": "817883",
        "AuthorizationCode": "027795",
        "Wallet": {
            "Type": "TIPO DE WALLET",
            "WalletKey": "IDENTIFICADOR DA LOJA NA WALLET",
            "Eci": 0,
            "AdditionalData": {
                "EphemeralPublicKey": "TOKEN INFORMADO PELA WALLET"
            },                
        },
        "SoftDescriptor": "123456789ABCD",
        "Amount": 100,
        "ReceivedDate": "2018-03-19 16:08:16",
        "Status": 1,
        "IsSplitted": false,
        "ReturnMessage": "Operation Successful",
        "ReturnCode": "4",
        "PaymentId": "e57b09eb-475b-44b6-ac71-01b9b82f2491",
        "Type": "CreditCard",
        "Currency": "BRL",
        "Country": "BRA",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/e57b09eb-475b-44b6-ac71-01b9b82f2491"
            },
            {
                "Method": "PUT",
                "Rel": "capture",
                "Href": "https://apisandbox.braspag.com.br/v2/sales/e57b09eb-475b-44b6-ac71-01b9b82f2491/capture"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.braspag.com.br/v2/sales/e57b09eb-475b-44b6-ac71-01b9b82f2491/void"
            }
        ]
    }
}
Propriedade Descrição Tipo Tamanho Formato
ProofOfSale Número da autorização, identico ao NSU. Texto 6 Texto alfanumérico
Tid Id da transação na adquirente. Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização. Texto 6 Texto alfanumérico
SoftDescriptor Texto que será impresso na fatura bancaria do portador - Disponivel apenas para VISA/MASTER - nao permite caracteres especiais Texto 13 Texto alfanumérico
PaymentId Campo Identificador do Pedido. Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ECI Eletronic Commerce Indicator. Representa o quão segura é uma transação. Texto 2 Exemplos: 7
Status Status da Transação. Byte 2 Ex. 1
ReturnCode Código de retorno da Adquirência. Texto 32 Texto alfanumérico
ReturnMessage Mensagem de retorno da Adquirência. Texto Texto alfanumérico
Type indica qual o tipo de carteira: ApplePay / SamsungPay / AndroidPay / VisaCheckout/ Masterpass Texto Texto alfanumérico
Walletkey Chave criptografica que identifica lojas nas Wallets - Ver tabela WalletKey para mais informações Texto Ver tabela WalletKey
AdditionalData.EphemeralPublicKey Token retornado pela Wallet. Deve ser enviado em Integrações: ApplePay/ AndroidPay Texto Ver Tabela EphemeralPublicKey
AdditionalData.capturecode Código informado pela MasterPass ao lojista Texto 3

Exemplos

Apple Pay

Passo 1. Contratação na Apple

É necessário que a Apple Pay seja contratada na Apple através do contato comercial abaixo (o contato deve ser feito em inglês):

Shawn Munyon (smunyon@apple.com)

Passo 2. Obtenção do MerchantIdentifier

Uma vez que a contratação estiver efetivada, receberá acesso ao painel “Apple Developer”, e será necessária a criação do MerchantIdentifier. Para tanto, realize os passos abaixo:

  1. Faça login em Apple Developer
  2. Selecione Certificate, IDs & Profile
  3. Dentro da área “Identifiers” clique em “Merchant IDs”
  4. Clique no + no canto direito, abaixo do “Registering a Merchant ID”
  5. Defina a descrição do MerchantID e o identificador. Exemplo.: “merchant.com.BRASPAG.merchantAccount”
  6. Clique em “continuar” e verifique se as informações inseridas estão corretas
  7. Finalize o processo.

O MerchantIdentifier deve ser enviado à Braspag por meio do canal de suporte para criação de um Certificado CSR no formato PEM.

Passo 3. Upload do Certificado CSR

Após enviar o MerchantIdentifier para a equipe da Braspag, a loja receberá o certificado de extensão PEM e deverá seguir os seguintes passos:

  1. Faça login em Apple Developer
  2. Selecione Certificate, IDs & Profiles Aplle Pay
  3. Realize o upload do certificado Aplle Pay
  4. Finalize o processo

O Certificado PEM contém o código CSR solicitado pela Apple.

Formato de um PEM:

—–BEGIN CERTIFICATE REQUEST—–

MIHyMIGYAgEAMDgxCzAJBgNVBAYTAkJSMRAwDgYDVQQKDAdicmFzcGFnMRcwFQYDVQQDDA5icmFzcGFnLmNvbS5icjBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABFUL1F/ue9/T5SrEyE1wTPQxk5x3ZHEelB7VHObDTW7pjauFrE88J25w7iRCKNP6u2fPmBtM9nY30/xQCgBH9aUwCgYIKoZIzj0EAwIDSQAwRgIhAPyF47xmfy+9czlr0a94eSd/YG27G8akujpkIUd56qWmAiEAqV6aSVISmH9NveOKGJdZ6VvkbELK2uqu2yCpg/lfYc8=

—–END CERTIFICATE REQUEST—

Passo 4. Integração com Apple Pay

A integração requer dois passos: o primeiro é a integração direta com a solução da Apple, para disponibilizar o botão “Pagar com Apple Pay” em seu site ou aplicativo. Para tanto, a equipe da Apple fará um acompanhamento de perto. Clique aqui para acessar a documentação técnica da Apple.

Nesta etapa, não é preciso realizar o processo de criptografia de dados retornados pela Apple. Este trabalho será realizado pela Braspag, através dos procedimentos descritos na próxima etapa.

Passo 5. Integração com Pagador (decriptografia e autorização)

O segundo passo de integração é efetivar o fluxo de autorização via gateway da Braspag (Pagador). Para tanto, é necessário fornecer os dados recebidos no fluxo com a Apple Pay, inclusive WalletKey e EphemeralPublicKey.

Requisição

Exemplo de Requisição padrão Apple Pay

É necessário que a loja ja possua cadastro e uma integração Apple Pay, caso contrario não será possivel a integração com a API

{
  "MerchantOrderId": "6242-642-723",
  "Customer": {
    "Name": "Exemplo Wallet Padrão",
    "Identity": "11225468954",
    "IdentityType": "CPF"
  },
  "Payment": {
    "Type": "CreditCard",
    "Amount": 1100,
    "Provider": "Cielo",
    "Installments": 1,
    "Currency": "BRL",
    "Wallet": {
      "Type": "ApplePay",
      "WalletKey": "9zcCAciwoTS+qBx8jWb++64eHT2QZTWBs6qMVJ0GO+AqpcDVkxGPNpOR/D1bv5AZ62+5lKvucati0+eu7hdilwUYT3n5swkHuIzX2KO80Apx/SkhoVM5dqgyKrak5VD2/drcGh9xqEanWkyd7wl200sYj4QUMbeLhyaY7bCdnnpKDJgpOY6J883fX3TiHoZorb/QlEEOpvYcbcFYs3ELZ7QVtjxyrO2LmPsIkz2BgNm5f+JaJUSAOectahgLZnZR+sRXTDtqLOJQAprs0MNTkPzF95nXGKCCnPV2mfR7z8FHcP7AGqO7aTLBGJLgxFOnRKaFnYlY2E9uTPBbB5JjZywlLIWsPKur5G4m1/E9A6DwjMd0fDYnxjj0bQDfaZpBPeGGPFLu5YYn1IDc",
      "AdditionalData": {
        "EphemeralPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEoedz1NqI6hs9hEO6dBsnn0X0xp5/DKj3gXirjEqxNIJ8JyhGxVB3ITd0E+6uG4W6Evt+kugG8gOhCBrdUU6JwQ=="
      }
    }
  }
}
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT.
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido.
Customer.Name Texto 255 Não Nome do Comprador.
Customer.Status Texto 255 Não Status de cadastro do comprador na loja (NEW / EXISTING)
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento.
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos).
Payment.Provider Texto 15 Sim Somente providers Cielo (Cielo / Cielo30)
Payment.Installments Número 2 Sim Número de Parcelas.
Wallet.Type Texto 255 Sim indica qual o tipo de carteira: ApplePay / SamsungPay / AndroidPay / VisaCheckout/ Masterpass
Wallet.Walletkey Texto 255 Sim Chave criptografica que representa os dados do cartão - Ver tabela WalletKey para mais informações
Wallet.AdditionalData.EphemeralPublicKey Texto 255 Sim Token retornado pela Wallet. Deve ser enviado em Integrações: ApplePay/ AndroidPay

Resposta

{
    "MerchantOrderId": "2014111703",
    "Customer": {
        "Name": "[Guest]"
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": 0,
        "Capture": false,
        "Authenticate": false,
        "Recurrent": false,
        "CreditCard": {
            "CardNumber": "453211******1521",
            "Holder": "BJORN IRONSIDE",
            "ExpirationDate": "08/2020",
            "SaveCard": false,
            "Brand": "Visa"
        },
        "Tid": "0319040817883",
        "ProofOfSale": "817883",
        "AuthorizationCode": "027795",
        "Wallet": {
            "Type": "ApplePay",
            "WalletKey": "9zcCAciwoTS+qBx8jWb++64eHT2QZTWBs6qMVJ0GO+AqpcDVkxGPNpOR/D1bv5AZ62+5lKvucati0+eu7hdilwUYT3n5swkHuIzX2KO80Apx/SkhoVM5dqgyKrak5VD2/drcGh9xqEanWkyd7wl200sYj4QUMbeLhyaY7bCdnnpKDJgpOY6J883fX3TiHoZorb/QlEEOpvYcbcFYs3ELZ7QVtjxyrO2LmPsIkz2BgNm5f+JaJUSAOectahgLZnZR+sRXTDtqLOJQAprs0MNTkPzF95nXGKCCnPV2mfR7z8FHcP7AGqO7aTLBGJLgxFOnRKaFnYlY2E9uTPBbB5JjZywlLIWsPKur5G4m1/E9A6DwjMd0fDYnxjj0bQDfaZpBPeGGPFLu5YYn1IDc",
            "Eci": 0,
            "AdditionalData": {
                "EphemeralPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEoedz1NqI6hs9hEO6dBsnn0X0xp5/DKj3gXirjEqxNIJ8JyhGxVB3ITd0E+6uG4W6Evt+kugG8gOhCBrdUU6JwQ=="
            },                
        },
        "SoftDescriptor": "123456789ABCD",
        "Amount": 100,
        "ReceivedDate": "2018-03-19 16:08:16",
        "Status": 1,
        "IsSplitted": false,
        "ReturnMessage": "Operation Successful",
        "ReturnCode": "4",
        "PaymentId": "e57b09eb-475b-44b6-ac71-01b9b82f2491",
        "Type": "CreditCard",
        "Currency": "BRL",
        "Country": "BRA",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/e57b09eb-475b-44b6-ac71-01b9b82f2491"
            },
            {
                "Method": "PUT",
                "Rel": "capture",
                "Href": "https://apisandbox.braspag.com.br/v2/sales/e57b09eb-475b-44b6-ac71-01b9b82f2491/capture"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.braspag.com.br/v2/sales/e57b09eb-475b-44b6-ac71-01b9b82f2491/void"
            }
        ]
    }
}
Propriedade Descrição Tipo Tamanho Formato
ProofOfSale Número da autorização, identico ao NSU. Texto 6 Texto alfanumérico
Tid Id da transação na adquirente. Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização. Texto 6 Texto alfanumérico
SoftDescriptor Texto que será impresso na fatura bancaria do portador - Disponivel apenas para VISA/MASTER - nao permite caracteres especiais Texto 13 Texto alfanumérico
PaymentId Campo Identificador do Pedido. Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ECI Eletronic Commerce Indicator. Representa o quão segura é uma transação. Texto 2 Exemplos: 7
Status Status da Transação. Byte 2 Ex. 1
ReturnCode Código de retorno da Adquirência. Texto 32 Texto alfanumérico
ReturnMessage Mensagem de retorno da Adquirência. Texto 512 Texto alfanumérico
Type indica qual o tipo de carteira: ApplePay / SamsungPay / AndroidPay / VisaCheckout/ Masterpass Texto 255 Texto alfanumérico
Walletkey Chave criptografica que identifica lojas nas Wallets - Ver tabela WalletKey para mais informações Texto 255 Ver tabela WalletKey
AdditionalData.EphemeralPublicKey Token retornado pela Wallet. Deve ser enviado em Integrações: ApplePay/ AndroidPay Texto 255 Ver Tabela EphemeralPublicKey

Samsung Pay

Requisição

Exemplo de Requisição padrão Samsung Pay

É necessário que a loja ja possua cadastro e uma integração Samsung Pay, caso contrario não será possivel a integração com a API

{
  "MerchantOrderId":"6242-642-723",
  "Customer":{
     "Name":"Exemplo Wallet Padrão",
     "Identity":"11225468954",
      "IdentityType":"CPF"
  },
  "Payment":{
     "Type":"CreditCard",
     "Amount":1,
     "Provider":"Cielo",
     "Installments":1,
     "Currency":"BRL",
     "Wallet":{
       "Type":"SamsungPay",
       "WalletKey":"eyJhbGciOiJSU0ExXzUiLCJraWQiOiIvam1iMU9PL2hHdFRVSWxHNFpxY2VYclVEbmFOUFV1ZUR5M2FWeHBzYXVRPSIsInR5cCI6IkpPU0UiLCJjaGFubmVsU2VjdXJpdHlDb250ZXh0IjoiUlNBX1BLSSIsImVuYyI6IkExMjhHQ00ifQ.cCsGbqgFdzVb1jhXNR--gApzoXH-LldMArSoG59x6i0BbI7jttqxyAdcriSy8q_77VAp3854P9kekjj54RKLrP6APDIr46DI97kjG9E99ONXImnEyamHj95ZH_AW8lvkfa09KAr4537RM8GEXyZoys2vfIW8zqjjicZ8EKIpAixNlmrFJu6-Bo_utsmDN_DuGm69Kk2_nh6txa7ML9PCI59LFfOMniAf7ZwoZUBDCY7Oh8kx3wsZ0kxNBwfyLBCMEYzET0qcIYxePezQpkNcaZ4oogmdNSpYY-KbZGMcWpo1DKhWphDVp0lZcLxA6Q25K78e5AtarR5whN4HUAkurQ.CFjWpHkAVoLCG8q0.NcsTuauebemJXmos_mLMTyLhEHL-p5Wv6J88WkgzyjAt_DW7laiPMYw2sqRXkOiMJLwhifRzbSp8ZgJBM25IX05dKKSS4XfFjJQQjOBHw6PYtEF5pUDMLHML3jcddCrX07abfef_DuP41PqOQYsjwesLZ8XsRj-R0TH4diOZ_GQop8_oawjRIo9eJr9Wbtho0h8kAzHYpfuhamOPT718EaGAY6SSrR7t6nBkzGNkrKAmHkC7aRwe.AbZG53wRqgF0XRG3wUK_UQ"
    }
  }
}

Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT.
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido.
Customer.Name Texto 255 Não Nome do Comprador.
Customer.Status Texto 255 Não Status de cadastro do comprador na loja (NEW / EXISTING)
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento.
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos).
Payment.Provider Texto 15 Sim Somente providers Cielo (Cielo / Cielo30)
Payment.Installments Número 2 Sim Número de Parcelas.
Wallet.Type Texto 255 Sim indica qual o tipo de carteira: ApplePay / SamsungPay / AndroidPay / VisaCheckout/ Masterpass
Wallet.Walletkey Texto 255 Sim Chave criptografica que representa os dados do cartão - Ver tabela WalletKey para mais informações

Resposta

{
    "MerchantOrderId": "2014111703",
    "Customer": {
        "Name": "[Guest]"
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": 0,
        "Capture": false,
        "Authenticate": false,
        "Recurrent": false,
        "CreditCard": {
            "CardNumber": "453211******1521",
            "Holder": "BJORN IRONSIDE",
            "ExpirationDate": "08/2020",
            "SaveCard": false,
            "Brand": "Visa"
        },
        "Tid": "0319040817883",
        "ProofOfSale": "817883",
        "AuthorizationCode": "027795",
        "Wallet": {
            "Type": "SamsungPay",
            "WalletKey": "eyJhbGciOiJSU0ExXzUiLCJraWQiOiIvam1iMU9PL2hHdFRVSWxHNFpxY2VYclVEbmFOUFV1ZUR5M2FWeHBzYXVRPSIsInR5cCI6IkpPU0UiLCJjaGFubmVsU2VjdXJpdHlDb250ZXh0IjoiUlNBX1BLSSIsImVuYyI6IkExMjhHQ00ifQ.cCsGbqgFdzVb1jhXNR--gApzoXH-LldMArSoG59x6i0BbI7jttqxyAdcriSy8q_77VAp3854P9kekjj54RKLrP6APDIr46DI97kjG9E99ONXImnEyamHj95ZH_AW8lvkfa09KAr4537RM8GEXyZoys2vfIW8zqjjicZ8EKIpAixNlmrFJu6-Bo_utsmDN_DuGm69Kk2_nh6txa7ML9PCI59LFfOMniAf7ZwoZUBDCY7Oh8kx3wsZ0kxNBwfyLBCMEYzET0qcIYxePezQpkNcaZ4oogmdNSpYY-KbZGMcWpo1DKhWphDVp0lZcLxA6Q25K78e5AtarR5whN4HUAkurQ.CFjWpHkAVoLCG8q0.NcsTuauebemJXmos_mLMTyLhEHL-p5Wv6J88WkgzyjAt_DW7laiPMYw2sqRXkOiMJLwhifRzbSp8ZgJBM25IX05dKKSS4XfFjJQQjOBHw6PYtEF5pUDMLHML3jcddCrX07abfef_DuP41PqOQYsjwesLZ8XsRj-R0TH4diOZ_GQop8_oawjRIo9eJr9Wbtho0h8kAzHYpfuhamOPT718EaGAY6SSrR7t6nBkzGNkrKAmHkC7aRwe.AbZG53wRqgF0XRG3wUK_UQ",
            "Eci": 0
        },
        "SoftDescriptor": "123456789ABCD",
        "Amount": 100,
        "ReceivedDate": "2018-03-19 16:08:16",
        "Status": 1,
        "IsSplitted": false,
        "ReturnMessage": "Operation Successful",
        "ReturnCode": "4",
        "PaymentId": "e57b09eb-475b-44b6-ac71-01b9b82f2491",
        "Type": "CreditCard",
        "Currency": "BRL",
        "Country": "BRA",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/e57b09eb-475b-44b6-ac71-01b9b82f2491"
            },
            {
                "Method": "PUT",
                "Rel": "capture",
                "Href": "https://apisandbox.braspag.com.br/v2/sales/e57b09eb-475b-44b6-ac71-01b9b82f2491/capture"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.braspag.com.br/v2/sales/e57b09eb-475b-44b6-ac71-01b9b82f2491/void"
            }
        ]
    }
}
Propriedade Descrição Tipo Tamanho Formato
ProofOfSale Número da autorização, identico ao NSU. Texto 6 Texto alfanumérico
Tid Id da transação na adquirente. Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização. Texto 6 Texto alfanumérico
SoftDescriptor Texto que será impresso na fatura bancaria do portador - Disponivel apenas para VISA/MASTER - nao permite caracteres especiais Texto 13 Texto alfanumérico
PaymentId Campo Identificador do Pedido. Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ECI Eletronic Commerce Indicator. Representa o quão segura é uma transação. Texto 2 Exemplos: 7
Status Status da Transação. Byte 2 Ex. 1
ReturnCode Código de retorno da Adquirência. Texto 32 Texto alfanumérico
ReturnMessage Mensagem de retorno da Adquirência. Texto 512 Texto alfanumérico
Type indica qual o tipo de carteira: ApplePay / SamsungPay / AndroidPay / VisaCheckout/ Masterpass Texto 255 Texto alfanumérico
Walletkey Chave criptografica que representa os dados do cartão - Ver tabela WalletKey para mais informações Texto 255 Ver tabela WalletKey

Android Pay

Requisição

Exemplo de Requisição padrão Android Pay

É necessário que a loja ja possua cadastro e uma integração Android Pay, caso contrario não será possivel a integração com a API

{
  "MerchantOrderId":"6242-642-723",
  "Customer":{
    "Name":"Exemplo Wallet Padrão",
    "Identity":"11225468954",
    "IdentityType":"CPF"
  },
  "Payment":{
     "Type":"CreditCard",
     "Amount":1,
     "Provider":"Cielo",
     "Installments":1,
     "Currency":"BRL",
     "Wallet":{
       "Type":"AndroidPay",
       "WalletKey":"En6NrAzy/V9l7U9FukJTlOkXLx8lsHJ9Lp3aO16WbZuXX+dHI6fy3G8PES5Leu63x+ZSAKQTQxJC/+hFCU3N3Vzl2Eo0bhQDv9pZwU9oghS1rx0QlqNPslspQ8ufTqfDDg2IlsVh7ANh8BXC1pi4YzhUXhAB5J2xSu7ivJwWL4/9FVJ2u0mZIK6QHtuGJXdvol54HtNn9Cik9IA7xeh/gutJ/z9K8rVk1KrCBSSTE1cgxbUbpBp535IXsP//okqXIf7qlTi/sUkfIjXVWLPVP/JPcm+MHE0s/37aVyprz0xfkJjHkUExsJ2h1v7LU5nnK7uYmyUdEI42wUuzfGkwvjvfS3xllxGwqy3Of4ts5mkPLNXdLnPNGvP8RE4uYyrQM4hXdie3tTPgW6FK5ExDsKyw8Qm0ikvbb4Clo9JvALTjqJkr1VkT20UITdetra/8JUWOX/PbcxDYv2oOPLG9hDumRExuifi04cNtwzFvyFVBnV1SO3GKp+k/gGNDs7EziHNjToEq7JOWoaAlhNEUu2nxQxNiDEaRckgYd5A=",
       "AdditionalData":{
           "EphemeralPublicKey":"BG9mGFe2/kSo6PJDEoO5bRXRS4RKQ4b3jikXio0FUhZPqQe5f6SMlZQI3sfyiKteM0PRSeNDnQQ10XYeobN9avM="
       }
    }
  }
}
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT.
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido.
Customer.Name Texto 255 Não Nome do Comprador.
Customer.Status Texto 255 Não Status de cadastro do comprador na loja (NEW / EXISTING)
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento.
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos).
Payment.Provider Texto 15 Sim Somente providers Cielo (Cielo / Cielo30)
Payment.Installments Número 2 Sim Número de Parcelas.
Wallet.Type Texto 255 Sim indica qual o tipo de carteira: ApplePay / SamsungPay / AndroidPay / VisaCheckout/ Masterpass
Wallet.Walletkey Texto 255 Sim Chave criptografica que representa os dados do cartão - Ver tabela WalletKey para mais informações
Wallet.AdditionalData.EphemeralPublicKey Texto 255 Sim Token retornado pela Wallet. Deve ser enviado em Integrações: ApplePay/ AndroidPay

Resposta

{
    "MerchantOrderId": "2014111703",
    "Customer": {
        "Name": "[Guest]"
    },
    "Payment": {
        "ServiceTaxAmount": 0,
        "Installments": 1,
        "Interest": 0,
        "Capture": false,
        "Authenticate": false,
        "Recurrent": false,
        "CreditCard": {
            "CardNumber": "453211******1521",
            "Holder": "BJORN IRONSIDE",
            "ExpirationDate": "08/2020",
            "SaveCard": false,
            "Brand": "Visa"
        },
        "Tid": "0319040817883",
        "ProofOfSale": "817883",
        "AuthorizationCode": "027795",
        "Wallet": {
            "Type": "AndroidPay",
            "WalletKey": "En6NrAzy/V9l7U9FukJTlOkXLx8lsHJ9Lp3aO16WbZuXX+dHI6fy3G8PES5Leu63x+ZSAKQTQxJC/+hFCU3N3Vzl2Eo0bhQDv9pZwU9oghS1rx0QlqNPslspQ8ufTqfDDg2IlsVh7ANh8BXC1pi4YzhUXhAB5J2xSu7ivJwWL4/9FVJ2u0mZIK6QHtuGJXdvol54HtNn9Cik9IA7xeh/gutJ/z9K8rVk1KrCBSSTE1cgxbUbpBp535IXsP//okqXIf7qlTi/sUkfIjXVWLPVP/JPcm+MHE0s/37aVyprz0xfkJjHkUExsJ2h1v7LU5nnK7uYmyUdEI42wUuzfGkwvjvfS3xllxGwqy3Of4ts5mkPLNXdLnPNGvP8RE4uYyrQM4hXdie3tTPgW6FK5ExDsKyw8Qm0ikvbb4Clo9JvALTjqJkr1VkT20UITdetra/8JUWOX/PbcxDYv2oOPLG9hDumRExuifi04cNtwzFvyFVBnV1SO3GKp+k/gGNDs7EziHNjToEq7JOWoaAlhNEUu2nxQxNiDEaRckgYd5A",
            "Eci": 0,
            "AdditionalData": {
                "EphemeralPublicKey":"BG9mGFe2/kSo6PJDEoO5bRXRS4RKQ4b3jikXio0FUhZPqQe5f6SMlZQI3sfyiKteM0PRSeNDnQQ10XYeobN9avM="
            }
        },
        "SoftDescriptor": "123456789ABCD",
        "Amount": 100,
        "ReceivedDate": "2018-03-19 16:08:16",
        "Status": 1,
        "IsSplitted": false,
        "ReturnMessage": "Operation Successful",
        "ReturnCode": "4",
        "PaymentId": "e57b09eb-475b-44b6-ac71-01b9b82f2491",
        "Type": "CreditCard",
        "Currency": "BRL",
        "Country": "BRA",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/e57b09eb-475b-44b6-ac71-01b9b82f2491"
            },
            {
                "Method": "PUT",
                "Rel": "capture",
                "Href": "https://apisandbox.braspag.com.br/v2/sales/e57b09eb-475b-44b6-ac71-01b9b82f2491/capture"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.braspag.com.br/v2/sales/e57b09eb-475b-44b6-ac71-01b9b82f2491/void"
            }
        ]
    }
}
Propriedade Descrição Tipo Tamanho Formato
ProofOfSale Número da autorização, identico ao NSU. Texto 6 Texto alfanumérico
Tid Id da transação na adquirente. Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização. Texto 6 Texto alfanumérico
SoftDescriptor Texto que será impresso na fatura bancaria do portador - Disponivel apenas para VISA/MASTER - nao permite caracteres especiais Texto 13 Texto alfanumérico
PaymentId Campo Identificador do Pedido. Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ECI Eletronic Commerce Indicator. Representa o quão segura é uma transação. Texto 2 Exemplos: 7
Status Status da Transação. Byte 2 Ex. 1
ReturnCode Código de retorno da Adquirência. Texto 32 Texto alfanumérico
ReturnMessage Mensagem de retorno da Adquirência. Texto 512 Texto alfanumérico
Type indica qual o tipo de carteira: ApplePay / SamsungPay / AndroidPay / VisaCheckout/ Masterpass Texto 255 Texto alfanumérico
Walletkey Chave criptografica que representa os dados do cartão - Ver tabela WalletKey para mais informações Texto 255 Ver tabela WalletKey
AdditionalData.EphemeralPublicKey Token retornado pela Wallet. Deve ser enviado em Integrações: ApplePay/ AndroidPay Texto 255 Ver Tabela EphemeralPublicKey
AdditionalData.capturecode Código informado pela MasterPass ao lojista Texto 255 3

MasterPass

Para utilizar o MasterPass é necessário a contratação do serviço através do contato diretamente com a Mastercard, selecionando a Braspag como service provider

Requisição

{  
   "MerchantOrderId":"2014111708",
   "Customer":{  
      "Name":"Comprador MasterPass"     
   },
   "Payment":{  
     "Type":"CreditCard",
     "Amount":15700,
     "Installments":1,
     "Wallet":{
         "Type":"MasterPass",
         "WalletKey":"a561da1c18a89cfdafas875f9d43fc46cd9bf3e1",
         "AdditionalData":{
               "CaptureCode": "103"
         }
     }
   }
}

Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT.
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido.
Customer.Name Texto 255 Não Nome do Comprador.
Customer.Status Texto 255 Não Status de cadastro do comprador na loja (NEW / EXISTING)
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento.
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos).
Payment.Provider Texto 15 Sim Somente providers Cielo (Cielo / Cielo30)
Payment.Installments Número 2 Sim Número de Parcelas.
Wallet.Type Texto 255 Sim indica qual o tipo de carteira: “Masterpass”
Wallet.Walletkey Texto 255 Sim Chave criptografica que representa os dados do cartão - Ver tabela WalletKey para mais informações
Wallet.AdditionalData Instancia para dados extras informados pela MasterPass. Obrigatório apenas se TYPE = “MasterPass”
Wallet.capturecode Texto 255 Sim Código informado pela MasterPass ao lojista

Resposta

{
  "MerchantOrderId": "2014111708",
  "Customer": {
    "Name": "comprador Masterpass"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": 0,
    "Capture": false,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "453211******3703",
      "Holder": "Teste Holder",
      "ExpirationDate": "12/2016",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "Tid": "0915052536103",
    "Provider": "Simulado",
    "Wallet": {
      "Type": "Masterpass",
      "Eci": 0,
      "AdditionalData": {
        "CaptureCode": "103"
      }
    },
    "PaymentId": "689da793-fc99-4900-89f1-9e7fdaa06ef8",
    "Type": "CreditCard",
    "Amount": 15700,
    "ReceivedDate": "2016-09-15 17:25:35",
    "Currency": "BRL",
    "Country": "BRA",
    "ReturnCode": "57",
    "ReturnMessage": "Card Expired",
    "Status": 3,
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/689da793-fc99-4900-89f1-9e7fdaa06ef8"
      }
    ]
  }
}
Propriedade Descrição Tipo Tamanho Formato
ProofOfSale Número da autorização, identico ao NSU. Texto 6 Texto alfanumérico
Tid Id da transação na adquirente. Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização. Texto 6 Texto alfanumérico
SoftDescriptor Texto que será impresso na fatura bancaria do portador - Disponivel apenas para VISA/MASTER - nao permite caracteres especiais Texto 13 Texto alfanumérico
PaymentId Campo Identificador do Pedido. Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ECI Eletronic Commerce Indicator. Representa o quão segura é uma transação. Texto 2 Exemplos: 7
Status Status da Transação. Byte 2 Ex. 1
ReturnCode Código de retorno da Adquirência. Texto 32 Texto alfanumérico
ReturnMessage Mensagem de retorno da Adquirência. Texto 512 Texto alfanumérico
Type indica qual o tipo de carteira: “VisaCheckout” ou “Masterpass” Texto 255 Sim
Capturecode Código informado pela MasterPass ao lojista Texto 255 Sim

Visa Checkout

Para utilizar o Visa Checkout é necessário a contratação do serviço através do contato diretamente com a Visa.

Requisição

{  
   "MerchantOrderId":"2014111703",
   "Customer":{  
      "Name":"Comprador Teste"
   },
   "Payment":{  
      "Type":"CreditCard",
      "Amount":15700,
      "Installments":1,
      "SoftDescriptor":"123456789ABCD",
      "CreditCard":{  
         "SecurityCode":"123"
      },
      "Wallet":{  
         "Type":"VisaCheckout",
         "WalletKey":"1140814777695873901"
      }
   }
}

Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT.
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido.
Customer.Name Texto 255 Não Nome do Comprador.
Customer.Status Texto 255 Não Status de cadastro do comprador na loja (NEW / EXISTING)
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento.
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos).
Payment.Provider Texto 15 Sim Somente providers Cielo (Cielo / Cielo30)
Payment.Installments Número 2 Sim Número de Parcelas.
Payment.ReturnUrl Texto 1024 Obrigatório para cartão de débito
CreditCard.SecurityCode Texto 4 Não Código de segurança impresso no verso do cartão - Ver Anexo.
Wallet.Type Texto 255 Sim indica qual o tipo de carteira: “VisaCheckout”
Wallet.Walletkey Texto 255 Chave criptografica enviada pelo VisaCheckout. Obrigatoria se TYPE = “Visa Checkout”

Resposta

{
  "MerchantOrderId": "2014111708",
  "Customer": {
    "Name": "Comprador VisaCheckout"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": 0,
    "Capture": false,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "SaveCard": false,
      "Brand": "Undefined"
    },
    "Tid": "0915052340115",
    "Provider": "Simulado",
    "Wallet": {
      "Type": "VisaCheckout",
      "WalletKey": "1140814777695873901",
      "Eci": 0
    },
    "PaymentId": "efdb3338-9c8f-445a-8836-2cc93d8beacf",
    "Type": "CreditCard",
    "Amount": 15700,
    "ReceivedDate": "2016-09-15 17:23:39",
    "Currency": "BRL",
    "Country": "BRA",
    "ReturnCode": "77",
    "ReturnMessage": "Card Canceled",
    "Status": 3,
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/efdb3338-9c8f-445a-8836-2cc93d8beacf"
      }
    ]
  }
}

Pagamentos com Voucher

Criando uma transação com voucher Alelo

Uma transação com um Cartão Alelo se efetua de uma forma semelhante a um Cartão de Débito, porém, sem o processo de autenticação.
Atualmente, somente o Provider “Alelo” suporta processamento desta modalidade.

Requisição

{
    "MerchantOrderId": "2017051001",
    "Customer": {
        "Name": "TesteBraspag"
    },
    "Payment": {
        "Provider": "Alelo",
        "Type": "DebitCard",
        "Amount": 10,
        "Installments": 1,
        "DebitCard": {
            "CardNumber": "****4903",
            "Holder": "TesteBraspag",
            "ExpirationDate": "02/2019",
            "SecurityCode": "***",
            "Brand": "Elo"
        },
        "ReturnUrl": "http://www.braspag.com.br"
    }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "MerchantOrderId": "2017051001",
    "Customer": {
        "Name": "TesteBraspag"
    },
    "Payment": {
        "Provider": "Alelo",
        "Type": "DebitCard",
        "Amount": 10,
        "Installments": 1,
        "DebitCard": {
            "CardNumber": "****4903",
            "Holder": "TesteBraspag",
            "ExpirationDate": "02/2019",
            "SecurityCode": "***",
            "Brand": "Elo"
        },
        "ReturnUrl": "http://www.braspag.com.br"
    }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento. Atualmente somente a “Cielo” suporta esta forma de pagamento via Pagador
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento. No caso do cartão de débito (DebitCard)
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.Installments Número 2 Sim Número de Parcelas
Payment.ReturnUrl URL para onde o usuário será redirecionado após o fim do pagamento Texto 1024 Sim
DebitCard.CardNumber Texto 16 Sim Número do Cartão do comprador
DebitCard.Holder Texto 25 Sim Nome do Comprador impresso no cartão
DebitCard.ExpirationDate Texto 7 Sim Data de validade impresso no cartão, no formato MM/AAAA
DebitCard.SecurityCode Texto 4 Sim Código de segurança impresso no verso do cartão
DebitCard.Brand Texto 10 Sim Bandeira do cartão

Resposta

{
    "MerchantOrderId": "2017051001",
    "Customer": {
        "Name": "TesteBraspag"
    },
    "Payment": {
        "DebitCard": {
            "CardNumber": "527637******4903",
            "Holder": "TesteBraspag",
            "ExpirationDate": "02/2019",
            "SaveCard": false,
            "Brand": "Elo"
        },
        "ProofOfSale": "004045",
        "AcquirerTransactionId": "c63fb9f7-02ad-42b3-a182-c56e26238a00",
        "AuthorizationCode": "128752",
        "Eci": "0",
        "PaymentId": "562a8563-9181-4f12-bee8-0ccc89c8f931",
        "Type": "DebitCard",
        "Amount": 10,
        "ReceivedDate": "2018-02-21 10:59:57",
        "CapturedAmount": 10,
        "CapturedDate": "2018-02-21 11:00:48",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Alelo",
        "ReturnUrl": "http://www.braspag.com.br",
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "Status": 2,
        "ProviderReturnCode": "00",
        "ProviderReturnMessage": "Transacao capturada com sucesso",
        "Links": [{
            "Method": "GET",
            "Rel": "self",
            "Href": "https://apiquerydev.braspag.com.br/v2/sales/562a8563-9181-4f12-bee8-0ccc89c8f931"
        }, {
            "Method": "PUT",
            "Rel": "void",
            "Href": "https://apidev.braspag.com.br/v2/sales/562a8563-9181-4f12-bee8-0ccc89c8f931/void"
        }]
    }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "MerchantOrderId": "2017051001",
    "Customer": {
        "Name": "TesteBraspag"
    },
    "Payment": {
        "DebitCard": {
            "CardNumber": "527637******4903",
            "Holder": "TesteBraspag",
            "ExpirationDate": "02/2019",
            "SaveCard": false,
            "Brand": "Elo"
        },
        "ProofOfSale": "004045",
        "AcquirerTransactionId": "c63fb9f7-02ad-42b3-a182-c56e26238a00",
        "AuthorizationCode": "128752",
        "Eci": "0",
        "PaymentId": "562a8563-9181-4f12-bee8-0ccc89c8f931",
        "Type": "DebitCard",
        "Amount": 10,
        "ReceivedDate": "2018-02-21 10:59:57",
        "CapturedAmount": 10,
        "CapturedDate": "2018-02-21 11:00:48",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Alelo",
        "ReturnUrl": "http://www.braspag.com.br",
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "Status": 2,
        "ProviderReturnCode": "00",
        "ProviderReturnMessage": "Transacao capturada com sucesso",
        "Links": [{
            "Method": "GET",
            "Rel": "self",
            "Href": "https://apiquerydev.braspag.com.br/v2/sales/562a8563-9181-4f12-bee8-0ccc89c8f931"
        }, {
            "Method": "PUT",
            "Rel": "void",
            "Href": "https://apidev.braspag.com.br/v2/sales/562a8563-9181-4f12-bee8-0ccc89c8f931/void"
        }]
    }
}
Propriedade Descrição Tipo Tamanho Formato
AcquirerTransactionId Id da transação no provedor de meio de pagamento Texto 40 Texto alfanumérico
ProofOfSale Número do Comprovante de Venda Texto 20 Texto alfanumérico
AuthorizationCode Código de autorização Texto 300 Texto alfanumérico
PaymentId Campo Identificador do Pedido Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ReceivedDate Data em que a transação foi recebida pela Brapag Texto 19 AAAA-MM-DD HH:mm:SS
ReasonCode Código de retorno da Operação Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da Operação Texto 512 Texto alfanumérico
Status Status da Transação Byte 2 Ex. 1
ProviderReturnCode Código retornado pelo provedor do meio de pagamento (adquirente e bancos) Texto 32 57
ProviderReturnMessage Mensagem retornada pelo provedor do meio de pagamento (adquirente e bancos) Texto 512 Transação Aprovada
AuthenticationUrl URL para o qual o portador será redirecionado para autenticação Texto 56 https://qasecommerce.cielo.com.br/web/index.cbmp?id=13fda1da8e3d90d3d0c9df8820b96a7f

Cancelando/Estornando uma transação de voucher Alelo

Para cancelar ou estornar uma transação que utilizou voucher Alelo, é necessário fazer um PUT para o recurso Payment conforme o exemplo.

Requisição

curl
--request PUT "https://apisandbox.braspag.com.br/v2/sales/{PaymentId}/void?amount=xxx"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--verbose
Propriedade Descrição Tipo Tamanho Obrigatório
MerchantId Identificador da loja na API. Guid 36 Sim
MerchantKey Chave Publica para Autenticação Dupla na API. Texto 40 Sim
RequestId Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT Guid 36 Não
PaymentId Campo Identificador do Pedido. Guid 36 Sim
Amount Valor a ser cancelado/estornado (ser enviado em centavos). Verifique se a adquirente contratada suporta a operação de cancelamento ou estorno Número 15 Não

Resposta

{
    "Status": 10,
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "ProviderReasonCode": "9",
    "ProviderReasonMessage": "Operation Successful",
    "Links": [
        {
            "Method": "GET",
            "Rel": "self",
            "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/{PaymentId}"
        }
    ]
}
{
    "Status": 10,
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "ProviderReasonCode": "9",
    "ProviderReasonMessage": "Operation Successful",
    "Links": [
        {
            "Method": "GET",
            "Rel": "self",
            "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/{PaymentId}"
        }
    ]
}
Propriedade Descrição Tipo Tamanho Formato
Status Status da Transação. Byte 2 Ex. 1
ReasonCode Código de retorno da Adquirência. Texto 32 Texto alfanumérico
ReasonMessage Mensagem de retorno da Adquirência. Texto 512 Texto alfanumérico

Pagamentos com Transferência Eletrônica

Criando uma transação

Para criar uma venda de transferência eletrônica (conhecido como Débito Online), é necessário fazer um POST para o recurso Payment conforme o exemplo.

Requisição

{  
    "MerchantOrderId":"2017051109",
    "Customer":
    {  
        "Name":"Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Email": "comprador@braspag.com.br",
        "Address":
        {
             "Street":"Alameda Xingu",
             "Number":"512",
             "Complement":"27 andar",
             "ZipCode":"12345987",
             "City":"São Paulo",
             "State":"SP",
             "Country":"BRA",
             "District":"Alphaville"
         }
  },
    "Payment":
    {  
        "Provider":"Bradesco",
        "Type":"EletronicTransfer",
        "Amount":10000,
        "ReturnUrl":"http://www.braspag.com.br"
    }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{  
    "MerchantOrderId":"2017051109",
    "Customer":
    {  
        "Name":"Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Email": "comprador@braspag.com.br",
        "Address":
        {
             "Street":"Alameda Xingu",
             "Number":"512",
             "Complement":"27 andar",
             "ZipCode":"12345987",
             "City":"São Paulo",
             "State":"SP",
             "Country":"BRA",
             "District":"Alphaville"
        }
    },
    "Payment":
    {  
        "Provider":"Bradesco",
        "Type":"EletronicTransfer",
        "Amount":10000,
        "ReturnUrl":"http://www.braspag.com.br"
    }
}
--verbose
Propriedade Descrição Tipo Tamanho Obrigatório
MerchantId Identificador da loja na API. Guid 36 Sim
MerchantKey Chave Publica para Autenticação Dupla na API. Texto 40 Sim
RequestId Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT Guid 36 Não
MerchantOrderId Numero de identificação do Pedido. Texto 50 Sim
Customer.Name Nome do comprador Texto 255 Sim
Customer.Identity Número do RG, CPF ou CNPJ do Cliente Texto 14 Sim
Customer.IdentityType Tipo de documento de identificação do comprador (CPF ou CNPJ) Texto 255 Não
Customer.Email Email do comprador Texto 255 Não
Customer.Address.Street Endereço de contato do comprador Texto 255 Sim
Customer.Address.Number Número endereço de contato do comprador Texto 15 Sim
Customer.Address.Complement Complemento do endereço de contato do Comprador Texto 50 Sim
Customer.Address.ZipCode CEP do endereço de contato do comprador Texto 9 Sim
Customer.Address.City Cidade do endereço de contato do comprador Texto 50 Sim
Customer.Address.State Estado do endereço de contato do comprador Texto 2 Sim
Customer.Address.Country Pais do endereço de contato do comprador Texto 35 Sim
Customer.Address.District Bairro do endereço de contato do comprador Texto 35 Sim
Payment.Type Tipo do Meio de Pagamento. Texto 100 Sim
Payment.Amount Valor do Pedido (ser enviado em centavos) Número 15 Sim
Payment.Provider Nome da provedora de Meio de Pagamento Texto 15

Resposta

{
    "MerchantOrderId": "2017051109",
    "Customer": {
        "Name":"Nome do Comprador",
        "Identity": "12345678909",
        "IdentityType": "CPF",
        "Email": "comprador@braspag.com.br",
        "Address":
        {"Street":"Alameda Xingu",
        "Number":"512",
        "Complement":"27 andar",
        "ZipCode":"12345987",
        "City":"São Paulo",
        "State":"SP",
             "Country":"BRA",
             "District":"Alphaville"
            }
    },
    "Payment": {
        "Url": "https://xxx.xxxxxxx.xxx.xx/post/EletronicTransfer/Redirect/{PaymentId}",
        "PaymentId": "765548b6-c4b8-4e2c-b9b9-6458dbd5da0a",
        "Type": "EletronicTransfer",
        "Amount": 10000,
        "ReceivedDate": "2015-06-25 09:37:55",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Bradesco",
        "ReturnUrl": "http://www.braspag.com.br",
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "Status": 0,
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/{PaymentId}"
            }
        ]
    }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "MerchantOrderId": "2017051109",
    "Customer": {
        "Name": "Comprador Teste",
    },
    "Payment": {
        "Url": "https://xxx.xxxxxxx.xxx.xx/post/EletronicTransfer/Redirect/{PaymentId}",
        "PaymentId": "765548b6-c4b8-4e2c-b9b9-6458dbd5da0a",
        "Type": "EletronicTransfer",
        "Amount": 10000,
        "ReceivedDate": "2015-06-25 09:37:55",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Bradesco",
        "ReturnUrl": "http://www.braspag.com.br",
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "Status": 0,
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/{PaymentId}"
            }
        ]
    }
}
Propriedade Descrição Tipo Tamanho Formato
PaymentId Campo Identificador do Pedido Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Url URL para a qual o comprador deverá ser redirecionado para autenticação da Transferência Eletrônica Texto 256 Url de Autenticação
Status Status da Transação Byte 2 Ex. 1

Pagamentos com Boleto

Boleto Registrado

Com o objetivo de promover maior controle e segurança ao transacional de boletos no e-commerce e garantir mais confiabilidade e comodidade aos usuários, a Febraban em conjunto com os Bancos lançou a Nova Plataforma de Cobrança.

A partir de 21 de julho de 2018 todos os boletos emitidos no e-commerce, obrigatoriamente, terão de ser registrados. Clique aqui para acessar o comunicado completo.

Abaixo seguem os procedimentos de migração/filiação de cada banco:

Bradesco
Banco do Brasil
Itaú
Santander
Caixa Econômica

Criando uma transação de Boleto com Registro

Para gerar um boleto registrado, é necessário fornecer alguns dados a mais do comprador como CPF e endereço. Abaixo temos um exemplo de como criar um pedido com o meio de pagamento boleto. Neste fluxo, é necessário solicitar ao time de suporte da Braspag a ativação do meio de pagamento.

Requisição

{  
    "MerchantOrderId":"2017091101",
    "Customer":
    {  
        "Name":"Nome do Comprador",
        "Identity":"12345678909",
        "IdentityType":"CPF",
        "Address":{  
            "Street":"Alameda Xingu",
            "Number":"512",
            "Complement":"27 andar",
            "ZipCode":"12345987",
            "City":"São Paulo",
            "State":"SP",
            "Country":"BRA",
            "District":"Alphaville"
        }
    },
    "Payment":
    {  
     "Provider":"Simulado",
     "Type":"Boleto",
     "Amount":10000,
     "BoletoNumber":"2017091101",
     "Assignor": "Empresa Teste",
     "Demonstrative": "Desmonstrative Teste",
     "ExpirationDate": "2017-12-31",
     "Identification": "12346578909",
     "Instructions": "Aceitar somente até a data de vencimento.",
     "DaysToFine": 1,
     "FineRate": 10.00000,
     "FineAmount": 1000,
     "DaysToInterest": 1,
     "InterestRate": 5.00000,
     "InterestAmount": 500
    }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{  
    "MerchantOrderId":"2017091101",
    "Customer":
    {  
        "Name":"Nome do Comprador",
        "Identity":"12345678909",
        "IdentityType":"CPF",
        "Address":{
            "Street":"Alameda Xingu",
            "Number":"512",
            "Complement":"27 andar",
            "ZipCode":"12345987",
            "City":"São Paulo",
            "State":"SP",
            "Country":"BRA",
            "District":"Alphaville"
        }
    },
    "Payment":
    {  
     "Provider":"Simulado",
     "Type":"Boleto",
     "Amount": 10000,
     "BoletoNumber":"2017091101",
     "Assignor": "Empresa Teste",
     "Demonstrative": "Desmonstrative Teste",
     "ExpirationDate": "2017-12-31",
     "Identification": "12346578909",
     "Instructions": "Aceitar somente até a data de vencimento.",
     "DaysToFine": 1,
     "FineRate": 10.00000,
     "FineAmount": 1000,
     "DaysToInterest": 1,
     "InterestRate": 5.00000,
     "InterestAmount": 500
    }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto vide tabela abaixo Sim Numero de identificação do Pedido. A regra varia de acordo com o Provider utilizado (vide tabela abaixo)
Customer.Name Texto vide tabela abaixo Sim Nome do comprador. A regra varia de acordo com o Provider utilizado (vide tabela abaixo)
Customer.Identity Texto 14 Sim Número do RG, CPF ou CNPJ do Cliente
Customer.IdentityType Texto 255 Sim Tipo de documento de identificação do comprador (CPF ou CNPJ)
Customer.Address.Street Texto vide tabela abaixo Sim Endereço de contato do comprador. A regra varia de acordo com o Provider utilizado (vide tabela abaixo)
Customer.Address.Number Texto vide tabela abaixo Sim Número endereço de contato do comprador. A regra varia de acordo com o Provider utilizado (vide tabela abaixo)
Customer.Address.Complement Texto vide tabela abaixo Não Complemento do endereço de contato do Comprador. A regra varia de acordo com o Provider utilizado (vide tabela abaixo)
Customer.Address.ZipCode Texto 8 Sim CEP do endereço de contato do comprador
Customer.Address.District Texto vide tabela abaixo Sim Bairro do endereço de contato do comprador. A regra varia de acordo com o Provider utilizado (vide tabela abaixo)
Customer.Address.City Texto vide tabela abaixo Sim Cidade do endereço de contato do comprador. A regra varia de acordo com o Provider utilizado (vide tabela abaixo)
Customer.Address.State Texto 2 Sim Estado do endereço de contato do comprador
Customer.Address.Country Texto 35 Sim Pais do endereço de contato do comprador
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento de Boleto. Clique aqui para acessar a lista de provedoras.
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento. No caso “Boleto”
Payment.Amount Número 15 Sim Valor do Pedido (deve ser enviado em centavos)
Payment.BoletoNumber Texto vide tabela abaixo Não Número do Boleto (“Nosso Número”). Caso preenchido, sobrepõe o valor configurado no meio de pagamento. A regra varia de acordo com o Provider utilizado (vide tabela abaixo
Payment.Assignor Texto 200 Não Nome do Cedente. Caso preenchido, sobrepõe o valor configurado no meio de pagamento
Payment.Demonstrative Texto vide tabela abaixo Não Texto de Demonstrativo. Caso preenchido, sobrepõe o valor configurado no meio de pagamento. A regra varia de acordo com o Provider utilizado (vide tabela abaixo)
Payment.ExpirationDate Date AAAA-MM-DD Não Dias para vencer o boleto. Caso não esteja previamente cadastrado no meio de pagamento, o envio deste campo é obrigatório. Se enviado na requisição, sobrepõe o valor configurado no meio de pagamento.
Payment.Identification Texto 14 Não CNPJ do Cedente. Caso preenchido, sobrepõe o valor configurado no meio de pagamento
Payment.Instructions Texto vide tabela abaixo Não Instruções do Boleto. Caso preenchido, sobrepõe o valor configurado no meio de pagamento. A regra varia de acordo com o Provider utilizado (vide tabela abaixo)
Payment.NullifyDays Número 2 Não Prazo para baixa automática do boleto. O cancelamento automático do boleto acontecerá após o número de dias estabelecido neste campo contado a partir da data do vencimento. Ex.: um boleto com vencimento para 15/12 que tenha em seu registro o prazo para baixa de 5 dias, poderá ser pago até 20/12, após esta data o título é cancelado. *Recurso válido somente para boletos registrados do Banco Santander.
Payment.DaysToFine Número 15 Não Opcional e somente para provider Bradesco2. Quantidade de dias após o vencimento para cobrar o valor da multa, em número inteiro. Ex: 3
Payment.FineRate Número 15 Não Opcional e somente para provider Bradesco2. Valor da multa após o vencimento em percentual, com base no valor do boleto (%). Permitido decimal com até 5 casas decimais. Não enviar se utilizar FineAmount. Ex: 10.12345 = 10.12345%
Payment.FineAmount Número 15 Não Opcional e somente para provider Bradesco2. Valor da multa após o vencimento em valor absoluto em centavos. Não enviar se utilizar FineRate. Ex: 1000 = R$ 10,00
Payment.DaysToInterest Número 15 Não Opcional e somente para provider Bradesco2.Quantidade de dias após o vencimento para iniciar a cobrança de juros por dia sobre o valor do boleto, em número inteiro. Ex: 3
Payment.InterestRate Número 15 Não Opcional e somente para provider Bradesco2. Valor de juros mensal após o vencimento em percentual, com base no valor do boleto (%). O valor de juros é cobrado proporcionalmente por dia (Mensal dividido por 30). Permitido decimal com até 5 casas decimais. Não enviar se utilizar InterestAmount. Ex: 10.12345
Payment.InterestAmount Número 15 Não Opcional e somente para provider Bradesco2. Valor absoluto de juros diário após o vencimento em centavos. Não enviar se utilizar InterestRate. Ex: 1000 = R$ 10,00

Tabela de Especificação de quantidade de caracteres do campo por Provider

Propriedade Bradesco BancoBanco do Brasil Itaú Shopline Santander Caixa Econômica Citibank
Provider Bradesco2 BancoDoBrasil2 ItauShopline Santander2 Caixa2 Citibank2
MerchantOrderId 27 (OBS 1) 50 (OBS 1) 8 50 (OBS 1) 11 (OBS 1) 10 (OBS 1)
Payment.BoletoNumber 11 (OBS 2) 9 (OBS 2) 8 (OBS 1) 13 (OBS 2) 14 (OBS 2) 11 (OBS 2)
Customer.Name 34 (OBS 3) 60 (OBS,3) 30 40 (OBS 3) 40 (OBS 3) 50 (OBS 3)
Customer.Address.Street; Customer.Address.Number; Customer.Address.Complement; Customer.Address.District Street: 70 (OBS 4); Number: 10 (OBS 4); Complement: 20 (OBS 4); District: 50 (OBS 4) Os campos devem totalizar até 60 caracteres Street, Number e Complement devem totalizar até 40 caracteres; District: 15 Street, Number e Complement devem totalizar até 40 caracteres (OBS 3); District: 15 (OBS 3) Street, Number e Complement devem totalizar até 40 caracteres (OBS 3); District: 15 (OBS 3) Street, Number e Complement devem totalizar até 40 caracteres (OBS 3); District: 50 (OBS 3)
Customer.Address.City 50 (OBS 4) 18 (OBS 3) 15 30 (OBS 3) 15 (OBS 3) 50 (OBS 4)
Payment.Instructions 450 450 não é enviado ao banco 450 450 450
Payment.Demonstrative 255 não é enviado ao banco não é enviado ao banco 255 255 255
»»»»»»»»»»»            
Particularidades e Observações: OBS 1: letras, números e caracteres como “_” e “$” OBS 1: não é enviado ao banco OBS geral: o Pagador trunca automaticamente os campos OBS 1: não é enviado ao banco OBS 1: quando ultrapassa os 11 dígitos, o pagador considera o número incremental cadastrado no admin OBS geral: o Pagador não valida os campos, porém é truncado automaticamente pelo Banco
  OBS 2: o valor é presistido no banco OBS 2: quando enviado acima de 9 posições, o Pagador trunca automaticamente, considerando os últimos 9 dígitos OBS 1: o nosso número será sempre igual ao Order ID, sendo que o pagador valida o tamanho do campo OBS 2: o valor é persistido no banco OBS 2: inicia-se com “14” + 14 dígitos + dígito verificador gerado automaticamente. Quando maior que 14, o Pagador trunca pegando os últimos 14 digitos OBS 1: quando fora do limite, o pagador gera um número incremental configurado a partir do Admin
  OBS 3: o Pagador trunca automaticamente OBS 3: 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   OBS 3: o valor é persistido no Pagador OBS 3: o valor é persistido no Pagador OBS 2: quando fora do limite, o pagador gera um número aleatório
  OBS 4: o valor é persistido no Pagador         OBS 3: o Pagador trunca até o limite permitido e remove os caracteres especiais e acentuados
            OBS 4: não é enviado para banco

Resposta

{
  "MerchantOrderId": "2017091101",
  "Customer": {
    "Name": "Nome do Comprador",
    "Identity": "12345678909",
    "IdentityType": "CPF",
    "Address": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA"
    }
  },
  "Payment": {
    "Instructions": "Aceitar somente até a data de vencimento.",
    "ExpirationDate": "2017-12-31",
    "Demonstrative": "Desmonstrative Teste",
    "Url": "https://homologacao.pagador.com.br/post/pagador/reenvia.asp/d24b0aa4-21c9-449d-b85c-6279333f070f",
    "BoletoNumber": "2017091101",
    "BarCodeNumber": "00091739000000100000494250000000263400656560",
    "DigitableLine": "00090.49420 50000.000260 34006.565609 1 73900000010000",
    "Assignor": "Empresa Teste",
    "Address": "Av. Brigadeiro Faria Lima, 160",
    "Identification": "12346578909",
    "PaymentId": "d24b0aa4-21c9-449d-b85c-6279333f070f",
    "Type": "Boleto",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 16:42:55",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "InterestAmount": 1,
    "FineAmount": 5,
    "DaysToFine": 1,
    "DaysToInterest": 1,
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/d24b0aa4-21c9-449d-b85c-6279333f070f"
      }
    ]
  }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
  "MerchantOrderId": "2017091101",
  "Customer": {
    "Name": "Nome do Comprador",
    "Identity": "12345678909",
    "IdentityType": "CPF",
    "Address": {
      "Street": "Alameda Xingu",
      "Number": "512",
      "Complement": "27 andar",
      "ZipCode": "12345987",
      "City": "São Paulo",
      "State": "SP",
      "Country": "BRA",
     "District":"Alphaville"
    }
  },
  "Payment": {
    "Instructions": "Aceitar somente até a data de vencimento.",
    "ExpirationDate": "2017-12-31",
    "Demonstrative": "Desmonstrative Teste",
    "Url": "https://homologacao.pagador.com.br/post/pagador/reenvia.asp/d24b0aa4-21c9-449d-b85c-6279333f070f",
    "BoletoNumber": "2017091101",
    "BarCodeNumber": "00091739000000100000494250000000263400656560",
    "DigitableLine": "00090.49420 50000.000260 34006.565609 1 73900000010000",
    "Assignor": "Empresa Teste",
    "Address": "Av. Brigadeiro Faria Lima, 160",
    "Identification": "12346578909",
    "PaymentId": "d24b0aa4-21c9-449d-b85c-6279333f070f",
    "Type": "Boleto",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 16:42:55",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "InterestAmount": 1,
    "FineAmount": 5,
    "DaysToFine": 1,
    "DaysToInterest": 1,
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/d24b0aa4-21c9-449d-b85c-6279333f070f"
      }
    ]
  }
}
Propriedade Descrição Tipo Tamanho Formato
PaymentId Campo Identificador do Pedido. Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ExpirationDate Data de expiração. Texto 10 2014-12-25
Url URL do Boleto gerado string 256 https://…/pagador/reenvia.asp/8464a692-b4bd-41e7-8003-1611a2b8ef2d
BoletoNumber “NossoNumero” gerado. Texto 50 2017091101
BarCodeNumber Representação numérica do código de barras. Texto 44 00091628800000157000494250100000001200656560
DigitableLine Linha digitável. Texto 256 00090.49420 50100.000004 12006.565605 1 62880000015700
Address Endereço do Loja cadastrada no banco Texto 256 Av. Teste, 160
Status Status da Transação. Byte 2 Ex. 1

Criando uma transação de Boleto Registrado com dados de afiliação

Para gerar um boleto registrado, é necessário fornecer alguns dados a mais do comprador como CPF e endereço. Exemplificamos a seguir o envio dos dados de afiliação via requisição para geração de boletos registrados. Neste fluxo não é necessário ter o meio de pagamento previamente cadastrado, basta enviar as credenciais via requisição.

Boleto Registrado Banco do Brasil

Nesta modalidade, além de enviar as informações do comprador (nome completo, CPF/CNPJ, endereço), deve-se enviar dentro do nó Payment as informações transacionais:

Requisição

{
    (...)
    "Payment": {
        (...)
        "Type": "Boleto",
        "Provider": "BancoDoBrasil2",
        "Credentials": {
            "Agency": "1234-1",
            "Account": "5678-2",
            "Code": "1234567",
            "Agreement": "123456"

        }
    }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    (...)
    "Payment": {
        (...)
        "Type": "Boleto",
        "Provider": "BancoDoBrasil2",
        "Credentials": {
            "Agency": "1234-1",
            "Account": "5678-2",
            "Code": "1234567",
            "Agreement": "123456"
        }
    }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
Payment.Credentials.Agency Número 10 Sim Número da agência bancária. O dígito verificadro da agência deve ser enviado. Ex.: 0123-1.
Payment.Credentials.Account Número 10 Sim Número da conta bancária. O dígito verificador da conta deve ser enviado. Ex.: 123456-2.
Payment.Credentials.Code Número 7 Sim Número do Convênio de Cobrança fornecido pelo Banco do Brasil no momento da liberação do produto. Ex.: 1234567
Payment.Credentials.Agreement Número 6 Sim Convênio de Comércio Eletrônico fornecido pelo Banco do Brasil no momento da liberação do produto.

Boleto Registrado Bradesco

Nesta modalidade, além de enviar as informações do comprador (nome completo, CPF/CNPJ, endereço), deve-se enviar dentro do nó Payment as informações transacionais:

Requisição

{
    (...)
    "Payment": {
        (...)
        "Type": "Boleto",
        "Provider": "Bradesco2",
        "Credentials": {
            "Agency": "1234",
            "Account": "123456-7",
            "Wallet": "26",
            "Code": "100001234",
            "Signature": "asdasd7325fgh-vUrPa9d8a7sdas7sdf8sdfiV0Z-_y_M",
            "Username": "consultasondaboleto@nomefantasia.com.br",
            "Password": "asdasd7325fgh-vUrPa9d8a7sdas7sdf8sdfiV0Z-_y_M"
        }
    }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    (...)
    "Payment": {
        (...)
        "Type": "Boleto",
        "Provider": "Bradesco2",
        "Credentials": {
            "Agency": "1234",
            "Account": "123456-7",
            "Wallet": "26",
            "Code": "100001234",
            "Signature": "asdasd7325fgh-vUrPa9d8a7sdas7sdf8sdfiV0Z-_y_M",
            "Username": "consultasondaboleto@nomefantasia.com.br",
            "Password": "asdasd7325fgh-vUrPa9d8a7sdas7sdf8sdfiV0Z-_y_M"
        }
    }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
Payment.Credentials.Agency Número 4 Sim O número da agência bancária deve conter 4 posições; o dígito verificador não deve ser enviado. Caso necessário, completar com zeros à esquerda. Ex.: 0123.
Payment.Credentials.Account Número 7 Sim O número da conta bancária deve ser enviado com 7 posições, considerando o dígito verificador. Caso necessário, completar com zeros à esquerda. Ex.: 001234-5.
Payment.Credentials.Wallet Número 3 Sim Número da carteira registrada gerada pelo Banco. Ex.: 26
Payment.Credentials.Code Número 9 Sim Código do cliente gerado pelo Bradesco. Informação disponível em Portal Bradesco. Ex.: 100012345
Payment.Credentials.Signature Texto 50 Sim Chave de Segurança gerada no Portal Bradesco. Ex.: asdasd7325fgh-vUrPa9d8a7sdas7sdf8sdfiV0Z-_y_M
Payment.Credentials.Username Texto 100 Sim Usuário gerado no Portal Bradesco.
Payment.Credentials.Password Texto 50 Sim Chave de Segurança gerada no Portal Bradesco.

Boleto Registrado Caixa Econômica

Nesta modalidade, além de enviar as informações do comprador (nome completo, CPF/CNPJ, endereço), deve-se enviar dentro do nó Payment as informações transacionais:

Requisição

{
    (...)
    "Payment": {
        (...)
        "Type": "Boleto",
        "Provider": "Caixa2",
        "Credentials": {
            "Agency": "1234",
            "Account": "123-0",
            "Wallet": "003",
            "Code": "123456",
            "Agreement": "123456"
        }
    }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    (...)
    "Payment": {
        (...)
        "Type": "Boleto",
        "Provider": "Caixa2",
        "Credentials": {
            "Agency": "1234",
            "Account": "123-0",
            "Wallet": "003",
            "Code": "123456",
            "Agreement": "123456"
        }
    }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
Payment.Credentials.Agency Número 4 Sim O número da agência bancária. Ex.: 0123.
Payment.Credentials.Account Número 5 Sim O número da conta. Ex.: 123-1.
Payment.Credentials.Wallet Número 3 Sim Número da carteira registrada gerada pelo Banco. Ex.: 003
Payment.Credentials.Code Número 6 Sim Enviar neste campo o Código de Convênio. Ex.: 123456
Payment.Credentials.Agreement Número 6 Sim Código de Convênio Caixa Econômica. Ex.: 123456

Boleto Registrado Citibank

Nesta modalidade, além de enviar as informações do comprador (nome completo, CPF/CNPJ, endereço), deve-se enviar dentro do nó Payment as informações transacionais:

Requisição

{
    (...)
    "Payment": {
        (...)
        "Type": "Boleto",
        "Provider": "Citibank2",
        "Credentials": {
            "Agency": "1234",
            "Account": "0012345678",
            "Wallet": "181",
            "Code": "01234005678000250181",
            "Agreement": "01234000567800250181"
        }
    }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    (...)
    "Payment": {
        (...)
        "Type": "Boleto",
        "Provider": "Citibank2",
        "Credentials": {
            "Agency": "1234",
            "Account": "0012345678",
            "Wallet": "181",
            "Code": "01234005678000250181",
            "Agreement": "01234000567800250181"
        }
    }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
Payment.Credentials.Agency Número 4 Sim O número da agência bancária. Ex.: 1234.
Payment.Credentials.Account Número 10 Sim O número da conta. Ex.: 0012345678.
Payment.Credentials.Wallet Número 3 Sim Número da carteira informado pelo Citibank. Ex.: 181.
Payment.Credentials.Code Número 20 Sim Portfolio de Conciliação informado pelo Citibank. Ex.: 01234005678000250181
Payment.Credentials.Agreement Número 20 Sim Portfolio Transacional informado pelo Citibank. Ex.: 01234000567800250181

Boleto Registrado Santander

Nesta modalidade, além de enviar as informações do comprador (nome completo, CPF/CNPJ, endereço), deve-se enviar dentro do nó Payment as informações transacionais:

Requisição

{
    (...)
    "Payment": {
        (...)
        "Type": "Boleto",
        "Provider": "Santander2",
        "Credentials": {
            "Agency": "3689",
            "Account": "130064491",
            "Wallet": "CNR",
            "Code": "68910064493",
            "Agreement": "7673728",
            "TransfererCode": "P67J"
        }
    }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    (...)
    "Payment": {
        (...)
        "Type": "Boleto",
        "Provider": "Santander2",
        "Credentials": {
            "Agency": "3689",
            "Account": "130064491",
            "Wallet": "CNR",
            "Code": "68910064493",
            "Agreement": "7673728",
            "TransfererCode": "P67J"
        }
    }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
Payment.Credentials.Agency Número 4 Sim O número da agência bancária. Ex.: 1234.
Payment.Credentials.Account Número 9 Sim O número da conta. Ex.: 123456789.
Payment.Credentials.Wallet Número 3 Sim Número da carteira informado pelo banco. Ex.: CNR.
Payment.Credentials.Code Número 12 Sim Código de Conciliação. Ex.: 12312312312
Payment.Credentials.Agreement Número 7 Sim Código Convênio. Ex.: 1234567
Payment.Credentials.TransfererCode Texto 4 Sim Código Cedente. Ex.: B97L

Boleto Registrado Itaú API

Nesta modalidade, além de enviar as informações do comprador (nome completo, CPF/CNPJ, endereço), deve-se enviar dentro do nó Payment as informações transacionais:

Requisição

{
    (...)
    "Payment": {
        (...)
        "Type": "Boleto",
        "Provider": "Itau2",
        "Credentials": {
            "Agency": "1234",
            "Account": "12315-5",
            "Wallet": "109",
            "Code": "00223046000123",
            "Signature": "12345678-1234-1234-1234-123412341234",
            "Username": "QPP7dwvLqKD57",
            "Password": "70_5EKD4nNrVyAw2OGsrMwv3aiEZ4At6xAqXW0BWkylx7hbxn5f6rhQABosi9sHjGsymWXwHyDAlOdIJTSqt_v7"
        }
    }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    (...)
    "Payment": {
        (...)
        "Type": "Boleto",
        "Provider": "Itau2",
        "Credentials": {
            "Agency": "1234",
            "Account": "12315-5",
            "Wallet": "109",
            "Code": "00223046000123",
            "Signature": "12345678-1234-1234-1234-123412341234",
            "Username": "QPP7dwvLqKD57",
            "Password": "70_5EKD4nNrVyAw2OGsrMwv3aiEZ4At6xAqXW0BWkylx7hbxn5f6rhQABosi9sHjGsymWXwHyDAlOdIJTSqt_v7"
        }
    }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
Payment.Credentials.Agency Número 4 Sim O número da agência bancária. Ex.: 0123.
Payment.Credentials.Account Número 7 Sim O número da conta. Ex.: 12345-1.
Payment.Credentials.Wallet Número 3 Sim A carteira padrão é a 109.
Payment.Credentials.Code Número 14 Sim Código de conciliação gerado pela VAN Nexxera (para Itaú, geralmente, é o CNPJ vinculado à conta). Ex.: 00223046000190
Payment.Credentials.Signature Guid 36 Sim Itaú Key (código gerado pelo Banco Itaú). Ex.: 12345678-1234-1234-1234-123412341234
Payment.Credentials.Username Texto 15 Sim Client Id (código gerado pelo Banco Itaú). Ex.: QPP7dwvLqKD57
Payment.Credentials.Password Texto 100 Sim Client Id (código gerado pelo Banco Itaú). Ex.: 70_5EKD4nNrVyAw2OGsrMwv3aiEZ4At6xAqXW0BWkylx7hbxn5f6rhQABosi9sHjGsymWXwHyDAlOdIJTSqt_v7

Boleto Registrado Itaú Shopline

Nesta modalidade, além de enviar as informações do comprador (nome completo, CPF/CNPJ, endereço), deve-se enviar dentro do nó Payment as informações transacionais:

Requisição

{
    (...)
    "Payment": {
        (...)
        "Type": "Boleto",
        "Provider": "ItauShopline",
        "Credentials": {
            "Agency": "1234",
            "Account": "12315-5",
            "Code": "J0557282240001060000017945",
            "Signature": "1nomedaloja01091952"
        }
    }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    (...)
    "Payment": {
        (...)
        "Type": "Boleto",
        "Provider": "ItauShopline",
        "Credentials": {
            "Agency": "1234",
            "Account": "12315-5",
            "Code": "J0557282240001060000017945",
            "Signature": "1nomedaloja01091952"
        }
    }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
Payment.Credentials.Agency Número 4 Sim O número da agência bancária. Ex.: 0123.
Payment.Credentials.Account Número 7 Sim O número da conta. Ex.: 12345-1.
Payment.Credentials.Code Texto 26 Sim Código do Site informado pelo Itaú. Ex.: J0557282240001060000017945
Payment.Credentials.Signature Texto 36 Sim Chave de Segurança informada pelo Itaú. Ex.: 1nomedaloja01091952

Pagamentos Recorrentes

Autorizar uma transação e agendar as próximas recorrências

Neste exemplo, uma transação é submetida para autorização, e quando aprovada, a recorrência é agendada conforme as regras especificadas na transação. Uma transação recorrente não poderá ser parcelada.

Requisição

{
    "MerchantOrderId":"2017051113",
    "Customer":{
        "Name":"Nome do Cliente"
    },
    "Payment": {
        "Provider":"Simulado",
        "Type":"CreditCard",
        "Amount": 10000,
        "Installments": 1,
        "CreditCard": {
            "CardNumber":"4551870000000181",
            "Holder":"Nome do Portador",
            "ExpirationDate":"12/2021",
            "SecurityCode":"123",
            "Brand":"Visa"
        },
        "RecurrentPayment": {
            "AuthorizeNow":"true",
            "EndDate":"2019-12-31",
            "Interval":"Monthly"
        }
    }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
   "MerchantOrderId":"2017051113",
   "Customer":{
      "Name":"Nome do Cliente"
   },
   "Payment":{
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
     "Installments":1,
     "CreditCard":{
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa"
     },
     "RecurrentPayment":{
       "AuthorizeNow":"true",
       "EndDate":"2019-12-31",
       "Interval":"Monthly"
     }
   }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.Installments Número 2 Sim Número de Parcelas
Payment.RecurrentPayment.EndDate Texto 10 Não Data para termino da recorrência
Payment.RecurrentPayment.Interval Texto 10 Não Intervalo da recorrência.
Monthly (Default) Bimonthly Quarterly SemiAnnual Annual
Payment.RecurrentPayment.AuthorizeNow Booleano Sim Se true, autoriza no momento da requisição. false para agendamento futuro
CreditCard.CardNumber Texto 16 Sim Número do Cartão do comprador
CreditCard.Holder Texto 25 Sim Nome do Comprador impresso no cartão
CreditCard.ExpirationDate Texto 7 Sim Data de validade impresso no cartão, no formato MM/AAAA
CreditCard.SecurityCode Texto 4 Sim Código de segurança impresso no verso do cartão
CreditCard.Brand Texto 10 Sim Bandeira do cartão

Resposta

{
  "MerchantOrderId": "2017051113",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "ProofOfSale": "5646418",
    "AcquirerTransactionId": "0511045646418",
    "AuthorizationCode": "100024",
    "PaymentId": "067f73ce-62fb-4d76-871d-0bcbb88fbd22",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 16:56:46",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "ProviderReturnCode": "4",
    "ProviderReturnMessage": "Operation Successful",
    "RecurrentPayment": {
      "RecurrentPaymentId": "808d3631-47ca-43b4-97f5-bd29ab06c271",
      "ReasonCode": 0,
      "ReasonMessage": "Successful",
      "NextRecurrency": "2017-06-11",
      "EndDate": "2019-12-31",
      "Interval": "Monthly",
      "Link": {
        "Method": "GET",
        "Rel": "recurrentPayment",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/RecurrentPayment/808d3631-47ca-43b4-97f5-bd29ab06c271"
      },
      "AuthorizeNow": true
    },
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/067f73ce-62fb-4d76-871d-0bcbb88fbd22"
      },
      {
        "Method": "PUT",
        "Rel": "capture",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/067f73ce-62fb-4d76-871d-0bcbb88fbd22/capture"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/067f73ce-62fb-4d76-871d-0bcbb88fbd22/void"
      }
    ]
  }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
  "MerchantOrderId": "2017051113",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": false,
      "Brand": "Visa"
    },
    "ProofOfSale": "5646418",
    "AcquirerTransactionId": "0511045646418",
    "AuthorizationCode": "100024",
    "PaymentId": "067f73ce-62fb-4d76-871d-0bcbb88fbd22",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 16:56:46",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "ProviderReturnCode": "4",
    "ProviderReturnMessage": "Operation Successful",
    "RecurrentPayment": {
      "RecurrentPaymentId": "808d3631-47ca-43b4-97f5-bd29ab06c271",
      "ReasonCode": 0,
      "ReasonMessage": "Successful",
      "NextRecurrency": "2017-06-11",
      "EndDate": "2019-12-31",
      "Interval": "Monthly",
      "Link": {
        "Method": "GET",
        "Rel": "recurrentPayment",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/RecurrentPayment/808d3631-47ca-43b4-97f5-bd29ab06c271"
      },
      "AuthorizeNow": true
    },
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/067f73ce-62fb-4d76-871d-0bcbb88fbd22"
      },
      {
        "Method": "PUT",
        "Rel": "capture",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/067f73ce-62fb-4d76-871d-0bcbb88fbd22/capture"
      },
      {
        "Method": "PUT",
        "Rel": "void",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/067f73ce-62fb-4d76-871d-0bcbb88fbd22/void"
      }
    ]
  }
}
Propriedade Descrição Tipo Tamanho Formato
RecurrentPaymentId ID que representa a recorrência, utilizada para consultas e alterações futuras Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
NextRecurrency Data de quando acontecerá a próxima recorrência Texto 7 05/2019 (MM/YYYY)
EndDate Data do fim da recorrência Texto 7 05/2019 (MM/YYYY)
Interval Intervalo entre as recorrência. Texto 10 MonthlyBimonthly Quarterly SemiAnnual Annual
AuthorizeNow Booleano para saber se a primeira recorrencia já vai ser Autorizada ou não. Booleano true ou false

Agendamento de uma Recorrência

Diferentementemente da recorrência anterior, este exemplo não autoriza imediatamente, mas apenas agenda uma autorização futura. Quando esta autorização tiver sucesso, então o agendamento das próximas recorrências será efetivada.

Requisição

{
   "MerchantOrderId":"2017051114",
   "Customer":{
      "Name":"Nome do Cliente"
   },
   "Payment":{
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
     "Installments":1,
     "CreditCard":{
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa"
     },
     "RecurrentPayment":{
       "AuthorizeNow":"false",
       "StartDate":"2017-12-31",
       "EndDate":"2019-12-31",
       "Interval":"Monthly"
     }
   }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
   "MerchantOrderId":"2017051114",
   "Customer":{
      "Name":"Nome do Cliente"
   },
   "Payment":{
     "Provider":"Simulado",
     "Type":"CreditCard",
     "Amount":10000,
     "Installments":1,
     "CreditCard":{
         "CardNumber":"4551870000000181",
         "Holder":"Nome do Portador",
         "ExpirationDate":"12/2021",
         "SecurityCode":"123",
         "Brand":"Visa"
     },
     "RecurrentPayment":{
       "AuthorizeNow":"false",
       "StartDate":"2017-12-31",
       "EndDate":"2019-12-31",
       "Interval":"Monthly"
     }
   }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.Installments Número 2 Sim Número de Parcelas
Payment.RecurrentPayment.StartDate Texto 10 Não Data para início da recorrência
Payment.RecurrentPayment.EndDate Texto 10 Não Data para termino da recorrência
Payment.RecurrentPayment.Interval Texto 10 Não Intervalo da recorrência.
Monthly (Default) Bimonthly Quarterly SemiAnnual Annual
Payment.RecurrentPayment.AuthorizeNow Booleano Sim Se true, autoriza no momento da requisição. false para agendamento futuro
CreditCard.CardNumber Texto 16 Sim Número do Cartão do comprador
CreditCard.Holder Texto 25 Sim Nome do Comprador impresso no cartão
CreditCard.ExpirationDate Texto 7 Sim Data de validade impresso no cartão, no formato MM/AAAA
CreditCard.SecurityCode Texto 4 Sim Código de segurança impresso no verso do cartão
CreditCard.Brand Texto 10 Sim Bandeira do cartão

Resposta

{
  "MerchantOrderId": "2017051114",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": false,
      "Brand": "Undefined"
    },
    "Type": "CreditCard",
    "Amount": 10000,
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "Status": 20,
    "RecurrentPayment": {
      "RecurrentPaymentId": "32703035-7dfb-4369-ac53-34c7ff7b84e8",
      "ReasonCode": 0,
      "ReasonMessage": "Successful",
      "NextRecurrency": "2017-12-31",
      "StartDate": "2017-12-31",
      "EndDate": "2019-12-31",
      "Interval": "Monthly",
      "Link": {
        "Method": "GET",
        "Rel": "recurrentPayment",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/RecurrentPayment/32703035-7dfb-4369-ac53-34c7ff7b84e8"
      },
      "AuthorizeNow": false
    }
  }
}
--header "Content-Type: application/json"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
  "MerchantOrderId": "2017051114",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": false,
    "CreditCard": {
      "CardNumber": "455187******0181",
      "Holder": "Nome do Portador",
      "ExpirationDate": "12/2021",
      "SaveCard": false,
      "Brand": "Undefined"
    },
    "Type": "CreditCard",
    "Amount": 10000,
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "Status": 20,
    "RecurrentPayment": {
      "RecurrentPaymentId": "32703035-7dfb-4369-ac53-34c7ff7b84e8",
      "ReasonCode": 0,
      "ReasonMessage": "Successful",
      "NextRecurrency": "2017-12-31",
      "StartDate": "2017-12-31",
      "EndDate": "2019-12-31",
      "Interval": "Monthly",
      "Link": {
        "Method": "GET",
        "Rel": "recurrentPayment",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/RecurrentPayment/32703035-7dfb-4369-ac53-34c7ff7b84e8"
      },
      "AuthorizeNow": false
    }
  }
}
Propriedade Descrição Tipo Tamanho Formato
RecurrentPaymentId Campo Identificador da próxima recorrência. Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
NextRecurrency Data da próxima recorrência. Texto 7 05/2019 (MM/YYYY)
StartDate Data do inicio da recorrência. Texto 7 05/2019 (MM/YYYY)
EndDate Data do fim da recorrência. Texto 7 05/2019 (MM/YYYY)
Interval Intervalo entre as recorrência. Texto 10 MonthlyBimonthly Quarterly SemiAnnual Annual
AuthorizeNow Booleano para saber se a primeira recorrencia já vai ser Autorizada ou não. Booleano true ou false

Criando uma transação recorrente com Card Token

Este é um exemplo de como utilizar o Card Token, previamente salvo, para criar uma transação. Por questão de segurança, um Card Token não tem guardado o Código de Segurança. Desta forma, é necessário solicitar à adquirente a ativação do recurso de recorrência em seu estabelecimento e a liberação para transacionar sem o envio do Código de Segurança.

Requisição

{
    "MerchantOrderId": "2017051105",
    "Customer": {
        "Name": "Nome do Cliente"
    },
    "Payment": {
        "Provider": "Simulado",
        "Type": "CreditCard",
        "Amount": 10000,
        "Capture": true,
        "Installments": 1,
        "Recurrent": true,
        "CreditCard": {
            "CardToken": "250e7c7c-5501-4a7c-aa42-a33d7ad61167",
            "Brand": "Visa"
        }
    }
}
curl
--request POST "https://apisandbox.braspag.com.br/v2/sales/"
--header "Content-Type: application/json"
--header "MerchantId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--header "MerchantKey: 0123456789012345678901234567890123456789"
--header "RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
--data-binary
{
    "MerchantOrderId": "2017051105",
    "Customer": {
        "Name": "Nome do Cliente"
    },
    "Payment": {
        "Provider": "Simulado",
        "Type": "CreditCard",
        "Amount": 10000,
        "Capture": true,
        "Installments": 1,
        "Recurrent": true,
        "CreditCard": {
            "CardToken": "250e7c7c-5501-4a7c-aa42-a33d7ad61167",
            "Brand": "Visa"
        }
    }
}
--verbose
Propriedade Tipo Tamanho Obrigatório Descrição
MerchantId Guid 36 Sim Identificador da loja na Braspag
MerchantKey Texto 40 Sim Chave Publica para Autenticação Dupla na Braspag
RequestId Guid 36 Não Identificador do Request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT
MerchantOrderId Texto 50 Sim Numero de identificação do Pedido
Customer.Name Texto 255 Sim Nome do comprador
Payment.Provider Texto 15 Sim Nome da provedora de Meio de Pagamento
Payment.Type Texto 100 Sim Tipo do Meio de Pagamento
Payment.Amount Número 15 Sim Valor do Pedido (ser enviado em centavos)
Payment.Installments Número 2 Sim Número de Parcelas
Payment.Recurrent Booleano Sim Booleano que indica uma transação recorrente. Este com valor true não originará uma nova Recorrência, apenas permitirá a realização de uma transação sem a necessidade de envio do CVV.
CreditCard.CardToken Token no Cartão Protegido que representa os dados do cartão Guid 36 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CreditCard.Brand Texto 10 Sim Bandeira do cartão

Resposta

{
  "MerchantOrderId": "2017051105",
  "Customer": {
    "Name": "Nome do Cliente"
  },
  "Payment": {
    "ServiceTaxAmount": 0,
    "Installments": 1,
    "Interest": "ByMerchant",
    "Capture": true,
    "Authenticate": false,
    "Recurrent": true,
    "CreditCard": {
      "SaveCard": false,
      "CardToken": "250e7c7c-5501-4a7c-aa42-a33d7ad61167",
      "Brand": "Visa"
    },
    "ProofOfSale": "124305",
    "AcquirerTransactionId": "0511030124305",
    "AuthorizationCode": "065964",
    "PaymentId": "23cd8bf5-2251-4991-9042-533ff5608788",
    "Type": "CreditCard",
    "Amount": 10000,
    "ReceivedDate": "2017-05-11 15:01:24",
    "Currency": "BRL",
    "Country": "BRA",
    "Provider": "Simulado",
    "ReasonCode": 0,
    "ReasonMessage": "Successful",
    "Status": 1,
    "ProviderReturnCode": "4",
    "ProviderReturnMessage": "Operation Successful",
    "Links": [
      {
        "Method": "GET",
        "Rel": "self",
        "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/23cd8bf5-2251-4991-9042-533ff5608788"
      },
      {
        "Method": "PUT",
        "Rel": "capture",
        "Href": "https://apisandbox.braspag.com.br/v2/sales/23cd8bf5-2251-4991-9042-533ff5608788/capture"
      },
      {
        "Method":<