English
Referência da API
AtendimentoAPI Status

Enviar cobrança recorrente com Pix Automático

ℹ️

Saiba mais sobre essa funcionalidade na documentação.

Ao chegar o dia estabelecido para cobrança, a loja deve enviar a cobrança vinculada à recorrência aprovada informando o identificador da recorrência (Payment.RecurrentPayment.RecurrenceId).

O envio da cobrança recorrente segue o mesmo padrão de uma transação, porém com o preenchimento do nó RecurrentPayment.

⚠️

O valor da cobrança recorrente deve ser informado no campo Payment.Amount e pode ser igual ou diferente ao valor do primeiro pagamento, dependendo do acordo feito com o usuário pagador.

Requisição

{
    "MerchantOrderId": "1234567890",
    "OrderDescription": "Serviço de streaming",
    "Customer": {
        "Name": "Aline de Souza",
        "Identity": "123...",
        "IdentityType": "CPF"
    },
    "Payment": {
        "Type": "Pix",
        "Amount": 100,
        "Provider": "Cielo2",
        "ExpirationDate": "2025-07-02",
        "RecurrentPayment": {
            "AuthorizeNow": true,
            "RecurrenceType": "SelfManagedConsent",
            "RecurrenceId": "885aa10d-1f7d-45f0-a0a3-5d25f2c80e07",
            "BusinessDayAdjust": false
        }
    }
}

Parâmetros no header

PropriedadeDescriçãoTipoTamanhoObrigatório
MerchantIdIdentificador da loja na API E-commerce Cielo.GUID36Sim
MerchantKeyChave pública para autenticação dupla na API E-commerce Cielo.string40Sim
RequestIdIdentificador da requisição, usado quando a loja usa diferentes servidores para cada GET/POST/PUT.GUID36Não

Parâmetros no body

ParâmetroDescriçãoTipoTamanhoObrigatório?
MerchantOrderIdNúmero de identificação do pedido. O MerchantOrderId será encaminhado para o provedor de Pix como o número do contrato de recorrência, ou código que representa a autorização.
Atenção: Os caracteres permitidos são apenas a-z, A-Z, 0-9. Não são permitidos caracteres especiais e espaços em branco..		string50Sim
OrderDescriptionÉ a descrição do objeto a ser contratado de forma recorrente. Ex.: serviço de streaming, matrícula de academia, conta recorrente de energia elétrica etc.string40Não
Customer.NameNome do comprador. Atenção: os caracteres permitidos são apenas a-z, A-Z. Não são permitidos caracteres especiais e números.string140Sim
Customer.IdentityNúmero do CPF ou CNPJ do comprador.enum18Sim
Customer.IdentityTypeTipo de documento de identificação do comprador (CPF ou CNPJ).string14Sim
Payment.TypeTipo do meio de pagamento. Neste caso, use "Pix".enum-Sim
Payment.AmountO valor que será cobrado nessa cobrança recorrente, em centavos.number15Sim
Payment.ProviderNome do provedor do meio de pagamento. Neste caso, use "Cielo2".enum-Sim
Payment.ExpirationDateData de vencimento da cobrança. Formato: 2030-12-31 (YYYY-MM-DD)date10Sim
Payment.RecurrentPayment.AuthorizeNowIndica se a cobrança será feita imediatamente. Neste caso, use "true".boolean-Sim
Payment.RecurrentPayment.RecurrenceTypeIdentificador do tipo de recorrência. Neste caso, use "SelfManagedConsent"enum-Sim
Payment.RecurrentPayment.RecurrenceIdIdentificador da recorrência, retornado pela API no momento da criação do QR Code do Pix Automático.string36Sim
Payment.RecurrentPayment.BusinessDayAdjustAtiva ou desativa o ajuste da data prevista para liquidação para próximo dia útil, caso o vencimento corrente seja um dia não útil. O recebedor (loja) deverá considerar os feriados locais com base no código município do usuário pagador (comprador).

Valores possíveis:

- "true": próxima cobrança será apenas em dia útil;
- "false": dias úteis não serão considerados.		boolean-sim

Resposta

{
    "MerchantOrderId": "ba7554d5c3cc450a9f7ecf8c2",
    "Customer": {
        "Name": "Aline de Souza",
        "Identity": "123...",
        "IdentityType": "CPF"
    },
    "Payment": {
        "ExpirationDate": "2025-07-02T00:00:00",
        "RecurrentPayment": {
            "RecurrenceType": "SelfManagedConsent",
            "RecurrenceId": "e3dc5192-aa0b-4cd2-b41c-91bb9430e15c",
            "BusinessDayAdjust": false,
            "Interval": "Monthly",
            "AuthorizeNow": true
        },
        "SentOrderId": "ab0a00e0f0c14358aa9fc42be5e28057",
        "Amount": 100,
        "ReceivedDate": "2025-08-01 14:21:01",
        "Provider": "Cielo2",
        "Status": 12,
        "IsSplitted": false,
        "ReturnMessage": "OPERACAO REALIZADA COM SUCESSO",
        "ReturnCode": "0",
        "PaymentId": "ab0a00e0-f0c1-4358-aa9f-c42be5e28057",
        "Type": "Pix",
        "Currency": "BRL",
        "Country": "BRA",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/ab0a00e0-f0c1-4358-aa9f-c42be5e28057"
            }
        ]
    }
}

A resposta irá retornar o identificador do pagamento no campo Payment.PaymentId. Cada nova cobrança recorrente gera um novo Payment.PaymentId.

ℹ️

Em cobranças recorrentes o QR Code não é retornado pois a cobrança é liquidada diretamente na conta do pagador. Não é necessário ler o QR Code novamente.

ParâmetroDescrição
Payment.SentOrderIdIdentificador da transação Pix, representa o txid da cobrança recorrente.
Payment.PaymentIdIdentificador da transação na API E-commerce Cielo.

⚠️

Atenção:

Caso o pagamento não seja confirmado, é necessário informar o PaymentId para enviar uma retentativa de cobrança.


O Pix Automático não tem ambiente sandbox disponível no momento.