Skip to main content
GET
/
transactions
curl -X GET "https://api.thalbank.com/transactions?take=20&skip=0&status=PAID&method=PIX" \
  -H "x-api-key: sua_api_key"
{
  "status": true,
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "amount": 5000,
      "netAmount": 4500,
      "feeAmount": 500,
      "method": "PIX",
      "status": "PAID",
      "paidAt": "2026-03-10T00:05:00.000Z",
      "createdAt": "2026-03-10T00:00:00.000Z"
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "amount": 15000,
      "netAmount": 14250,
      "feeAmount": 750,
      "method": "CREDIT_CARD",
      "status": "PAID",
      "installments": 3,
      "paidAt": "2026-03-10T00:10:00.000Z",
      "createdAt": "2026-03-10T00:09:00.000Z"
    }
  ],
  "count": 150,
  "nextCursor": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
}

Descricao

Retorna uma lista paginada das suas transacoes. Suporta filtros por status, metodo de pagamento, metadata e busca por ID.

Request

take
integer
default:"10"
Numero de registros por pagina.
skip
integer
default:"0"
Numero de registros a pular (offset). Ignorado se cursor for usado.
cursor
string
Cursor para paginacao eficiente. Use o nextCursor da resposta anterior.
status
string
Filtrar por status. Aceita valor unico ou multiplos separados por virgula. Valores: PENDING, PAID, FAILED, REFUNDED, CHARGEDBACK, WAITING_PAYMENT, PROCESSING, AUTHORIZED, REFUSED, DISPUTE
method
string
Filtrar por metodo. Valores: PIX, BOLETO, CREDIT_CARD, CRYPTO
transactionId
string
Buscar por ID exato da transacao.
metadataKey
string
Nome da chave no campo metadata para filtrar.
metadataValue
string
Valor correspondente a metadataKey (busca por substring).
export
boolean
default:"false"
Se true, retorna CSV em vez de JSON.
curl -X GET "https://api.thalbank.com/transactions?take=20&skip=0&status=PAID&method=PIX" \
  -H "x-api-key: sua_api_key"
{
  "status": true,
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "amount": 5000,
      "netAmount": 4500,
      "feeAmount": 500,
      "method": "PIX",
      "status": "PAID",
      "paidAt": "2026-03-10T00:05:00.000Z",
      "createdAt": "2026-03-10T00:00:00.000Z"
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "amount": 15000,
      "netAmount": 14250,
      "feeAmount": 750,
      "method": "CREDIT_CARD",
      "status": "PAID",
      "installments": 3,
      "paidAt": "2026-03-10T00:10:00.000Z",
      "createdAt": "2026-03-10T00:09:00.000Z"
    }
  ],
  "count": 150,
  "nextCursor": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
}