Skip to content

QuickPay - Pix In

O módulo QuickPay de recebimento via Pix permite gerar QR Codes dinâmicos e listar transações.


[GET] /

Endpoint de verificação do módulo.

Response (200 OK)

json
"quickpay"

Pix In (Recebimento)

[GET] pix/list

Lista os Pix gerados pela conta ou retorna as transações de um Pix específico.

Variante 1: Listagem GeralGET pix/list?per_page=15&page=1

Response (200 OK)

json
{
  "total": 1,
  "data": [
    {
      "id": 150,
      "txid": "abc123px",
      "qrcode": "000201010212260014br.gov.bcb.pix...",
      "value": 100.50,
      "status": "pending",
      "created_at": "2024-12-10T15:00:00.000000Z",
      "image": "data:image/png;base64,..."
    }
  ],
  "per_page": 15,
  "current_page": 1
}

[POST] pix/create | [POST] pix/qrcode | [POST] pix/qrcode-fixo

Gera um novo QR Code Pix dinâmico.

Request Body

json
{
  "amount": 100.50,
  "webhook": "https://meu-site.com/callback",
  "name": "João da Silva",
  "email": "joao@exemplo.com",
  "document": "12345678901"
}

Response (201 Created)

json
{
  "pix": {
    "id": 151,
    "txid": "def456px",
    "value": 100.50,
    "qrcode": "000201010212260014br.gov.bcb.pix...",
    "created_at": "2024-12-26T16:00:00.000000Z",
    "image": "data:image/png;base64,..."
  }
}

[GET] pix/image

Retorna o payload do QR Code fixo da conta.


[GET] pix/{txid}

Retorna detalhes rápidos de um Pix pelo TXID.

Documentação para Desenvolvedores