Unidentified boleto

This is the transfer of funds from a card to an account, for the purpose of paying a boleto, within the wallet, where the payee was not informed by the wallet. For example, paying a boleto with a branded card (either credit or debit) using the digital wallet and the boleto does not have identification.

See below for an example of a SDWO request of the type unidentified bill payment, with the parameter IsCustomerBillPaymentService = true:

Request

EnvironmentMethodEndpoint
Sandboxhttps://apisandbox.cieloecommerce.cielo.com.br/1/sales/
Productionhttps://api.cieloecommerce.cielo.com.br/1/sales/
{
    "MerchantOrderId": "2012345678",
    "Customer": {
        "Name": "Aline de Souza",
        "Identity": "12345678900",
        "IdentityType": "CPF"
    },
    "Payment": {
        "Type": "CreditCard",
        "Amount": 15700,
        "Installments": 1,
        "IsCustomerBillPaymentService": true,
        "SoftDescriptor": "CARTEIRA*NOMELOJA",
        "CreditCard": {
            "CardNumber": "4532110000001234",
            "Holder": "Aline de Souza",
            "Brand": "Visa",
            "SecurityCode": "333",
            "ExpirationDate": "12/2035"
        },
        "Wallet": {
            "PlatformOperator": "ABC",
            "AdditionalData": {
                "Mcc": "6054"
            }
        }
    }
}

Header parameters

PropertyDescriptionTypeSizeRequired
MerchantIdMerchant identifier in the Cielo E-commerce API.GUID36Yes
MerchantKeyPublic key for dual authentication in the Cielo E-commerce API.string40Yes
RequestIdRequest identifier, used when the merchant uses different servers for each GET/POST/PUT.GUID36No

Body parameters

Check the standard credit or debit card request to verify other optional fields. The table below presents the exclusive parameters for SDWO transactions of the type unidentified bill payment.

ParameterDescriptionTypeSizeRequired?
MerchantOrderIdOrder identification. Can be used to cancel or query the transaction in the future.
Note: Only characters a-z, A-Z, 0-9 are allowed. Special characters and spaces are not permitted.
string50Yes
Customer.NameShopper's name.
Note: Only characters a-z, A-Z are allowed. Special characters and numbers are not permitted.
string255Yes
Customer.IdentityShopper's CPF or CNPJ number.text14Yes, if the holder is a legal entity (CNPJ).
Customer.IdentityTypeType of shopper's identification document (CPF/CNPJ).text255Yes, if the holder is a legal entity (CNPJ).
Payment.TypeType of payment method. Default value: CreditCard.string-Yes
Payment.AmountOrder amount (sent in cents).integer15Yes
Payment.InstallmentsNumber of installments. For installment transactions, the number of installments will always be greater than 1.integer2Yes
IsCustomerBillPaymentServiceIndicates that the transfer is intended for bill paymentboolean-Yes
SoftDescriptorText that will be printed on the cardholder's bank statement. Special characters are not allowed. Must be filled in the format WalletName*merchantname.text13Yes
Payment.CreditCard.CardNumberShopper's card number.string19Yes
Payment.CreditCard.HolderShopper's name printed on the card. Special characters or accents are not accepted.string25Yes
Payment.CreditCard.BrandCard brand. Possible values: Visa / Master / Amex / Elo / Aura / JCB / Diners / Discover.string10Yes
Payment.CreditCard.SecurityCodeSecurity code printed on the back of the card.string4Yes
Payment.CreditCard.ExpirationDateExpiration date printed on the card. Example: MM/YYYY.string7Yes
Payment.Wallet.PlatformOperatorAcronym of the wallet registered at Cielo as a digital wallet (check your acronym with your account manager).string (text)3Yes
Payment.Wallet.AdditionalData.MccDigital wallet MCC for unidentified bill payment transactions, according to the card brand. See the MCC Table for SDWO Fund Transfer Arrangement.string (numeric)4Yes