O exemplo a seguir considera que o consumidor está realizando uma compra na plataforma do master:

- O comprador escolhe pagar com Pix na plataforma do master;
- O master solicita a criação do QR Code Pix do valor total da transação e solicita a divisão entre os participantes (Split transacional);
- A API transacional retorna o QR Code Pix (código em base 64). Nesse momento a transação estará com o status 12 Pendente;
- O master apresenta o QR Code Pix ao comprador para pagamento (leitura do QR Code ou Pix copia-e-cola);
- O comprador efetua pagamento no aplicativo ou ambiente do banco;
- O banco confirma o pagamento para a API transacional;
- A API transacional envia notificação para o master informando que houve atualização no status da transação;
- O master realiza uma consulta na API de consulta transacional para verificar o status atualizado e obter detalhes da transação;
- O Split de Pagamento retorna o status atualizado ( status 2, Pago) e os detalhes da transação.
Envio de taxas na requisição: Se a requisição incluir taxas, essas terão prioridade sobre as taxas cadastradas no portal e-commerce. As taxas do portal e-commerce só serão aplicadas quando nenhuma taxa for enviada ou em casos de redivisão.
CNPJs alfanuméricos serão implementados pela Receita Federal em julho de 2026Essa mudança afeta apenas novas inscrições, não havendo mudanças em CNPJs existentes.
O CNPJ alfanumérico já está sendo suportado pela Cielo, sem mudanças na sua integração.
Recomendamos verificar a necessidade de possíveis ajustes nos sistemas próprios de checkout de sua loja.
Requisição
| Ambiente | Método | Endpoint |
|---|---|---|
| Sandbox | post | https://apisandbox.cieloecommerce.cielo.com.br/1/sales |
| Produção | post | https://api.cieloecommerce.cielo.com.br/1/sales |
--header "Authorization: Bearer {access_token}"
{
"MerchantOrderId": "202412100002",
"Customer": {
"Name": "Aline de Souza",
"Identity": "123456789",
"IdentityType": "CPF"
},
"Payment": {
"Type": "Pix",
"Amount": 20000,
"Provider": "Braspag",
"QrCodeExpiration": 2100,
"SplitPayments": [
{
"SubordinateMerchantId": "768d0acf-9502-4411-9ec0-c5413c671771",
"Amount": 15000,
"Fares": {
"Mdr": 50.0,
"Fee": 100
}
},
{
"SubordinateMerchantId": "d436ad59-6be9-4146-a757-35b97659bedc",
"Amount": 5000,
"Fares": {
"Mdr": 50.0,
"Fee": 100
}
}
],
"DoSplit": true
}
}Parâmetros no header
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
| Authorization Bearer: access_token | String | -- | Sim | Token de acesso. Informe o access_token obtido para a autenticação OAuth2 |
Parâmetros no body
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
|---|---|---|---|---|
MerchantOrderId | String | 36 | Sim | Número de identificação do pedido. |
Customer.Name | String | 255 | Não | Nome do comprador. |
Customer.Identity | String | 14 | Não | Número do CPF ou CNPJ do cliente. Permite envio de CNPJs alfanuméricos. |
Customer.IdentityType | String | 255 | Não | Tipo de documento de identificação do comprador (CPF ou CNPJ). |
Payment.Type | String | 100 | Sim | Tipo do meio de pagamento. "Pix" |
Payment.Amount | Integer | 15 | Sim | Valor do pedido (ser enviado em centavos). |
Payment.Provider | String | 15 | Sim | Nome do provedor do meio de pagamento. Provider = Braspag |
Payment.QrCodeExpiration | Integer | -- | Não | Tempo de expiração do QR Code, em segundos. (Ex: 24 horas = 86400.) |
Payment.SplitPayments.SubordinateMerchantId | String | 36 | Sim | MerchantId (identificador) do Seller. |
Payment.SplitPayments.Amount | Integer | -- | Sim | Valor líquido da participação do seller na transação, em centavos. O desconto da taxa será calculado pelo Split. |
Payment.SplitPayments.Fares.Mdr | String | -- | Não | MDR(%) do master a ser descontado do valor referente a participação do Seller. |
Payment.SplitPayments.Fares.Fee | String | -- | Não | Tarifa fixa(R$) a ser descontada do valor referente a participação do seller, em centavos. |
Payment.DoSplit | Boolean | -- | Sim | Indica se a transação será dividida entre vários participantes. Possíveis valores: true/false |
Resposta
{
"MerchantOrderId": "202411070010",
"Customer": {
"Name": "Aline de Souza",
"Identity": "123456789",
"IdentityType": "CPF"
},
"Payment": {
"QrCodeBase64Image": "iVBORw0KGgoAAAANSUhEUgAAAPQAAAD0CAYAAACsLwv+AAAACXBIWXMAAA7EAAAOxAGVKw4bAAAI60lEQVR4nO3dUa7bNhAF0ATo/rfc9i+AAIOP5cyIvj3n17bk+OWCGJEc/vX3v34BEf76BcQQaAgi0BBEoCGIQEMQgYYgAg1BBBqCCDQEEWgIItAQRKAhiEBDEIGGIAINQY4D/fv371+TVtu3d7/P6Xbw6vs9r/d8/+r1Xad/v937V3//7vvd9v97xQgNQQQaggg0BCkPdHVNtKphdmvO6s+vnNbA3TVndY2++r1Of9/qZwa715v+/73LCA1BBBqCCDQEaQ90d410WtOsPj89bzxdU08/Qzh9/+nvWV2zTj8DWDFCQxCBhiACDUG+PtDTNeVTd41Wfb/uZw4rp+sCqteOT68t7/b1gQb+EGgIItAQ5OsDvVtT7tZQ1TX12/tzp+dhVzXw7vep/v7fXjM/fX2ggT8EGoIINARpD/R0z6jd+3fPM+/W1KvPd+9f7l57Xm16HcDq/m8zQkMQgYYgAg1BygM9XcM8Vc8z3/76SvU8evc8fffrT6c93m5jhIYgAg1BBBqCHAf67Xm46v291fOw3TXnytt90lem+4Kv7r/7+m2M0BBEoCGIQEOQ686Hnj5bavX+Xac9sXY/v7s2fNfbNW71/vbu67/dw8wIDUEEGoIINAQpn4eeXvu7Un0e82mNu3J6FlR1DVm9Frr6GcXp969+xtK9LmHFCA1BBBqCCDQEKZ+HPt2PutJ9fnJ3DXjat/vtmnB6Lffu53dVn489fb73kxEaggg0BBFoCDLel3v6POfunlHVNWh1z6zpHlm3nd/cvRdg+jzyFSM0BBFoCCLQEOT1nmLT5xVPn021e73T939bT6/bVP89VsxDAx8JNAQRaAjy+lrup+79yt09qlam91tXrx3vngfvXuv89l6A6vs9GaEhiEBDEIGGIO3z0Letda1e29z9DKG7j3h3T7jb9jfvvv+0z/rp99tlhIYgAg1BBBqClAe6ep63e96ze5739P3V95uuubtrzOqzsqr7kE8zQkMQgYYgAg1BxnuKrXTv560+6+n0/ObTtc5P1WuVq2vk1fV3X397rf70PPuKERqCCDQEEWgIUr4futrb+493r7/SXePu3v/07ze9f7l6rf3p/4fb9ioYoSGIQEMQgYYg5YGu7sF0WtNU14i7unuUrXTPy1avLd+dd++el+/eH24/NPCRQEMQgYYg151tdbr2unqt8VN3jVW9/7u6L/eu7h5p1WvvV9/HfmhgjEBDEIGGIK8HurvHVvdZW9U15+79V27va776fPff9+11DtVeDzRQR6AhiEBDkK87H3r3/qvrV/fs6l7L+/ba4urzk99+pjF9HvaT/dDARwINQQQagrzel7u7L3N1T6jpHmWnZ2/tXr+6hpyuObtr/O791aeM0BBEoCGIQEOQ8UB/ew00XTOv3v9Uvb+3+rzk7vOpn6p/3+n997uM0BBEoCGIQEOQ9p5i1TXarrfXJnf3SNtdi17ttv3oK9W/j/3QQBuBhiACDUHKA11dk57eb3otbnfN2L02unvt/LTb9uNXf/7JCA1BBBqCCDQEuT7Q0zV5dQ2+e/3qGr17rXV3X/XT60337Z6+3tP1gQZ+TqAhiEBDkOv6cj9V1yyn96+ed9x9//S8/up6p/Pi1TV39edvm1dfMUJDEIGGIAINQcr3Q1fPw+66bW3tU/c8d/f+3Lf3t0+f3bXr7f3RRmgIItAQRKAhyPjZVtXzlt017unru2u1n96e5+/uETa9n/q2tdn2QwMfCTQEEWgIMh7o6nno6Z5du9dbvb+7L3j3+7ufeUw/I9j9/Ns185MRGoIINAQRaAhSHujTmqt7/+5K91lN3dc7vf9K9zOA3fvtmu7TXv19VozQEESgIYhAQ5DX13Lf1td5pXt/bXfPq+rfp3stdHWNedszFfPQwEcCDUEEGoJcF+jqGql77Wz3WvLuGm5X91rw7n//6e9vHhoYI9AQRKAhyHWBnj4rqbrm7O4TPX221PTa9dvmdZ9uq5mfrgs08N8JNAQRaAhSHujTebyn7vOQu2vY6fOdd+//9n7g0/3xb/cNn+4rvmKEhiACDUEEGoK0B/q0pu5em1s9D3taU9++v7r79+zu8/3ta+lXjNAQRKAhiEBDkONA79YUb/fpXl2/el78qbvG3jV9vdMa9bb97Let7TZCQxCBhiACDUGOA33becfda63frgG7+3TvXq/6mUj32vVTp/+f7IcGfkygIYhAQ5DyeejV6901Z/e8YPe8+fR+6ekeXNX3f7tPd/e6il1GaAgi0BBEoCFI+Tz0U3ef7OmeZSunNdV0j6rqZxxv/71X79/9PtNna50yQkMQgYYgAg1B2uehp+dJT9dmr+7fXVNW96mudntPtF3Tew2e7IcGPhJoCCLQEGQ80NXzlNU1+mkPtNX1n07vV712/em0b/qu6bOlpvto2w8N/JhAQxCBhiDtPcWqa4buGry6Zq2eh67ukTZ9ltXq+tU17W09006vv2KEhiACDUEEGoKUB7q7Bq2ep+zu+726XrfTmvT095y+/+rzT9XPZN7+/2CEhiACDUEEGoKMB7q77/T02UbdNf1uDd/dQ2v389X3W13v1G194HcZoSGIQEMQgYYg7T3FqlX3ua7uWTVdU69Mn51V3aNtpbtm796LYB4a+EigIYhAQ5Dxtdy7Tveznq7d7p43va3vdHdf89Xr1b/nqe7rmYcGPhJoCCLQEKQ90N37Q9+ucW87y+nts61W7692W59u+6GBMgINQQQagsQHerpnWff32XVaQ56ude4+n7u6x9fu/W87Sys+0PB/ItAQRKAhSHyg315rvPo+b5+NVf3v765ZV+8/dVrTr1jLDfyYQEMQgYYg7YGePstpZfpsrNX9d19/mq7pu+dlq2vm7v3nb/fhfjJCQxCBhiACDUHKAz3dp7tbdU3dvRa4+vzk0+uvPt+tej/77eeDG6EhiEBDEIGGIMeBfnue+bRGrD5Lqfv3mN4ffdvnT33b33uXERqCCDQEEWgIItAQRKAhiEBDEIGGIAINQQQaggg0BBFoCCLQEESgIYhAQxCBhiD/ANna4EzvdscVAAAAAElFTkSuQmCC",
"QrCodeString": "00020101021226990014br.gov.bcb.pix2577qrcodes-h.cielo.com.br/qr-pix/qrs1/v2/01JXrA9ISCRxAIVHVmIgLBleHhuL4lLWfXcj8NS5204000053039865406200.005802BR5915RAZAO MOCK LTDA6006Recife62070503***6304E7AD",
"Tid": "f264f184660f434db3737170139bb627",
"SentOrderId": "f264f184660f434db3737170139bb627",
"Amount": 20000,
"ReceivedDate": "2025-12-10 11:54:05",
"Provider": "Braspag",
"Status": 12,
"IsSplitted": true,
"ReturnMessage": "QR Code PIX gerado com sucesso.",
"ReturnCode": "0",
"PaymentId": "f264f184-660f-434d-b373-7170139bb627",
"Type": "Pix",
"Currency": "BRL",
"Country": "BRA",
"Links": [
{
"Method": "GET",
"Rel": "self",
"Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/f264f184-660f-434d-b373-7170139bb627"
}
],
"SplitTransaction": {
"Id": "f264f184-660f-434d-b373-7170139bb627",
"Merchant": {
"Id": "247d032d-f917-4a52-8e7a-d850945f065e",
"TypeId": 3,
"Type": "Master"
},
"MasterRateDiscountTypeId": 1,
"MasterRateDiscountType": "Commission",
"ReleasedToAnticipation": true,
"Splits": [
{
"Id": "f804ac4a-3214-4ca1-86b1-8ff9e1670bd8",
"NetAmount": 7400,
"GrossAmount": 15000,
"Fares": {
"Mdr": 50.0,
"Fee": 100,
"DiscountedMdrAmount": 7500,
"CustomPayoutFares": {}
},
"Merchant": {
"Id": "768d0acf-9502-4411-9ec0-c5413c671771",
"TypeId": 4,
"Type": "Subordinate"
},
"PayoutBlocked": false
},
{
"Id": "1424ed78-ffea-4a35-adf9-a6428d1b079d",
"NetAmount": 2400,
"GrossAmount": 5000,
"Fares": {
"Mdr": 50.0,
"Fee": 100,
"DiscountedMdrAmount": 2500,
"CustomPayoutFares": {}
},
"Merchant": {
"Id": "d436ad59-6be9-4146-a757-35b97659bedc",
"TypeId": 4,
"Type": "Subordinate"
},
"PayoutBlocked": false
}
],
"MasterSummary": {
"Commission": {
"SplitId": "6e470b7e-57b3-4f73-9ef1-206ee0a57987",
"NetAmount": 9800,
"GrossAmount": 10200
},
"TotalGrossAmount": 10200,
"TotalNetAmount": 9800
},
"TransactionFares": {
"DiscountedAmount": 400,
"AppliedMdr": 2.00,
"Fee": 0
}
}
}
}Parâmetros da resposta
| Propriedade | Tipo | Descrição |
|---|---|---|
Payment.QrCodeBase64Image | String | Base64 da imagem do QRCode gerado para pagamento do Pix. O prazo de expiração do QRCode gerado é de 2 horas. |
Payment.QrCodeString | String | Código do Pix (copia e cola) que pode ser usado para pagamento. O prazo de expiração do QRCode gerado é de 2 horas. |
Payment.SentOrderId | String | Identificador da transação Pix (txid). A API E-commerce cria um código para cada QRCode solicitado. |
Payment.ReturnCode | String | Código do motivo do erro caso ocorra algum no processo. |
Payment.ReturnMessage | String | Mensagem de retorno. |
Payment.PaymentId | String | Identificador único externo da transação. |
MasterSummary | String | Resumo do Master |
MasterSummary.Commission.SplitId | Alfanumérico | Id da divisão da venda no Split de Pagamentos |
MasterSummary.Commission.NetAmount | Integer | Total líquido do Master (centavos). |
MasterSummary.Commission.GrossAmount | Integer | Total bruto da comissão do Master (centavos). |
MasterSummary.TotalGrossAmount | Integer | Total bruto do Master na divisão da venda (centavos). |
MasterSummary.TotalNetAmount | Integer | Total líquido do Master na divisão da venda (centavos). |
TransactionFares.DiscountedAmount | Integer | Total descontando do Master (centavos). |
TransactionFares.AppliedMdr | Integer | Porcentagem da cobrança da Tarifa Variável (MDR) do Split de Pagamentos |
TransactionFares.Fee | Integer | Total da cobrança da Tarifa Fixa do Split (centavos) |