All E-Commerce customers who are Payment Facilitators, as required by the Card Networks and Central Bank must submit new fields in transactional messaging. Cielo will send the information to the Card Networks through transactional messaging at the time of authorization.
The new fields are contained within the Payment Facilitator node. In addition to the fields of this new node, facilitators will also have to send the SoftDescriptor field of the Payment node.
- Warning: If the card brands identify that the required data wasn't sent in the transactional messaging, they will fine Cielo and these fines will be forwarded to the Facilitator responsible for sending the data.
- As of April 15, 2023, Visa updated the rules for marketplace and every merchant who acts as Payment Facilitators and has clients (submerchants) who operate as foreigner marketplace must send the foreigner retail indicator to avoid charges from Visa. The specific parameter is
Payment.PaymentFacilitator.SubEstablishment.CountryCode, which indicates the country code.
Request
{
"MerchantOrderId": "2222222222",
"Customer": {
"Name": "Comprador Teste",
"Identity": "11225468954",
"IdentityType": "CPF",
"Email": "[email protected]",
"Birthdate": "1991-01-02",
"Address": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "Rio de Janeiro",
"State": "RJ",
"Country": "BRA"
},
"DeliveryAddress": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "Rio de Janeiro",
"State": "RJ",
"Country": "BRA"
}
},
"Payment": {
"Type": "CreditCard",
"Amount": 157000,
"Currency": "BRL",
"Country": "BRA",
"Provider": "Cielo",
"ServiceTaxAmount": 0,
"Installments": 1,
"Interest": "ByMerchant",
"Capture": false,
"Authenticate": false,
"Recurrent": false,
"SoftDescriptor": "123456789ABCD",
"CreditCard": {
"CardNumber": "4024007197692931",
"Holder": "Teste Holder",
"ExpirationDate": "12/2021",
"SecurityCode": "123",
"SaveCard": "false",
"Brand": "Visa"
},
"PaymentFacilitator": {
"EstablishmentCode": "1234",
"SubEstablishment": {
"EstablishmentCode": "1234",
"Identity": "11111111000100",
"Mcc": "1234",
"Address": "Alameda Grajau, 512",
"City": "Barueri",
"State": "SP",
"CountryCode": "076",
"PostalCode": "06455914",
"PhoneNumber": "1155855585"
}
}
}
}
| Property | Type | Size | Required | Description |
|---|---|---|---|---|
PaymentFacilitator.EstablishmentCode | text | 11 | Required for facilitators | Facilitator's establishment code. “Facilitator ID” (Registration of the facilitator with the card brands). The code is different depending on the brand, varying even the size of the field: MasterCard –06 digits Visa –08 digits ELO –from 04 to 05 digits Hipercard –06 digits For other brands, like Amex and JCB, the field can be filled in by "0" zeros. |
PaymentFacilitator.SubEstablishment.EstablishmentCode | text | 15 | Required for facilitators | Sub Merchant establishment code. “Sub-Merchant ID” (Registration of sub-accredited with the facilitator) |
PaymentFacilitator.SubEstablishment.Identity | text | 14 | Required for facilitators | CNPJ or CPF of the sub-merchant. |
PaymentFacilitator.SubEstablishment.Mcc | text | 4 | Required for facilitators | MCC do sub Merchant. |
PaymentFacilitator.SubEstablishment.Address | text | 22 | Required for facilitators | Sub Merchant Address. |
PaymentFacilitator.SubEstablishment.City | text | 13 | Required for facilitators | City of the sub Merchant. |
PaymentFacilitator.SubEstablishment.State | text | 2 | Required for facilitators | State do sub Merchant. |
PaymentFacilitator.SubEstablishment.PostalCode | text | 9 | Required for facilitators | Sub Merchant Postcode. |
PaymentFacilitator.SubEstablishment.CountryCode | text | 3 | Required for facilitators | Sub-merchant country code based on ISO 3166. Ex: Brazil's ISO 3166 code is 076. Complete list online. |
PaymentFacilitator.SubEstablishment.PhoneNumber | text | 13 | Required for facilitators | Sub Merchant Phone Number. |
Payment.Softdescriptor | text | 13 | Required for facilitators | Text printed on buyer bank invoice. Must be completed according to the data of the sub Merchant. |
*Avoid using accents as they are considered two characters.
Attention
Fields mustn't be sent with spacing to the left. It can cause rejection in the settlement of transactions.
Response
{
"MerchantOrderId": "2014111701",
"Customer": {
"Name": "Comprador Teste",
"Identity": "11225468954",
"IdentityType": "CPF",
"Email": "[email protected]",
"Birthdate": "1991-01-02",
"Address": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "Rio de Janeiro",
"State": "RJ",
"Country": "BRA"
},
"DeliveryAddress": {
"Street": "Rua Teste",
"Number": "123",
"Complement": "AP 123",
"ZipCode": "12345987",
"City": "Rio de Janeiro",
"State": "RJ",
"Country": "BRA"
}
},
"Payment": {
"ServiceTaxAmount": 0,
"Installments": 1,
"Interest": 0,
"Capture": false,
"Authenticate": false,
"Recurrent": false,
"CreditCard": {
"CardNumber": "402400******2931",
"Holder": "Teste Holder",
"ExpirationDate": "12/2021",
"SaveCard": false,
"Brand": "Visa"
},
"Tid": "1223092935684",
"ProofOfSale": "2935684",
"AuthorizationCode": "065158",
"SoftDescriptor": "123456789ABCD",
"Provider": "Simulado",
"IsQrCode": false,
"PaymentFacilitator": {
"EstablishmentCode": "1234",
"SubEstablishment": {
"EstablishmentCode": "1234",
"Identity": "11111111000100",
"Mcc": "1234",
"Address": "Alameda Grajau, 512",
"City": "Barueri",
"State": "SP",
"CountryCode": "076",
"PostalCode": "06455914",
"PhoneNumber": "1155855585"
}
},
"Amount": 157000,
"ReceivedDate": "2019-12-23 09:29:34",
"Status": 1,
"IsSplitted": false,
"ReturnMessage": "Operation Successful",
"ReturnCode": "4",
"PaymentId": "365c3a0d-fd86-480b-9279-4ba3da21333c",
"Type": "CreditCard",
"Currency": "BRL",
"Country": "BRA",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/365c3a0d-fd86-480b-9279-4ba3da21333c"
},
{
"Method": "PUT",
"Rel": "capture",
"Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/365c3a0d-fd86-480b-9279-4ba3da21333c/capture"
},
{
"Method": "PUT",
"Rel": "void",
"Href": "https://apisandbox.cieloecommerce.cielo.com.br/1/sales/365c3a0d-fd86-480b-9279-4ba3da21333c/void"
}
]
}
}
| Property | Type | Size | Required | Description |
|---|---|---|---|---|
PaymentFacilitator.EstablishmentCode | text | 11 | Required for facilitators | Facilitator's establishment code. “Facilitator ID” (Registration of the facilitator with the card brands). The code is different depending on the brand, varying even the size of the field: MasterCard –06 digits Visa –08 digits ELO –from 04 to 05 digits Hipercard –06 digits For other brands, like Amex and JCB, the field can be filled in by "0" zeros. |
PaymentFacilitator.SubEstablishment.EstablishmentCode | text | 15 | Required for facilitators | Sub Merchant establishment code. “Sub-Merchant ID” (Registration of sub-accredited with the facilitator) |
PaymentFacilitator.SubEstablishment.Identity | text | 14 | Required for facilitators | CNPJ or CPF of the sub-merchant. |
PaymentFacilitator.SubEstablishment.Mcc | text | 4 | Required for facilitators | MCC do sub Merchant. |
PaymentFacilitator.SubEstablishment.Address | text | 22 | Required for facilitators | Sub Merchant Address. |
PaymentFacilitator.SubEstablishment.City | text | 13 | Required for facilitators | City of the sub Merchant. |
PaymentFacilitator.SubEstablishment.State | text | 2 | Required for facilitators | State do sub Merchant. |
PaymentFacilitator.SubEstablishment.PostalCode | text | 9 | Required for facilitators | Sub Merchant Postcode. |
PaymentFacilitator.SubEstablishment.CountryCode | text | 3 | Required for facilitators | Sub-merchant country code based on ISO 3166. Ex: Brazil's ISO 3166 code is 076.Complete list online. |
PaymentFacilitator.SubEstablishment.PhoneNumber | text | 13 | Required for facilitators | Sub Merchant Phone Number. |
Payment.Softdescriptor | text | 13 | Required for facilitators | Text printed on buyer bank invoice. Must be completed according to the data of the sub Merchant. |
*Avoid using accents as they are considered two characters.