Cria uma transação de e-wallet usando um cartão criptografado
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | post | https://apisandbox.braspag.com.br/v2/sales |
| Produção | post | https://api.braspag.com.br/v2/sales |
Saiba mais sobre essa funcionalidade na documentação.
A criação de um pagamento com cartão criptografado é indicado para estabelecimentos que não possuem certificação PCI DSS. A requisição contém o nó Wallet, o campo WalletKey (usado pela Cielo para descriptografar os dados das e-wallets) e tokens adicionais de acordo com cada e-wallet.
Atenção
- Quando o nó
Walletfor enviado na requisição, o nóCreditCardpassa a ser opcional;- Devido a necessidade de utilização de chaves efêmeras para realizar operações de crédito, a recorrência não está disponível para transações de e-wallets.
- Aceitamos apenas cartões de crédito e débito via e-wallets.
WalletKey
WalletKey é o identificador utilizado para descriptografar payloads retornados pela wallet.
Confira a seguir os formatos de WalletKey a serem repassados a API do Gateway de Pagamento:
| Carteira | Exemplo | |
|---|---|---|
| Apple Pay | 9zcCAciwoTS+qBx8jWb++64eHT2QZTWBs6qMVJ0GO+AqpcDVkxGPNpOR/D1bv5AZ62+5lKvucati0+eu7hdilwUYT3n5swkHuIzX2KO80Apx/ SkhoVM5dqgyKrak5VD2/drcGh9xqEanWkyd7wl200sYj4QUMbeLhyaY7bCdnnpKDJgpOY6J883fX3TiHoZorb/QlEEOpvYcbcFYs3ELZ7QVtjxyr O2LmPsIkz2BgNm5f+JaJUSAOectahgLZnZR+easdhghrsa/E9A6DwjMd0fDYnxjj0bQDfaZpBPeGGPFLu5YYn1IDc | |
| Samsung Pay | eyJhbGciOiJSU0ExXzUiLCJraWQiOiIvam1iMU9PL2hHdFRVSWxHNFpxY2VYclVEbmFOUFV1ZUR5M2FWeHBzYXVRPS IsInR5cCI6IkpPU0UiLCJjaGFubmVsU2VjdXJpdHlDb250ZXh0IjoiUlNBX1BLSSIsImVuYyI6IkExMjhHQ00ifQ.cCsGbqgFdzVb1jhXNR --gApzoXH-fdafddfa-Bo_utsmDN_DuGm69Kk2_nh6txa7ML9PCI59LFfOMniAf7ZwoZUBDCY7Oh8kx3wsZ0kxNBwfy LBCMEYzET0qcIYxePezQpkNcaZ4oogmdNSpYY-KbZGMcWpo1DKhWphDVp0lZcLxA6Q25K78e5AtarR5whN4HUAkurQ.CFjWpHkAVoLCG8q0.NcsTuauebemJXmos_mLMTyLhEHL- p5Wv6J88WkgzyjAt_DW7laiPMYw2sqRXkOiMJLwhifRzbSp8ZgJBM25IX05dKKSS4XfFjJQQjOBHw6PYtEF5pUDMLHML3jcddCrX07abfef_DuP41PqOQYsjwesLZ8XsRj- R0TH4diOZ_GQop8_oawjRIo9eJr9Wbtho0h8kAzHYpfuhamOPT718EaGAY6SSrR7t6nBkzGNkrKAmHkC7aRwe.AbZG53wRqgF0XRG3wUK_UQ | |
| Google Pay | {"encryptedMessage":"0mXBb94Cy9JZhMuwtrBhMjXb8pDslrNsN5KhcEqnowOINqJgjXHD36KcCuzpQQ4cDAe64ZLmk2N3UBGXsN9hMMyeMakXlidVmteE +QMaNZIor048oJqlUIFPD54B/ic8zCdqq3xnefUmyKQe0I03x57TcEA9xAT/E4x3rYfyqLFUAEtu2lT0GwTdwgrsT8pKoTldHIgP+wVNTjrKvJrB4xM/Bhn6JfcSmOzFyI6w37 mBU71/TK761nYOSxt7z1bNWSLZ4b8xBu1dlRgen2BSlqdafuQjV3UZjr6ubSvaJ8NiCh5FD/X013kAwLuLALMS2uAFS9j8cZ6R6zNIi13fK6Fe4ACbFTHw LzSNZjQiaRDb6MlMnY8/amncPIOXzpirb5ScIz8EZUL05xd+3YWVTVfpqgFo1eaaS+wZdUyRG0QEgOsr6eLBoH8d5lfV9Rx6XdioorUuT7s1Yqc0OJZO +fhBt6X0izE9hBGTexdZyg\\u003d\\u003d","ephemeralPublicKey":"BMdwrkJeEgCOtLevYsN3MbdP8xbOItXiTejoB6vXy0Kn0ZM10jy4Aasd6jTSxtoxo TpFydLhj5kzoOhbw2OzZu0\\u003d","tag":"yAQIjWZ0VuCC7SWyYwc4eXOzpSUKhZduF9ip0Ji+Gj8\\u003d"} |
EphemeralPublicKey
Formato de EphemeralPublicKey que deve ser repassado a API do Gateway de Pagamento:
| Carteira | Exemplo |
|---|---|
| Apple Pay | MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEoedz1NqI6hs9hEO6dBsnn0X0xp5/DKj3gXirjEqxNIJ8JyhGxVB3ITd0E+6uG4W6Evt+kugG8gOhCBrdUU6JwQ== |
Signature
Formato de Signature que deve ser repassado a API do Gateway de Pagamento:
| Carteira | Exemplo |
|---|---|
| Google Pay | MEUCIQCGQLOmwxe5eFMSuTcr4EcwSZu35fB0KlCWcVop6ZxxhgIgbdtNHThSlynOopfxMIxkDs0cLh2NFh5es+J5uDmaViA\u003d |
Requisição
-- Envio de cartão
{
"MerchantOrderId": "2014111708",
"Customer": {
"Name": "Aline de Souza",
"Identity": "58154781050",
"IdentityType": "CPF"
},
"Payment": {
"Type": "CreditCard",
"Amount": 10000,
"Provider": "Simulado",
"DoSplit": "True",
"Installments": 1,
"Currency": "BRL",
"Capture": "false",
"CreditCard": {
"CardNumber":"4091688625337641",
"Holder":"Aline de Souza",
"ExpirationDate":"12/2035",
"SecurityCode":"333",
"Brand":"Visa"
},
"Wallet": {
"Type": "TIPO DE WALLET",
"WalletKey": "IDENTIFICADOR DA LOJA NA WALLET",
"AdditionalData": {
"EphemeralPublicKey": "TOKEN INFORMADO PELA WALLET"
}
},
"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
}
}
]
}
}| 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. |
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 do provedor do meio de pagamento. -Para ApplePay, SamsungPay e GooglePay, use os providers Cielo (Cielo30). Para o provider PayPal, use o valor “PayPal”. |
Payment.DoSplit | Booleano | Sim | Indica se a transação será dividida entre vários participantes Possíveis valores: true / false | |
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). | |
Payment.Installments | Número | 2 | Sim | Número de Parcelas. |
CreditCard.CardNumber. | Texto | 19 | Sim | Número do cartão do comprador ou DPAN. |
CreditCard.Holder | Texto | 25 | Não | Nome do comprador impresso no cartão (titular do cartão). Não aceita caracteres especiais ou acentuação. Importante: o nome do titular do cartão é informado pela carteira. Se a loja tiver recebido o nome do titular, recomendamos informar na requisição à Cielo. Caso a loja não tenha o nome do titular do cartão, não envie o campo CreditCard.Holder ou envie com o valor null. |
CreditCard.SecurityCode | Texto | 4 | Não | Código de segurança impresso no verso do cartão - Ver Anexo. |
CreditCard.Brand | Texto | 10 | Sim | Bandeira do cartão (Visa / Master / Amex / Elo / Aura / JCB / Diners / Discover). |
Wallet.Type | Texto | 255 | Sim | Indica qual o tipo de carteira: AndroidPay / ApplePay / SamsungPay |
Wallet.Walletkey | Texto | 255 | Sim | Chave criptografica que identifica lojas nas Wallets - Ver tabela WalletKey para mais informações |
Wallet.Eci | Texto | 3 | Sim (quando a carteira devolve) | O ECI (Eletronic Commerce Indicator) representa o quão segura é uma transação. Esse valor deve ser levado em consideração pelo lojista para decidir sobre a captura da transação. |
Wallet.Cavv | Texto | 255 | Sim | Campo de validação retornado pela Wallet e utilizado como base de autorização |
SplitPayments.SubordinateMerchantId | Texto | 36 | Sim | MerchantId (Identificador) do seller. |
SplitPayments.Amount | Inteiro | Sim | Parte do valor total da transação referente a participação do seller, em centavos. | |
SplitPayments.Fares.Mdr | Decimal | Não | MDR(%) do Master a ser descontado do valor referente a participação do seller | |
SplitPayments.Fares.Fee | Inteiro | Não | Tarifa Fixa(R$) a ser descontada do valor referente a participação do seller, em centavos. |
Resposta
{
"MerchantOrderId": "2014111708",
"Customer": {
"Name": "Aline de Souza"
},
"Payment": {
"Installments": 1,
"Provider": "Simulado",
"Interest": 0,
"Capture": false,
"Authenticate": false,
"Recurrent": false,
"CreditCard": {
"CardNumber": "4091688625337641",
"Holder": "Aline de Souza",
"ExpirationDate": "12/2035",
"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",
"DoSplit": true,
"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
}
]
}
],
"Amount": 10000,
"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"
}
]
}
}A seguir, a listagem de campos da Resposta:
| Propriedade | Descrição | Tipo | Tamanho | Formato |
|---|---|---|---|---|
ProofOfSale | Número da autorização, idêntico 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 bancária do portador - Disponível apenas para VISA/MASTER - não 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 |
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 ou Google Pay | 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 |