To submit a Gateway de Pagamento transaction to Split de Pagamento, simply send thePayment.DoSplitparameter as true and add thePayment.SplitPaymentsnode.
The characteristics of a credit transaction are:
- Send
Payment.Typeas "CreditCard";- Send the
Payment.CreditCardnode;- If the transaction goes through fraud analysis, send the
Payment.FraudAnalysisnode. Check an example of a credit transaction with fraud analysis in the Gateway manual.
In this case, the master receives the transaction amount minus the MDR agreed with the Split de Pagamento. The Fixed Fee agreed between the master and the Split de Pagamento is applied directly to both parties' schedules.
Split de Pagamento Fee: 2% MDR + R$0.10 Fixed Fee.
Master:
- Credit of R$98.00 (R$100.00 transaction amount minus R$2.00 MDR from Split de Pagamento);
- Debit of R$0.10 (Fixed Fee agreed with Split de Pagamento).
The total amount to be received by the master will be R$97.90.
Split de Pagamento:
- Credit: R$2.10 (MDR applied on the total transaction amount plus R$0.10 Fixed Fee agreed with the Master).
The total amount to be received by Split de Pagamento will be R$2.10.
See the request for this transaction of R$100.00, with automatic capture, without the node containing the split rules.
Alphanumeric CNPJs will be implemented by the Brazilian Federal Revenue Service in July 2026This change applies only to new registrations. There will be no changes to existing CNPJs.
The alphanumeric CNPJ is already supported by Cielo, with no changes required to your integration.
We recommend checking whether adjustments are needed in your merchant’s own checkout systems.
Request
{
"merchantorderid": "30082019",
"customer": {
"Name": "Comprador Accept",
"email": "[email protected]",
"Identity": "18160361106",
"identitytype": "CPF",
"Mobile": "5521995760078"
},
"payment": {
"Provider": "Simulado",
"type": "Creditcard",
"DoSplit": "True",
"amount": 10000,
"capture": true,
"installments": 1,
"softdescriptor": "teste",
"CreditCard": {
"cardNumber": "4481530710186111",
"holder": "Yamilet Taylor",
"ExpirationDate": "12/2030",
"SecurityCode": "693",
"Brand": "Visa",
"SaveCard": "false"
}
}
}Below are the field properties in this request:
| Property (Header) | Type | Size | Required | Description |
|---|---|---|---|---|
MerchantId | Guid | 36 | Yes | Merchant identifier in Split de Pagamento |
MerchantKey | Text | 40 | Yes | Public key for Dual Authentication in Split de Pagamento |
Content-Type | Header | 40 | Yes | Application/json |
| Property | Type | Size | Required | Description |
|---|---|---|---|---|
MerchantOrderId | Text | 50 | Yes | Order identification number |
Customer.Email | Text | 255 | No | Shopper's email |
Customer.Name | Text | 255 | Yes | Shopper's name |
Customer.Identity | Text | 14 | No | Shopper's CPF, or CNPJ number Allows submission of alphanumeric CNPJs. |
Customer.IdentityType | Text | 255 | No | Shopper identification document type (CPF or CNPJ) |
Customer.Mobile | Text | 14 | No | Shopper's mobile phone |
Customer.Phone | Text | 14 | No | Shopper's phone |
Customer.DeliveryAddress.Street | Text | 255 | No | Shopper's address |
Customer.DeliveryAddress.Number | Text | 15 | No | Order delivery address number |
Customer.DeliveryAddress.Complement | Text | 50 | No | Order delivery address complement |
Customer.DeliveryAddress.ZipCode | Text | 9 | No | Order delivery address ZIP code |
Customer.DeliveryAddress.City | Text | 50 | No | Order address city |
Customer.DeliveryAddress.State | Text | 2 | No | Order address state |
Customer.DeliveryAddress.Country | Text | 35 | No | Order delivery address country |
Customer.DeliveryAddress.District | Text | 50 | No | Delivery address neighborhood |
Payment.Provider | Text | 15 | Yes | Name of the payment provider. Possible values:
|
Payment.Type | Text | 100 | Yes | Payment method type. For credit card transactions, use CreditCard. |
Payment.Amount | Number | 15 | Yes | Order amount (to be sent in cents) |
Payment.Installments | Number | 2 | Yes | Number of installments |
Payment.Capture | Boolean | No (Default false) | Boolean indicating whether the authorization should include automatic capture (true) or not (false). | |
Payment.SoftDescriptor | Text | 13 | No | Text to be printed on the cardholder's statement. On the statement, the SoftDescriptor may be shortened according to the acquirer and card brand rules. |
CreditCard.CardNumber | Text | 19 | Yes | Shopper's card number |
CreditCard.Holder | Text | 25 | Yes | Cardholder name printed on the card |
CreditCard.ExpirationDate | Text | 7 | Yes | Expiration date printed on the card |
CreditCard.SecurityCode | Text | 4 | Yes | Security code printed on the back of the card |
CreditCard.Brand | Text | 10 | Yes | Card brand |
CreditCard.SaveCard | Boolean | No (Default false) | Boolean indicating whether the card will be saved to generate the token (CardToken) | |
Payment.ExternalAuthentication.Cavv | Text | -- | No | Signature returned in successful authentication scenarios. ⚠️This field is mandatory for transactions authenticated by the issuer or the card brand, and for authorization requests with Data Only. |
Payment.ExternalAuthentication.Xid | Text | 28 | No |
|
Payment.ExternalAuthentication.Eci | Number | 1 | No |
|
Payment.ExternalAuthentication.Version | Text | 5 | No |
|
Payment.ExternalAuthentication.ReferenceId | Text | 36 | No |
|
Payment.ExternalAuthentication.DataOnly | Boolean | -- | No | Defines whether it is a 3DS authentication transaction of type Data Only. Sending this field is mandatory for Data Only transactions. |
Response
{
"MerchantOrderId": "30082019",
"Customer": {
"Name": "Comprador Accept",
"Identity": "18160361106",
"IdentityType": "CPF",
"Email": "[email protected]",
"Mobile": "5521995760078"
},
"Payment": {
"ServiceTaxAmount": 0,
"Installments": 1,
"Interest": "ByMerchant",
"Capture": true,
"Authenticate": false,
"Recurrent": false,
"CreditCard": {
"CardNumber": "448153******6111",
"Holder": "Yamilet Taylor",
"ExpirationDate": "12/2030",
"SaveCard": false,
"Brand": "Visa"
},
"ProofOfSale": "20190830104433081",
"AcquirerTransactionId": "0830104433081",
"AuthorizationCode": "042693",
"SoftDescriptor": "teste",
"DoSplit": true,
"SplitPayments": [
{
"SubordinateMerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
"Amount": 10000,
"Fares": {
"Mdr": 2.0,
"Fee": 10
},
"Splits": [
{
"MerchantId": "f43fca07-48ec-46b5-8b93-ce79b75a8f63",
"Amount": 10000
}
]
}
],
"PaymentId": "5b01552e-bf38-430e-bd38-8517c36a1ca2",
"Type": "CreditCard",
"Amount": 10000,
"ReceivedDate": "2019-08-30 10:44:13",
"CapturedAmount": 10000,
"CapturedDate": "2019-08-30 10:44:33",
"Currency": "BRL",
"Country": "BRA",
"Provider": "Simulado",
"ReasonCode": 0,
"ReasonMessage": "Successful",
"Status": 2,
"ProviderReturnCode": "6",
"ProviderReturnMessage": "Operation Successful",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.braspag.com.br/v2/sales/5b01552e-bf38-430e-bd38-8517c36a1ca2"
},
{
"Method": "PUT",
"Rel": "void",
"Href": "https://apisandbox.braspag.com.br/v2/sales/5b01552e-bf38-430e-bd38-8517c36a1ca2/void"
}
]
}
}