Criar transação de débito

ℹ️
As características de uma transação de débito são:

Envie o Payment.Type como "DebitCard";

Envie o nó Payment.DebitCard;

O nó Payment.FraudAnalysis não deve ser informado, pois a transação não necessita de análise de fraude;

É obrigatório submeter a transação de débito à autenticação. Por isso, envie o nó Payment.ExternalAuthentication com os dados recebidos durante o processo de autenticação 3DS. Para saber mais sobre a integração 3DS, acesse o Manual de Autenticação 3DS.

Requisição

Ambiente	Método	Endpoint
Sandbox	post	`https://apisandbox.braspag.com.br/v2/sales/`
Produção	post	`https://api.braspag.com.br/v2/sales/`

{
  "MerchantOrderId": "202301131052",
  "Customer": {
    "Name": "Aline De Souza",
    "Identity": "12345678909",
    "IdentityType": "CPF",
    "Email": "[email protected]",
    "Birthdate": "1990-01-01",
    "IpAddress": "127.0.0.1",
    "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": "DebitCard",
    "DoSplit": "true",
    "Amount": 10000,
    "capture": true,
    "installments": 1,
    "softdescriptor": "teste",
    "Returnurl": "https://www.UrlDeRetornoDoLojista.com.br/",
    "Authenticate": true,
    "Recurrent": false,
    "Tip": false,
    "DebitCard": {
      "CardNumber": "5200000000002151",
      "Holder": "Aline De Souza",
      "ExpirationDate": "03/2031",
      "SecurityCode": "079",
      "SaveCard": false,
      "Brand": "Master",
      "CardOnFile": {
        "Usage": "Used",
        "Reason": "Unscheduled"
      }
    },
    "ExternalAuthentication": {
      "Cavv": "AAABB2gHA1B5EFNjWQcDAAAAAAB=",
      "Xid": "Uk5ZanBHcWw2RjRCbEN5dGtiMTB=",
      "Eci": 5,
      "Version": "2",
      "ReferenceId": "a24a5d87-b1a1-4aef-a37b-2f30b91274e6"
    },
    "InitiatedTransactionIndicator": {
      "Category": "C1",
      "Subcategory": "Standingorder"
    }
  },
  "splitpayments": [
    {
      "subordinatemerchantid": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
      "amount": 5000,
      "fares": {
        "mdr": 5,
        "fee": 30
      }
    },
    {
      "subordinatemerchantid": "9140ca78-3955-44a5-bd44-793370afef94",
      "amount": 5000,
      "fares": {
        "mdr": 4,
        "fee": 15
      }
    }
  ]
}

A seguir, veja as propriedades de campo nesta requisição:

Parâmetros no header

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
`Content-Type`	Texto	--	Sim	application/json
`MerchantId`	Texto	36	Sim	Identificador da loja no Gateway de Pagamento.
`MerchantKey`	Texto	40	Sim	Chave pública para autenticação dupla no Gateway de Pagamento.
`RequestId`	Texto	36	Não	Identificador do request definido pela loja, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT.

