Gerar QrCode de Cobrança

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

Request

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

URL

{BaseUrl}/api/v1/pix/collections

HTTP Headers - Exemplo:

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

HTTP Request Body

{
        "value": 150.00,
        "beneficiary_name": "Nome do pagador",
        "beneficiary_document": "12345678901",
        "client_ref": "PEDIDO-12345",
        "expiration_time": 3600,
        "payer_message": "Pagamento referente ao pedido #12345"
}

Descrição dos Atributos

ATRIBUTO	DESCRIÇÃO	TIPO
value (Obrigatório)	Valor da cobrança (qr code), em reais.	DECIMAL maior que 0
beneficiary_name (Obrigatório)	Nome do gerador do qrcode. Será utilizado para cadastrar a cobrança.	STRING limite de 100 caracteres
beneficiary_document (Obrigatório)	CPF (11 dígitos) ou CNPJ (14 dígitos) do gerador do qrcode	STRING limite de 14 caracteres Apenas números
client_ref (Opcional)	Referência externa para identificação no seu sistema	STRING limite de 100 caracteres
expiration_time (Opcional)	Tempo em segundos de expiração do qrcode. Caso não informado, assume valor 1800 (30 minutos)	INTEGER maior que 0
payer_message (Opcional)	Mensagem exibida ao pagador	STRING limite de 100 caracteres

Exemplo cURL - bash

curl -X POST https://api.moneyguard.com.br/api/v1/pix/collections \
    -H "Authorization: Bearer seu_access_token" \
-H "Content-Type: application/json" \
-d '{
    "value": 150.00,
    "beneficiary_name": "Loja Exemplo",
    "beneficiary_document ": "12345678901234",
    "client_ref": "PEDIDO-12345",
    "expiration_time": 3600
}

Response

Após a chamada, é retornado um JSON com o status 201 - Created caso o procedimento tenha ocorrido com sucesso.

HTTP 201 Response Body

{
        "transaction_id": "QR-abc123def456", 
        "qr_code_payload": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890..."
}

Descrição dos Atributos

ATRIBUTO	DESCRIÇÃO	TIPO
transaction_id (Obrigatório)	Código de referência único da cobrança	STRING limite de 100 caracteres
qr_code_payload (Obrigatório)	Conteúdo do QR Code (PIX Copia e Cola)	STRING limite de 255 caracteres

dica

Use o campo qr_code_payload para gerar o QR Code visualmente ou para permitir que o usuário copie e cole no aplicativo do banco.

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": "beneficiary_document not_a_number | beneficiary_document required | beneficiary_name required"
}