Documentação

Listar movimentações do saldo

Devolve as entradas e saídas do saldo, da mais recente para a mais antiga.

GET
/balance/transactions

Autenticação

apiKey
headerAuthorizationBearer <chave de API>

Chave de API no cabeçalho Authorization: Bearer cf_live_.... Crie e revogue chaves no painel, em Desenvolvedores > Chaves de API.

Parâmetros de consulta

type?string

Só movimentações deste tipo.

Valores"top_up""letter""verification""refund""credit""adjustment"
limit?integer

Quantos itens devolver por página, de 1 a 100. Padrão: 20.

Intervalo1 <= value <= 100
Padrão20
cursor?string

O next_cursor da página anterior. Omita para buscar a primeira página.

created_after?string

Só itens criados a partir deste momento, inclusive. Data e hora ISO 8601.

Formatodate-time
created_before?string

Só itens criados antes deste momento. Data e hora ISO 8601.

Formatodate-time

Corpo da resposta

Uma página de movimentações.

application/json
  1. response

Uma página de movimentações do saldo, da mais recente para a mais antiga.

object*string

Tipo do objeto. Sempre list.

data*array<>

Os itens desta página.

has_more*boolean

true quando existem mais itens depois desta página.

next_cursor*|

Envie este valor em cursor para buscar a próxima página. null quando esta é a última.

curl "https://api.cartaflow.com.br/v1/balance/transactions" \  -H "Authorization: Bearer $CARTAFLOW_API_KEY"
{  "object": "list",  "data": [    {      "id": "btx_4Lm8Qw2Zx9Kd",      "object": "balance_transaction",      "type": "letter",      "amount": -1135,      "currency": "BRL",      "balance_after": 48865,      "source_id": "ltr_8Kq2wX4mN7pR",      "description": null,      "created_at": "2026-10-13T14:20:00Z"    },    {      "id": "btx_1Gs5Vb7Nc3Pf",      "object": "balance_transaction",      "type": "top_up",      "amount": 50000,      "currency": "BRL",      "balance_after": 50000,      "source_id": null,      "description": null,      "created_at": "2026-10-12T11:02:00Z"    }  ],  "has_more": true,  "next_cursor": "eyJpZCI6ImJ0eF8xR3M1VmI3TmMzUGYifQ"}