Retentar cobrança não paga com Pix Automático

ℹ️
Saiba mais sobre essa funcionalidade na documentação.

Quando o pagamento de uma cobrança recorrente não é confirmado, é possível enviar até três retentativas de cobrança dentro do período de sete dias.

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",
        "RecurrentPayment": {
            "AuthorizeNow": true,
            "RecurrentType": "SelfManagedConsent",
            "RecurrencePaymentId": "1475900f-8189-4581-be5d-1956c00b04b0",
            "LiquidationDate": "2025-07-02",
        }
    }
}

Parâmetros no header

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
`MerchantId`	Identificador da loja no Gateway de Pagamentos.	Text	36	Sim
`MerchantKey`	Chave pública para autenticação dupla no Gateway de Pagamentos.	Text	40	Sim
`RequestId`	Identificador da requisição, usado quando a loja usa diferentes servidores para cada GET/POST/PUT.	Text	36	Não

Parâmetros no body

Parâmetro	Descrição	Tipo	Tamanho	Obrigatório?
`MerchantOrderId`	Nú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..	string	50	Sim
`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	-	Não
`Customer.Name`	Nome do comprador. Atenção: os caracteres permitidos são apenas a-z, A-Z. Não são permitidos caracteres especiais e números.	string	255	Não
`Customer.Identity`	Número do CPF ou CNPJ do comprador.	string	18	Não
`Customer.IdentityType`	Tipo de documento de identificação do comprador (CPF ou CNPJ).	string	255	Não
`Payment.Type`	Tipo do meio de pagamento. Neste caso, use "Pix".	string	-	Sim
`Payment.Provider`	Nome do provedor do meio de pagamento. Neste caso, use "Cielo2".	enum	-	Sim
`Payment.RecurrentPayment.AuthorizeNow`	Indica se a cobrança será feita imediatamente. Neste caso, use "true".	boolean	-	Sim
`Payment.RecurrentPayment.RecurrenceType`	Identificador do tipo de recorrência. Neste caso, use "SelfManagedConsent"	string	-	Não
`Payment.RecurrentPayment.RecurrencePaymentId`	Identificador da cobrança original na qual houve falha. A API retorna como `PaymentId`.	string	36	Sim
`Payment.RecurrentPayment.LiquidationDate`	Data prevista para liquidação da ordem de pagamento correspondente. Formato: 2030-12-31 (YYYY-MM-DD)	date	10	Sim

Resposta

{
    "MerchantOrderId": "6ae666e6e7094b6bb85a8a286",
    "Customer": {
        "Name": "Aline de Souza"
    },
    "Payment": {
        "AcquirerTransactionId": "93fc7a273e37458e88a2f73e372768af",
        "SentOrderId": "93fc7a273e37458e88a2f73e372768af",
        "PaymentId": "93fc7a27-3e37-458e-88a2-f73e372768af",
        "Type": "Pix",
        "ReceivedDate": "2025-08-01 15:45:07",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Cielo2",
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "Status": 12,
        "ProviderReturnCode": "0",
        "ProviderReturnMessage": "OPERACAO REALIZADA COM SUCESSO",
		"RecurrentPayment": {
            "RecurrenceType": "SelfManagedConsent",
            "RecurrencePaymentId": "e9e7fbf4-48e7-48f9-b42b-72826f2220a8",
            "LiquidationDate": "2025-07-02"
            "AuthorizeNow": true
        },
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/93fc7a27-3e37-458e-88a2-f73e372768af"
            }
        ]
    }
}

A resposta irá retornar o identificador dessa cobrança específica no campo Payment.PaymentId:

Parâmetro	Descrição
`Payment.SentOrderId`	Identificador da transação Pix, representa o `txid` da cobrança recorrente
`Payment.PaymentId`	Identificador da transação no Gateway de Pagamento.

⚠️
Atenção:
A resposta da retentativa de cobrança gera seu próprio Payment.SentOrderId(correspondente ao txid) e PaymentId, porém, no caso de uma retentativa posterior é importante informar o RecurrencePaymentId da cobrança original (aquela na qual houve a primeira negativa).

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

ℹ️

Requisição

Resposta

⚠️Atenção:

⚠️
Atenção: