Saiba mais sobre essa funcionalidade na documentação.
Requisição
POST /v2/sales/
{
"MerchantOrderId":"2017051001",
"Customer":{
"Name":"Nome do Comprador",
"Identity":"12345678909",
"IdentityType":"CPF",
"Email":"[email protected]",
"Birthdate":"1991-01-02",
"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": "CreditCard",
"Amount": 10000,
"Currency": "BRL",
"Country": "BRA",
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"Authenticate": false,
"Recurrent": false,
"SoftDescriptor": "Mensagem",
"CreditCard": {
"Alias":"Cliente1",
"SecurityCode":"123",
"Brand":"Visa"
},
"Credentials":{
"Code":"9999999",
"Key":"D8888888",
"Password":"LOJA9999999",
"Username":"#Braspag2018@NOMEDALOJA#",
"Signature":"001"
},
"ExtraDataCollection":[
{
"Name":"NomeDoCampo",
"Value":"ValorDoCampo"
}
]
}
}
| Propriedade | Descrição | Tipo | Tamanho | Obrigatório? |
|---|---|---|---|---|
Payment.Provider | Nome do provedor do meio de pagamento. | texto | 15 | Sim |
Payment.Type | Tipo do meio de pagamento. | texto | 100 | Sim |
Payment.Amount | Valor do pedido, em centavos. | número | 15 | Sim |
Payment.Installments | Número de parcelas. | número | 2 | Sim |
CreditCard.SecurityCode | Código de segurança impresso no verso do cartão. Para processar vendas sem o CVV, é necessário solicitar liberação na adquirente. | texto | 4 | Não |
CreditCard.Brand | Bandeira do cartão. | texto | 10 | Sim |
CreditCard.Alias | Alias (apelido) do cartão de crédito. | texto | 64 | Não |
Resposta
{
[...]
},
"Payment": {
"Provider": "Simulado",
"Type": "CreditCard",
"Amount": 10000,
"Currency": "BRL",
"Country": "BRA",
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"Authenticate": false,
"Recurrent": false,
"SoftDescriptor": "Mensagem",
"CreditCard": {
"Alias":"Cliente1",
"SecurityCode":"123",
"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",
[...]
}
}
| 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. | texto | 19 | AAAA-MM-DD HH:mm:SS |
ReasonCode | Código de retorno da API para indicar sucesso ou erro na operação. | texto | 32 | texto alfanumérico |
ReasonMessage | Mensagem correspondente ao ReasonCode. | texto | 512 | texto alfanumérico |
Status | Status da transação. Veja a lista completa de Status da Transação. | byte | 2 | Ex.: 1 |
ProviderReturnCode | Código retornado pelo provedor do meio de pagamento (adquirente ou emissor). | texto | 32 | 57 |
ProviderReturnMessage | Mensagem retornada pelo provedor do meio de pagamento (adquirente ou emissor). | texto | 512 | Transação Aprovada |