| Environment | Method | Endpoint |
|---|---|---|
| Sandbox | put | https://apisandbox.braspag.com.br/v2/Sales/ |
| Production | put | https://api.braspag.com.br/v2/Sales/ |
Request
{
"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"
}
]
}
}
| Property | Description | Type | Size | Required? |
|---|---|---|---|---|
Payment.Provider | Name of the payment method provider. | Text | 15 | Yes |
Payment.Type | Payment method type. | Text | 100 | Yes |
Payment.Amount | Order amount in cents. | Number | 15 | Yes |
Payment.Installments | Number of installments. | Number | 2 | Yes |
CreditCard.CardToken | Cartão Protegido token, representing the card data. | GUID | 36 | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
CreditCard.SecurityCode | Security code printed on the back of the card. To make transactions without the CVV, you must request permission with your acquirer. | Text | 4 | No |
CreditCard.Brand | Card brand. | Text | 10 | Yes |
CreditCard.Alias | Credit card alias. | Text | 64 | No |
Response
{
[...]
},
"Payment":{
"Provider":"Simulado",
"Type":"CreditCard",
"Amount":10000,
"Currency":"BRL",
"Country":"BRA",
"Installments":1,
"Interest":"ByMerchant",
"Capture":true,
"Authenticate":false,
"Recurrent":false,
"SoftDescriptor":"Message",
"CreditCard":{
"Alias": "Customer1",
"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",
[...]
}
}
| Property | Description | Type | Size | Format |
|---|---|---|---|---|
AcquirerTransactionId | Transaction ID of the payment method provider. | Text | 40 | Alphanumeric |
ProofOfSale | Proof of sale reference. | Text | 20 | Alphanumeric |
AuthorizationCode | Authorization code from the acquirer. | Text | 300 | Alphanumeric text |
PaymentId | Order identifier field. | GUID | 36 | xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
ReceivedDate | Date the transaction was received by Braspag. | Text | 19 | YYYY-MM-DD HH:mm:SS |
ReasonCode | Operation return code. | Text | 32 | Alphanumeric |
ReasonMessage | Operation return message. | Text | 512 | Alphanumeric |
Status | Transaction status. | Byte | 2 | E.g.: 1 |
ProviderReturnCode | Code returned by the payment provider (acquirer or issuer). | Text | 32 | 57 |
ProviderReturnMessage | Message returned by the payment provider (acquirer or issuer). | Text | 512 | Transaction Approved |