Exports

Endpoints para enfileirar exportações de cobranças (charges) e saques (withdrawals).

Método	Endpoint	Descrição
GET	/api/export/charges	Enfileira exportação de cobranças
GET	/api/export/withdrawals	Enfileira exportação de saques

Períodos disponíveis (date_range)

Valor	Período
today	Hoje
yesterday	Ontem
current_month	Mês atual
last_seven_days	Últimos 7 dias
last_four_weeks	Últimas 4 semanas
last_month	Mês passado
all	Todo o histórico

Dica

Combine com o header x-timezone (ex.: America/Sao_Paulo) para que os recortes de data respeitem o seu fuso horário.

Exportar cobranças

GET /api/export/charges

all

GET /api/export/charges — Todo o histórico

curl --request GET \
  --url 'https://api.simpixpagamentos.com/api/export/charges?date_range=all' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'

today

GET /api/export/charges — Hoje

curl --request GET \
  --url 'https://api.simpixpagamentos.com/api/export/charges?date_range=today' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'

yesterday

GET /api/export/charges — Ontem

curl --request GET \
  --url 'https://api.simpixpagamentos.com/api/export/charges?date_range=yesterday' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'

current_month

GET /api/export/charges — Mês atual

curl --request GET \
  --url 'https://api.simpixpagamentos.com/api/export/charges?date_range=current_month' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'

last_seven_days

GET /api/export/charges — Últimos 7 dias

curl --request GET \
  --url 'https://api.simpixpagamentos.com/api/export/charges?date_range=last_seven_days' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'

last_four_weeks

GET /api/export/charges — Últimas 4 semanas

curl --request GET \
  --url 'https://api.simpixpagamentos.com/api/export/charges?date_range=last_four_weeks' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'

last_month

GET /api/export/charges — Mês passado

curl --request GET \
  --url 'https://api.simpixpagamentos.com/api/export/charges?date_range=last_month' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'

Exportar saques

GET /api/export/withdrawals

all

GET /api/export/withdrawals — Todo o histórico

curl --request GET \
  --url 'https://api.simpixpagamentos.com/api/export/withdrawals?date_range=all' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'

today

GET /api/export/withdrawals — Hoje

curl --request GET \
  --url 'https://api.simpixpagamentos.com/api/export/withdrawals?date_range=today' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'

last_seven_days

GET /api/export/withdrawals — Últimos 7 dias

curl --request GET \
  --url 'https://api.simpixpagamentos.com/api/export/withdrawals?date_range=last_seven_days' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'

last_month

GET /api/export/withdrawals — Mês passado

curl --request GET \
  --url 'https://api.simpixpagamentos.com/api/export/withdrawals?date_range=last_month' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'

Resposta

A exportação é processada de forma assíncrona — a API responde 202 com o job_id da fila:

202 — Charges export queued

{
  "code": 202,
  "content": {
    "job_id": "ylha4p50euonl2nrwbvl33pj",
    "date_range": "all",
    "kind": "charges"
  },
  "message": "Charges export queued",
  "timestamp": "2026-01-01T19:43:02.492155Z"
}