Parâmetro nos body

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
`MerchantOrderId`	Texto	50	Sim	Número de identificação do pedido. Atenção: Os caracteres permitidos são apenas a-z, A-Z, 0-9. Não são permitidos caracteres especiais e espaços em branco.
`Customer.Name`	Texto	255	Não	Nome do comprador. Tamanho: 255. Atenção: Os caracteres permitidos são apenas a-z, A-Z. Não são permitidos caracteres especiais e números.
`Customer.Identity`	Texto	14	Não	Número do CPF ou CNPJ do cliente. Permite envio de CNPJs alfanuméricos
`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`	Texto	10	Não	Data de nascimento do comprador no formato AAAA-MM-DD.
`Customer.IpAddress`	Texto	45	Não	Endereço de IP do comprador. Suporte a IPv4 e IPv6.
`Customer.Address.Street`	Texto	255	Não	Endereço de contato do comprador.
`Customer.Address.Number`	Texto	15	Não	Número do 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	País do endereço de contato do comprador.
`Customer.Address.District`	Texto	50	Não	Bairro do endereço de contato do comprador.
`Customer.DeliveryAddress.Street`	Texto	255	Não	Endereço de entrega do comprador.
`Customer.DeliveryAddress.Number`	Texto	15	Não	Número do endereço de entrega.
`Customer.DeliveryAddress.Complement`	Texto	50	Não	Complemento do endereço de entrega.
`Customer.DeliveryAddress.ZipCode`	Texto	9	Não	CEP do endereço de entrega.
`Customer.DeliveryAddress.City`	Texto	50	Não	Cidade do endereço de entrega.
`Customer.DeliveryAddress.State`	Texto	2	Não	Estado do endereço de entrega.
`Customer.DeliveryAddress.Country`	Texto	35	Não	País do endereço de entrega.
`Customer.DeliveryAddress.District`	Texto	50	Não	Bairro do endereço de entrega.
`Payment.Provider`	Texto	15	Sim	Nome do provedor do meio de pagamento. Clique aqui para acessar a lista de provedores. Obs.: Atualmente somente a Cielo suporta esta forma de pagamento via Pagador.
`Payment.Type`	Texto	100	Sim	Tipo do meio de pagamento. Neste caso, "DebitCard".
`Payment.Amount`	Número	15	Sim	Valor do pedido, em centavos.
`Payment.Installments`	Número	2	Não	Número de parcelas.
`Payment.ReturnUrl`	Texto	1024	Sim	URL para onde o usuário será redirecionado após o fim do pagamento.
`Payment.Tip`	Booleano	--	Não	As gorjetas são um tipo de transação que funcionam para cartão de crédito ou débito, tokenizados ou não. Se o valor for true, a transação é identificada como gorjeta, caso contrário, o valor deverá ser false.
`DoSplit`	Booleano	--	Sim	Indica se a transação será dividida entre vários participantes. Valores possíveis: true / false
`SplitPayments.SubordinateMerchantId`	Texto	36	Sim	Identificador (GUID) do seller na transação
`SplitPayments.Amount`	Inteiro	15	Sim	Valor bruto da participação do seller na transação, em centavos. O desconto da taxa será calculado pelo Split.
`SplitPayments.Fares.Mdr`	Texto	--	Sim	MDR(%) do master a ser descontado do valor referente à participação do seller.
`SplitPayments.Fares.Fee`	Inteiro	--	Sim	Tarifa Fixa(R$) a ser descontada do valor referente à participação do seller, em centavos.
`Payment.DebitCard.CardNumber`	Texto	16	Sim	Número do cartão do comprador.
`Payment.DebitCard.Holder`	Texto	25	Sim	Nome do comprador impresso no cartão.
`Payment.DebitCard.ExpirationDate`	Texto	7	Sim	Data de validade impresso no cartão, no formato MM/AAAA.
`Payment.DebitCard.SecurityCode`	Texto	4	Não	Código de segurança impresso no verso do cartão. Campo não obrigatório. Para transacionar sem CVV, a loja deve ter autorização da adquirente.
`Payment.DebitCard.Brand`	Texto	10	Sim	Bandeira do cartão. Clique aqui para acessar a lista de valores possíveis.
`Payment.DebitCard.CardOnFile.Usage`	Texto	--	Não	"First" se o cartão foi armazenado e é seu primeiro uso. "Used" se o cartão foi armazenado e ele já foi utilizado anteriormente em outra transação. Aplicável para Cielo, Rede e Safra. Saiba mais em Card On File.
`Payment.DebitCard.CardOnFile.Reason`	Texto	--	Não	Indica o propósito de armazenamento de cartões. Envio condicional - enviar somente se `CardOnFile.Usage` for "Used". Valores possíveis: - "Recurring": compra recorrente programada (ex. assinaturas). Se for transação recorrente, usar `Payment.Recurrent` = "true" (recorrência própria do estabelecimento) ou `Recurrent.Payment` = true (recorrência programada pela Cielo); - "Unscheduled": compra recorrente sem agendamento (ex. aplicativos de serviços); - "Installments": parcelamento através da recorrência. Aplicável para Cielo, Rede e Safra. Saiba mais em Card On File.
`Payment.Authenticate`	Booleano	--	Sim	Define se o comprador será direcionado ao emissor para autenticação do cartão. Sim, caso a autenticação seja validada.
`Payment.ExternalAuthentication.Cavv`	Texto	--	Sim	Assinatura retornada nos cenários de sucesso na autenticação. ⚠️Este campo é obrigatório para transações que foram autenticadas pelo emissor ou pela bandeira e nas solicitações de autorizações com Data Only.
`Payment.ExternalAuthentication.Xid`	Texto	--	Sim	XID retornado no processo de autenticação. - O `Xid` não é retornado em todas as autenticações. - O envio é recomendado caso o `Xid` tenha sido retornado no script.
`Payment.ExternalAuthentication.Eci`	Número	1	Sim	Electronic Commerce Indicator retornado no processo de autenticação.
`Payment.ExternalAuthentication.Version`	Texto	5	Sim	Campo obrigatório para transações com autenticação 3DS. Versão do 3DS aplicado no processo de autenticação. Valores possíveis: - Visa e Mastercard: "2.2.0" - Elo e Amex: "2.1.0"
`Payment.ExternalAuthentication.ReferenceId`	Texto	36	Sim	RequestID retornado no processo de autenticação. - O `ReferenceId` não é retornado em todas as autenticações. - O envio é recomendado caso o `ReferenceId` tenha sido retornado no script.
`Payment.ExternalAuthentication.DataOnly`	Booleano	--	Não	Define se é uma transação com autenticação 3DS do tipo Data Only. O envio é obrigatório no caso de transação Data Only.
`Payment.InitiatedTransactionIndicator.Category`	Texto	2	Não	Obrigatório para as bandeiras Mastercard. Categoria do indicador de início da transação. Válido apenas para bandeira Mastercard. Valores possíveis: - "C1": transação inciada pelo portador do cartão; - "M1": transação recorrente ou parcelada iniciada pela loja; - "M2": transação iniciada pela loja.
`Payment.InitiatedTransactionIndicator.Subcategory`	Texto	--	Não	Obrigatório para as bandeiras Mastercard. Subcategoria do indicador. Válido apenas para bandeira Mastercard. Valores possíveis: Se `InitiatedTransactionIndicator.Category` = "C1" ou "M1" CredentialsOnFile StandingOrder Subscription Installment Se `InitiatedTransactionIndicator.Category` = "M2" PartialShipment RelatedOrDelayedCharge NoShow Resubmission Consulte a tabela com a descrição das subcategorias em Indicador de Início da Transação.

