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 no Gateway de Pagamentos.Text36Sim
MerchantKeyChave pública para autenticação dupla no Gateway de Pagamentos.Text40Sim
RequestIdIdentificador da requisição, usado quando a loja usa diferentes servidores para cada GET/POST/PUT.Text36Nã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.string?Sim
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.string255Sim
Customer.IdentityNúmero do CPF ou CNPJ do comprador.string18Sim
Customer.IdentityTypeTipo de documento de identificação do comprador (CPF ou CNPJ).string255Sim
Payment.TypeTipo do meio de pagamento. Neste caso, use "Pix".string-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".string-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"string-Sim
Payment.RecurrentPayment.RecurrenceIdIdentificador da recorrência, retornado pela API no momento da criação do QR Code do Pix Automático.string-Sim

Resposta

{
    "MerchantOrderId": "05681df6bffa4fc48790f7e04",
    "OrderDescription": "Academia",
    "Customer": {
        "Name": "Aline de Souza",
        "Identity": "123...",
        "IdentityType": "CPF"
    },
    "Payment": {
        "ExpirationDate": "2025-07-02T00:00:00",
        "RecurrentPayment": {
            "RecurrenceType": "SelfManagedConsent",
            "RecurrenceId": "885aa10d-1e7d-45f0-a0a3-5d25f2c80e07",
            "BusinessDayAdjust": false,
            "Interval": "Monthly",
            "AuthorizeNow": true
        },
        "SentOrderId": "648510a269404187b62f1394cd912c4a",
        "PaymentId": "648510a2-6940-4187-b62f-1394cd912c4a",
        "Type": "Pix",
        "Amount": 100,
        "ReceivedDate": "2025-08-01 14:17:49",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Cielo2",
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "Status": 12,
        "ProviderReturnCode": "0",
        "ProviderReturnMessage": "OPERACAO REALIZADA COM SUCESSO",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/648510a2-6940-4187-b62f-1394cd912c4a"
            }
        ]
    }
}

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 no Gateway de Pagamentos.

⚠️

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.