Skip to content

⚡ QuickPay (Pix In)

Funcionalidade ágil para recebimentos instantâneos via Pix. O sistema utiliza integração direta com parceiros bancários para garantir liquidação imediata e notificação de pagamento.


📥 1. Pix In (Recebimento)

Endpoints para geração de QR Codes e monitoramento de entradas de dinheiro na sua conta FnWallet.

Criar QR Code Dinâmico

POST /quickpay/pix/create

Gera uma cobrança Pix dinâmica para um pagamento único.

Request Body:

CampoTipoObrigatórioDescrição
amountnumericValor do Pix (Formatado como float: 15.50).
descriptionstringTexto opcional que aparecerá no extrato do pagador.
webhookurlURL opcional para receber notificação POST ao pagar.
expiration_datedatePrazo de expiração (Default: 5 dias).
Exemplo de Resposta (201 Created)
json
{
  "code": 201,
  "success": true,
  "pix": {
    "id": 12,
    "txid": "TX123456789",
    "qrcode": "00020101021226840014...",
    "status": "PENDING",
    "description": "Exemplo Pix",
    "value": 15.50,
    "created_at": "2024-03-21 10:00:00",
    "updated_at": "2024-03-21 10:00:00",
    "expires_at": null
  }
}

Listar Recebimentos Pix

GET /quickpay/pix/list

Retorna uma lista paginada de todos os Pix gerados pela conta.

Query Parameters:

ParâmetroTipoDefaultDescrição
pageinteger1Número da página para exibição.
per_pageinteger15Quantidade de itens por página.
txidstringFiltro opcional por TXID ou ID interno.
Exemplo de Resposta (200 OK)
json
{
  "code": 200,
  "success": true,
  "data": {
    "items": [
      {
        "id": 12,
        "txid": "TX123456789",
        "qrcode": "...",
        "status": "PAID",
        "description": "Pagamento Teste",
        "value": 50.00,
        "created_at": "2024-03-21 08:30:00",
        "updated_at": "2024-03-21 09:15:00",
        "expires_at": null
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 15,
      "total": 1,
      "last_page": 1
    }
  }
}

Consultar Pix Específico

GET /quickpay/pix/{txid}

Retorna o status atual da transação Pix e metadados detalhados.

Status Possíveis:

  • PENDING: Aguardando pagamento pelo cliente.
  • PAID: Liquidação confirmada na conta FnWallet.
  • EXPIRED: O Pix não foi pago dentro do prazo estabelecido.
  • DELETED: Transferência removida manualmente ou cancelada.
Exemplo de Resposta (200 OK)
json
{
  "code": 200,
  "success": true,
  "data": {
    "id": 12,
    "txid": "TX123456789",
    "qrcode": "...",
    "status": "PAID",
    "description": "Pagamento Teste",
    "value": 50.00,
    "created_at": "2024-03-21 08:30:00",
    "updated_at": "2024-03-21 09:15:00",
    "expires_at": null
  }
}

Documentação para Desenvolvedores