Consultar Cobrança Pix

Retorna de forma mais detalhada os dados de uma cobrança. Para fazê-lo deve ser efetuada a chamada para o serviço de consulta de cobrança Pix, enviando como parâmetros o identificador único (transaction_id).

Request

A chamada deverá ser feita utilizando o método GET.

URL

{BaseUrl}/api/v1/pix/collections/{transaction_id}

HTTP Headers - Exemplo:

Authorization: Basic {base64(client_id:client_secret)}
Content-Type: application/json

Exemplo cURL - bash:

curl -X GET https://api.moneyguard.com.br/api/v1/pix/collections/QR-abc123def456 \
    -H "Authorization: Bearer seu_access_token" \
    -H "User-Agent: seu_user_agent"

Response

Em caso de sucesso, será retornado uma mensagem HTTP 200 – OK, contendo os dados, conforme apresentado abaixo:

HTTP 200 Response Body - Exemplo

    {
        "transaction_id": "LPPROBUBMEAJQI1JAMCVO6XISi",
        "client_ref": "LPPROBUBMEAJQI1JAMCVO6XIS",
        "amount": 61.88,
        "qr_code_payload": "0002010014br.gov.bcb.pix2557qrcode.mwbank.com.br/cob/01a026IVI GATEWAY LTDA6009JOINVI62070503***6304C910",
        "status": "paid",
        "beneficiary_name": "Efraim Miqueias Souza De Barros",
        "beneficiary_document": "10778502473",
        "paid_at": "2026-01-07T21:32:43.000-03:00",
        "payer_full_name": "Efraim Miquéias Souza de Barros",
        "payer_tax_id": null,
        "e2e_id": "E18236120202601080032s07cd7a2984",
    }

Descrição dos Atributos

ATRIBUTO	DESCRIÇÃO	TIPO
transaction_id (Obrigatório)	Código de referência único	STRING limite de 100 caracteres
client_ref (Opcional)	Referência externa informada na criação	STRING limite de 100 caracteres
amount (Obrigatório)	Valor da cobrança, em reais	DECIMAL Maior que zero
qr_code_payload (Obrigatório)	Conteúdo do QrCode. (Código copia e cola PIX)	STRING limite de 255 caracteres
status (Obrigatório)	Status da cobrança	ENUM pending (Cobrança criada, aguardando geração do QR Code) awaiting_payment (QR Code gerado, aguardando pagamento) paid (Pagamento recebido com sucesso) expired(Cobrança expirada) canceled(Corança cancelada) reversed (Pagamento devolvido)
beneficiary_name (Opcional)	Nome do gerador do qrcode.	STRING limite de 100 caracteres
beneficiary_document (Opcional)	CPF (11 dígitos) ou CNPJ (14 dígitos) do gerador do qrcode	STRING limite de 14 caracteres
paid_at (Opcional)	Data de pagamento da cobrança (quando pago)	STRING formato datetime YYYY-mm-ddTHH:MM:ss. z
payer_full_name (Opcional)	Documento do pagador (quando pago)	STRING limite de 100 caracteres
payer_tax_id (Opcional)	Documento do pagador (quando pago)	STRING limite de 100 caracteres
e2e_id (Opcional)	ID End-to-End do BACEN (quando pago)	STRING limite de 32 caracteres