Create a credit transaction without the split node

⚠️

To submit a Gateway de Pagamento transaction to Split de Pagamento, simply send the Payment.DoSplit parameter as true and add the Payment.SplitPayments node.

ℹ️

The characteristics of a credit transaction are:

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 2026

This 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)TypeSizeRequiredDescription
MerchantIdGuid36YesMerchant identifier in Split de Pagamento
MerchantKeyText40YesPublic key for Dual Authentication in Split de Pagamento
Content-TypeHeader40YesApplication/json
PropertyTypeSizeRequiredDescription
MerchantOrderIdText50YesOrder identification number
Customer.EmailText255NoShopper's email
Customer.NameText255YesShopper's name
Customer.IdentityText14NoShopper's CPF, or CNPJ number
Allows submission of alphanumeric CNPJs.
Customer.IdentityTypeText255NoShopper identification document type (CPF or CNPJ)
Customer.MobileText14NoShopper's mobile phone
Customer.PhoneText14NoShopper's phone
Customer.DeliveryAddress.StreetText255NoShopper's address
Customer.DeliveryAddress.NumberText15NoOrder delivery address number
Customer.DeliveryAddress.ComplementText50NoOrder delivery address complement
Customer.DeliveryAddress.ZipCodeText9NoOrder delivery address ZIP code
Customer.DeliveryAddress.CityText50NoOrder address city
Customer.DeliveryAddress.StateText2NoOrder address state
Customer.DeliveryAddress.CountryText35NoOrder delivery address country
Customer.DeliveryAddress.DistrictText50NoDelivery address neighborhood
Payment.ProviderText15YesName of the payment provider. Possible values:
  • Sandbox: Simulado
  • Production: Cielo30
Payment.TypeText100YesPayment method type. For credit card transactions, use CreditCard.
Payment.AmountNumber15YesOrder amount (to be sent in cents)
Payment.InstallmentsNumber2YesNumber of installments
Payment.CaptureBoolean
No (Default false)Boolean indicating whether the authorization should include automatic capture (true) or not (false).
Payment.SoftDescriptorText13NoText 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.CardNumberText19YesShopper's card number
CreditCard.HolderText25YesCardholder name printed on the card
CreditCard.ExpirationDateText7YesExpiration date printed on the card
CreditCard.SecurityCodeText4YesSecurity code printed on the back of the card
CreditCard.BrandText10YesCard brand
CreditCard.SaveCardBoolean
No (Default false)Boolean indicating whether the card will be saved to generate the token (CardToken)
Payment.ExternalAuthentication.CavvText--NoSignature 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.XidText28No
  • Mandatory only when the 3DS version is "2" or higher. XID returned during the authentication process.
Payment.ExternalAuthentication.EciNumber1No
  • Electronic Commerce Indicator returned during the authentication process.
Payment.ExternalAuthentication.VersionText5No
  • Mandatory for transactions with 3DS authentication.
    3DS version applied during the authentication process.
    Possible values:
    - Visa and Mastercard: "2.2.0"
    - Elo and Amex: "2.1.0"
Payment.ExternalAuthentication.ReferenceIdText36No
  • Mandatory only when the 3DS version is "2" or higher. RequestID returned during the authentication process.
Payment.ExternalAuthentication.DataOnlyBoolean--NoDefines 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"
            }
        ]
    }
}