Ambiente | Método | Endpoint |
---|---|---|
Sandbox | post | https://apisandbox.braspag.com.br/v1/sales/ |
Produção | post | https://api.braspag.com.br/v1/sales/ |
POST /1/sales/Saiba mais sobre essa funcionalidade na documentação.
{
"MerchantOrderId":"2014111701",
"Customer":{
"Name":"Comprador crédito completo",
"Email":"[email protected]",
"Birthdate":"1991-01-02"
},
"Payment":{
"Type":"DebitCard",
"Amount":15700,
"Currency":"BRL",
"Country":"BRA",
"Installments":1,
"Capture":true,
"Authenticate":"false",
"SoftDescriptor":"123456789ABCD",
"DebitCard":{
"CardNumber":"1234123412341231",
"Holder":"Teste Holder",
"ExpirationDate":"12/2030",
"SecurityCode":"123",
"SaveCard":"false",
"Brand":"Visa",
"CardOnFile":{
"Usage": "First",
"Reason":"Recurring"
}
}
}
}
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. |
Customer.Status | Texto | 255 | Não | Status de cadastro do comprador na loja (NEW / EXISTING) |
Customer.Email | Texto | 255 | Não | E-mail do comprador. |
Customer.Birthdate | Date | 10 | Não | Data de nascimento do comprador (AAAA/MM/DD). |
Payment.Type | Texto | 100 | Sim | Tipo do meio de pagamento. |
Payment.Amount | Número | 15 | Sim | Valor do pedido (ser enviado em centavos). |
Payment.Currency | Texto | 3 | Não | Moeda na qual o pagamento será feito (BRL). |
Payment.Country | Texto | 3 | Não | País na qual o pagamento será feito. |
Payment.SoftDescriptor | Texto | 13 | Não | O complemento do nome da loja que aparecerá na fatura do cartão. Não permite caracteres especiais. |
Payment.Installments | Número | 2 | Sim | Número de parcelas. Se a transação for uma recorrência, o número de parcelas será 1. Para transações parceladas, o número de parcelas será sempre maior que 1. |
Payment.Capture | Booleano | — | Não (Default false) | Booleano que identifica que a autorização deve ser com captura automática (“true”) ou captura posterior (“false”). |
DebitCard.CardNumber | Texto | 19 | Sim | Número do cartão do comprador. |
DebitCard.Holder | Texto | 25 | Sim | Nome do comprador impresso no cartão. Não aceita caracteres especiais ou acentuação. |
DebitCard.ExpirationDate | Texto | 7 | Sim | Data de validade impressa no cartão. Ex. MM/AAAA. |
DebitCard.SecurityCode | Texto | 4 | Não | Código de segurança impresso no verso do cartão. |
DebitCard.SaveCard | Booleano | — | Não (Default false) | Booleano que identifica se o cartão será salvo para gerar o CardToken . Saiba mais sobre Tokenização. |
DebitCard.Brand | Texto | 10 | Sim | Bandeira do cartão. Valores possíveis: Visa / Master / Amex / Elo / Aura / JCB / Diners / Discover / Hipercard. |
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 |
DebitCard.CardOnFile.Reason | Texto | - | Condicional | Indica o propósito de armazenamento de cartões, caso o campo CardOnFile.Usage for “Used”.Recurring: compra recorrente programada (ex. assinaturas). Se for transação recorrente, usar Payment.Recurrent = true (recorrência própria) ou Recurrent.Payment = true (recorrência programada).Unscheduled: compra recorrente sem agendamento (ex. aplicativos de serviços). Installments: parcelamento através da recorrência. |
Resposta
{
"MerchantOrderId": "2014111701",
"Customer": {
"Name": "Comprador crédito completo",
"Email": "[email protected]",
"Birthdate": "1991-01-02"
},
"Payment": {
"ServiceTaxAmount": 0,
"Installments": 1,
"Capture": true,
"Authenticate": false,
"DebitCard": {
"CardNumber": "123412******1231",
"Holder": "Teste Holder",
"ExpirationDate": "12/2030",
"SaveCard": false,
"Brand": "Visa",
"CardOnFile": {
"Usage": "First",
"Reason": "Recurring"
},
"PaymentAccountReference": "JZHOZJHNZH87KQXM3G60B9I21GVZN"
},
"Tid": "0928084922246",
"ProofOfSale": "652515",
"AuthorizationCode": "927181",
"SoftDescriptor": "123456789ABCD",
"Provider": "Simulado",
"IsQrCode": false,
"DynamicCurrencyConversion": false,
"Amount": 15700,
"ReceivedDate": "2022-09-28 08:49:22",
"CapturedAmount": 15700,
"CapturedDate": "2022-09-28 08:49:22",
"Status": 2,
"IsSplitted": false,
"ReturnMessage": "Operation Successful",
"ReturnCode": "6",
"PaymentId": "91bad53a-9198-4738-a280-f51dddc34988",
"Type": "CreditCard",
"Currency": "BRL",
"Country": "BRA",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/91bad53a-9198-4738-a280-f51dddc34988"
},
{
"Method": "PUT",
"Rel": "void",
"Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/91bad53a-9198-4738-a280-f51dddc34988/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 impresso na fatura bancária do portador. Não permite caracteres especiais. | Texto | 13 | Texto alfanumérico |
PaymentId | Número de identificação do pagamento, necessário para futuras operações como Consulta, Captura e Cancelamento. | Guid | 36 | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
ECI | Eletronic Commerce Indicator. Representa o quão segura é uma transação. | Texto | 2 | Exemplo: 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 |
Payment.MerchantAdviceCode | Código de retorno da bandeira que define período para retentativa. Válido somente para bandeira Mastercard. Saiba mais em Programa de Retentativa das Bandeiras Mastercard | Texto | 2 | Numérico |
DebitCard.PaymentAccountReference | O PAR (Payment Account Reference) é o número que associa diferentes tokens a um mesmo cartão. Será retornado pelas bandeiras Master e Visa e repassado para os clientes do e-commerce Cielo. Caso a bandeira não envie a informação o campo não será retornado.Se for pra transação de débito, colocar o campo dentro do nó de DebitCard. | Alfanumérico | 29 | — |