Resposta

{
    "MerchantOrderId": "30082019",
   "Customer": {
    "Name": "Aline De Souza",
    "Identity": "12345678909",
    "IdentityType": "CPF",
    "Email": "[email protected]",
    "Birthdate": "1990-01-01",
    "IpAddress": "127.0.0.1",
    "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": "DebitCard",
    "DoSplit": "true",
    "Amount": 10000,
    "capture": true,
    "installments": 1,
    "softdescriptor": "teste",
    "Returnurl": "https://www.UrlDeRetornoDoLojista.com.br/",
    "Authenticate": true,
    "Recurrent": false,
    "Tip": false,
    "DebitCard": {
      "CardNumber": "5200000000002151",
      "Holder": "Aline De Souza",
      "ExpirationDate": "03/2031",
      "SecurityCode": "079",
      "SaveCard": false,
      "Brand": "Master",
      "CardOnFile": {
        "Usage": "Used",
        "Reason": "Unscheduled"
      }
    },
    "ExternalAuthentication": {
      "Cavv": "AAABB2gHA1B5EFNjWQcDAAAAAAB=",
      "Xid": "Uk5ZanBHcWw2RjRCbEN5dGtiMTB=",
      "Eci": 5,
      "Version": "2",
      "ReferenceId": "a24a5d87-b1a1-4aef-a37b-2f30b91274e6"
    },
    "InitiatedTransactionIndicator": {
      "Category": "C1",
      "Subcategory": "Standingorder"
    }
        "SplitPayments": [
            {
                "SubordinateMerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
                "Amount": 5000,
                "Fares": {
                    "Mdr": 5.0,
                    "Fee": 30
                },
                "Splits": [
                    {
                        "MerchantId": "f2d6eb34-2c6b-4948-8fff-51facdd2a28f",
                        "Amount": 4720
                    },
                    {
                        "MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
                        "Amount": 280
                    }
                ]
            },
            {
                "SubordinateMerchantId": "9140ca78-3955-44a5-bd44-793370afef94",
                "Amount": 5000,
                "Fares": {
                    "Mdr": 4.0,
                    "Fee": 15
                },
                "Splits": [
                    {
                        "MerchantId": "9140ca78-3955-44a5-bd44-793370afef94",
                        "Amount": 4785
                    },
                    {
                        "MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
                        "Amount": 215
                    }
                ]
            }
        ],
        "PaymentId": "5bb92d7c-4f3e-40dc-9f83-bd09c02fea38",
        "Type": "DebitCard",
        "Amount": 10000,
        "ReceivedDate": "2019-08-30 11:04:33",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Simulado",
        "ReasonCode": 9,
        "ReasonMessage": "Waiting",
        "Status": 0,
        "ProviderReturnCode": "1",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/5bb92d7c-4f3e-40dc-9f83-bd09c02fea38"
            },
            {
                "Method": "PUT",
                "Rel": "void",
                "Href": "https://apisandbox.braspag.com.br/v2/sales/5bb92d7c-4f3e-40dc-9f83-bd09c02fea38/void"
            }
        ]
    }
}