Pular para o conteúdo principal

Devolver QrCode de Cobrança

Este endpoint realiza a devolução de um QrCode de cobrança PIX. Para fazê-lo deve ser efetuada a chamada para a API, como especificado abaixo.

aviso

Esta funcionalidade faz a devolução do valor TOTAL do qrcode.

Request​

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

URL
{BaseUrl}/api/v1/pix/collections/:transaction_id/refund

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/refund
    -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
{
        "end_to_end_id": "D53822116202602091150bKaAHBcWyfr",
        "reference_code": "9403d9b8-fc83-4ec0-8c8f-0a05990c7c44",
        "original_end_to_end_id": "E18236120202602091148s011a4a1ff6",
        "original_txid": "QR14759271nZ6IWz2gb9VgQrJajr4T"
}

Descrição dos Atributos​

ATRIBUTODESCRIÇÃOTIPO
end_to_end_id
(Obrigatório)		ID End-to-End do BACEN, da devolução.STRING
limite de 32 caracteres
reference_code
(Obrigatório)		Identificador único da devolução.STRING
limite de 36 caracteres
original_end_to_end_id
(Obrigatório)		ID End-to-End do BACEN, da cobrança original da devolução.STRING
limite de 32 caracteres
original_txid
(Obrigatório)		Identificador único da cobrança original da devolução.STRING
limite de 256 caracteres

Error​

Em caso de erros, será retornado um json com o atributo error especificando o motivo de a operação ter sido rejeitada.

HTTP 400 Response Body - Exemplo
{
    "error": "generator_document not_a_number | generator_document required | generator_name required"
}