Pular para o conteúdo principal
GET
/
api
/
pix
/
transactions
/
pix-key
/
{pixKey}
Listar transações por chave PIX
curl --request GET \
  --url https://api.public.firebanking.com.br/api/pix/transactions/pix-key/{pixKey} \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "transactionId": "12345",
      "externalId": "ext-123456",
      "status": "Confirmado",
      "operationType": "Pix in",
      "movementType": "CREDIT",
      "originalAmount": 100,
      "feeAmount": 1,
      "finalAmount": 99,
      "endToEndId": "E12345678901234567890123456789012",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "counterpart": {
        "name": "João Silva",
        "document": "***.456.789-**",
        "bank": {
          "bankISPB": "00000000",
          "bankName": "Banco do Brasil",
          "bankCode": "001",
          "accountBranch": "0001",
          "accountNumber": "123456-7"
        }
      },
      "processedAt": "2025-01-15T10:30:05.000Z"
    }
  ],
  "metadata": {
    "page": 1,
    "size": 20,
    "total": 150,
    "totalPages": 8,
    "hasNext": true,
    "hasPrevious": false
  }
}

Autorizações

Authorization
string
header
obrigatório

Enter JWT token

Parâmetros de caminho

pixKey
string
obrigatório

Chave PIX (CPF, CNPJ, telefone, e-mail ou chave aleatória EVP)

Exemplo:

"joao@example.com"

Parâmetros de consulta

page
integer
padrão:1

Número da página (1-indexed)

Intervalo obrigatório: x >= 1
Exemplo:

1

size
integer
padrão:20

Quantidade de registros por página (máximo 1000)

Intervalo obrigatório: 1 <= x <= 1000
Exemplo:

20

status
enum<string>

Filtro por status da transação

Opções disponíveis:
PENDING,
CONFIRMED,
ERROR
Exemplo:

"CONFIRMED"

type
enum<string>

Filtro por tipo de transação

Opções disponíveis:
PAYMENT,
WITHDRAW,
REFUND_IN,
REFUND_OUT
Exemplo:

"PAYMENT"

startDate
string<date>

Data inicial para filtro (ISO 8601). Se não informado, usa últimos 30 dias.

Exemplo:

"2025-01-01"

endDate
string<date>

Data final para filtro (ISO 8601). Se não informado, usa data atual.

Exemplo:

"2025-01-31"

Resposta

Lista de transações por chave PIX retornada com sucesso

data
object[]
obrigatório

Lista de transações da chave PIX. O total de resultados é limitado a 1000 registros.

metadata
object
obrigatório

Metadados de paginação