Identified 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 informed by the SDWO. For example, paying a boleto with a branded card (either credit or debit) using the digital wallet and the boleto has identification.

See below for an example of a SDWO request of the type identified bill payment, with the parameters IsCustomerBillPaymentService = true and the ReceiverData node, which represents the receiver's data:

Request

{
    "MerchantOrderId": "2012345678",
    "Customer": {
        "Name": "Aline de Souza",
        "Identity": "112345678900",
        "IdentityType": "CPF"
    },
    "Payment": {
        "Type": "CreditCard",
        "Amount": 15700,
        "Installments": 1,
        "IsCustomerBillPaymentService": true,
        "SoftDescriptor": "CARTEIRA*NOMELOJA",
        "SolutionType": "ExternalLinkPay",
        "CreditCard": {
            "CardNumber": "4532110000001234",
            "Holder": "Aline de SOuza",
            "Brand": "Visa",
            "SecurityCode": "333",
            "ExpirationDate": "12/2035"
        },
        "Wallet": {
            "PlatformOperator": "ABC",
            "ReceiverData": {
                "Name": "NOME DO RECEBEDOR",
                "Identity": "11122233344",
                "CompanyName": "NOME RAZAO SOCIAL"
            },
            "AdditionalData": {
                "Mcc": "6054"
            }
        }
    }
}

Header parameters

PropertyDescriptionTypeSizeRequired
MerchantIdMerchant identifier in Gateway de Pagamento.Text36Yes
MerchantKeyPublic key for dual authentication in Gateway de Pagamento.Text40Yes
RequestIdRequest identifier, used when the merchant uses different servers for each GET/POST/PUT.Text36No

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 identified bill payment.

Parameter

Description

Type

Size

Required?

MerchantOrderId

Order 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.

string

50

Yes

Customer.Name

Buyer's name.
Note: Only characters a-z, A-Z are allowed. Special characters and numbers are not permitted.

string

255

Yes

Customer.Identity

Buyer's CPF or CNPJ number.

text

14

Yes, if the holder is a legal entity (CNPJ).

Customer.IdentityType

Type of buyer's identification document (CPF/CNPJ).

text

255

Yes, if the holder is a legal entity (CNPJ).

Payment.Type

Type of payment method. Default value: CreditCard.

string

Yes

Payment.Amount

Order amount (sent in cents).

integer

15

Yes

Payment.Installments

Number of installments. For installment transactions, the number of installments will always be greater than 1.

integer

2

Yes

IsCustomerBillPaymentService

Indicates that the transfer is intended for bill payment

boolean

Yes

SoftDescriptor

Text that will be printed on the cardholder's bank statement. Special characters are not allowed. Must be filled in the format WalletName*merchantname.

text

13

Yes

Payment.CreditCard.CardNumber

Buyer's card number.

string

19

Yes

Payment.CreditCard.Holder

Buyer's name printed on the card. Special characters or accents are not accepted.

string

25

Yes

Payment.CreditCard.Brand

Card brand. Possible values: Visa / Master / Amex / Elo / Aura / JCB / Diners / Discover.

string

10

Yes

Payment.CreditCard.SecurityCode

Security code printed on the back of the card.

string

4

Yes

Payment.CreditCard.ExpirationDate

Expiration date printed on the card. Example: MM/YYYY.

string

7

Yes

Payment.Wallet.PlatformOperator

Acronym of the wallet registered at Cielo as a digital wallet (check your acronym with your account manager).

string (text)

3

Yes

Payment.Wallet.ReceiverData.Name

Name of the receiving customer or establishment.

text

70

Yes

Payment.Wallet.ReceiverData.Identity

CPF or CNPJ number of the receiver.

text

14

Yes

Payment.Wallet.ReceiverData.CompanyName

Corporate name of the receiving establishment.

text

40

Yes, if the receiving customer is a legal entity (CNPJ).

Payment.Wallet.AdditionalData.Mcc

Digital wallet MCC for identified bill payment transactions, according to the card brand. See the MCC Table for SDWO Fund Transfer Arrangement.

string (numeric)

4

Yes