Gerar QR Code

POST

/v1/deposits

Cria um depósito PIX e retorna o QR Code e o payload para exibição ou geração de cobrança. O cliente paga via Pix e o status é atualizado via webhook.

Requisição

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Exemplo

{
    "amount": 149.9,
    "customer": {
        "name": "João Henrique Duarte",
        "email": "joao.duarte@example.com",
        "phone": "+55 (11) 98888-1234",
        "document": "123.456.789-00"
    },
    "metadata": {},
    "reference": "a4e8a7c1-32e1-405b-9c9a-5ab1f8a2e1dd"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1/deposits' \
--header 'X-Api-Key: {{apiKey}}' \
--header 'X-Api-Secret: {{apiSecret}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 149.9,
    "customer": {
        "name": "João Henrique Duarte",
        "email": "joao.duarte@example.com",
        "phone": "+55 (11) 98888-1234",
        "document": "123.456.789-00"
    },
    "metadata": {},
    "reference": "a4e8a7c1-32e1-405b-9c9a-5ab1f8a2e1dd"
}'

Respostas

🟢200Sucesso

application/json

Body

Exemplo

{
    "data": {
        "id": "01KB1E030N2HY3Y5SFFZH9ZR8N",
        "type": "deposit",
        "amount": 149,
        "feeAmount": 3.75,
        "netAmount": 146.15,
        "method": "pix",
        "status": "pending",
        "qrCode": {
            "payload": "00020101021226...A1630473DB",
            "imageEncoded": "data:image/png;base64,iVBORw0KGgoAAA..."
        },
        "customer": {
            "id": "01JH7M4G9TK5WQX6B2VZ9FQ8RC",
            "name": "João Henrique Duarte",
            "email": "joao.duarte@example.com",
            "phone": "+5511988881234",
            "document": "12345678900"
        },
        "metadata": {},
        "reference": "a4e8a7c1-32e1-405b-9c9a-5ab1f8a2e1dd",
        "expiresAt": "2025-11-28T01:14:14.530Z",
        "createdAt": "2025-11-27T01:14:14.453Z",
        "updatedAt": "2025-11-27T01:14:14.453Z"
    },
    "success": true
}

🟠400400 — Cabeçalho X-Api-Key ausente

🟠400400 — Cabeçalho X-Api-Secret ausente

🟠401401 — Falha na autenticação

🟠422422 — Erro de validação