Extracto

Tres lecturas de lo que se movió: el extracto de un día cerrado, las transacciones de ahora y el resumen de un período. Todas con el alcance ex.extrato.read.

Extracto del día #

GET /v2/ex/extrato/{data}

Solo para un día cerrado. data es el día contable en America/Sao_Paulo.

GET /v2/ex/extrato/2026-09-17
→ 200
{
  "data": "2026-09-17",
  "conciliado": false,
  "geradoEm": "2026-09-18T12:00:00.786679Z",
  "totais": {
    "creditos": "650.00",
    "debitos": "0.00",
    "emAberto": { "creditos": "0.00", "debitos": "0.00", "quantidade": 0 }
  },
  "transacoes": [
    {
      "data": "2026-09-17T13:05:00Z",
      "tipo": "DEPOSITO",
      "sentido": "CREDITO",
      "valor": "150.00",
      "referencia": "FIN02J1ZK7M9QW3ERT5TY6UI8O",
      "endToEndId": "E12345678202609181200000000000001",
      "status": "CREDITADO",
      "efetivado": true
    },
    {
      "data": "2026-09-17T13:00:00Z",
      "tipo": "DEPOSITO",
      "sentido": "CREDITO",
      "valor": "500.00",
      "referencia": "FIN01J1ZK7M9QW3ERT5TY6UI8O",
      "endToEndId": "E12345678202609181200000000000002",
      "status": "CREDITADO",
      "efetivado": true
    }
  ],
  "cursor": { "proximo": "", "temMais": false }
}

El extracto del día pagina como los listados: pase cursor.proximo en ?cursor= mientras cursor.temMais sea true.

GET /v2/ex/extrato/{data}/arquivo devuelve el mismo día en CSV, con el SHA-256 del contenido en el trailer x-conteudo-sha256. Con ?formato=zip, devuelve un zip con el mismo CSV dentro, unas cinco veces más pequeño, y el trailer sigue siendo el SHA-256 del CSV. Otro valor en formato es 400 formato_invalido.

Transacciones de ahora #

GET /v2/ex/transacoes

La ventana es de instantes RFC 3339: de se incluye, ate no. Sin uno de los dos, queda abierta de ese lado. Los depósitos aparecen al acreditarse; los retiros y las devoluciones, al solicitarse, con el status del momento, y pasan al instante en que el dinero salió cuando salen: verifique efetivado.

Para listar solo un tipo o una situación, pase tipo y situacao: cada uno acepta varios valores, separados por comas. Un valor que no existe es 400.

GET /v2/ex/transacoes?de=2026-09-18T00:00:00Z&ate=2026-09-18T23:59:59Z&limite=2
→ 200
{
  "transacoes": [
    {
      "data": "2026-09-18T12:00:03.779747Z",
      "tipo": "DEVOLUCAO",
      "sentido": "DEBITO",
      "valor": "50.00",
      "referencia": "E12345678202609181200000000000001:DEV01J1ZK7M9QW3ERT5TY6UI8O",
      "endToEndId": "E12345678202609181200000000000001",
      "status": "EM_PROCESSAMENTO",
      "efetivado": false
    },
    {
      "data": "2026-09-18T12:00:02.774316Z",
      "tipo": "SAQUE",
      "sentido": "DEBITO",
      "valor": "300.00",
      "referencia": "SAQ01J1ZK7M9QW3ERT5TY6UI8O",
      "endToEndId": "E12345678202609181200000000000003",
      "status": "EM_PROCESSAMENTO",
      "efetivado": false
    }
  ],
  "cursor": { "proximo": "MTc4OTcyMzIyMzc2NDAzMH5GSU4w...", "temMais": true }
}

Para la misma selección en un archivo, use GET /v2/ex/transacoes/arquivo con de y ate (obligatorios, hasta 31 días), tipo y situacao. Devuelve un CSV para hoja de cálculo, separado por punto y coma, con las mismas líneas y en el mismo orden; con ?formato=zip, el mismo CSV dentro de un zip. El trailer x-linhas dice cuántas transacciones vinieron. No lleva el SHA-256: para conciliar, use el archivo del día cerrado.

Resumen del período #

GET /v2/ex/resumo

Suma los días cerrados entre de y ate, ambos AAAA-MM-DD, hasta 366 días. Si ate incluye el día en curso, atePedido dice lo que se solicitó y ate lo que se sumó.

GET /v2/ex/resumo?de=2026-08-19&ate=2026-09-18
→ 200
{
  "de": "2026-08-19",
  "ate": "2026-09-17",
  "atePedido": "2026-09-18",
  "geradoEm": "2026-09-18T12:00:00.792600Z",
  "totais": {
    "creditos": "650.00",
    "debitos": "0.00",
    "operacoesCredito": 2,
    "operacoesDebito": 0,
    "ticketMedio": "325.00"
  },
  "porDia": [
    { "dia": "2026-09-17", "creditos": "650.00", "debitos": "0.00", "operacoes": 2 }
  ],
  "porTipo": [
    { "tipo": "DEPOSITO", "creditos": "650.00", "debitos": "0.00", "operacoes": 2 }
  ]
}

Un día sin movimiento no aparece en porDia. ticketMedio es creditos dividido por operacoesCredito.

Con incluirHoje=true la suma incluye el día corriente, hasta el instante de la consulta. La respuesta trae parcialAte, el instante hasta el que se sumó el día de hoy, y ate pasa a ser el último día sumado. Este número cambia hasta el cierre del día.

Encontrar una operación por cualquier id #

GET /v2/ex/transacoes/mapear

Recibe en ref un txid, idEnvio, endToEndId, rtrId, su referencia externa o el id de una retención (el mismo que lista GET /v2/ex/bloqueios), y dice dónde la encontró. La lista procuradas de la respuesta es dónde buscó el servidor, e incluye dominios internos.

GET /v2/ex/transacoes/mapear?ref=SAQ01J1ZK7M9QW3ERT5TY6UI8O
→ 200
{
  "ref": "SAQ01J1ZK7M9QW3ERT5TY6UI8O",
  "achados": [
    {
      "dominio": "payout",
      "campo": "id_envio",
      "id": "SAQ01J1ZK7M9QW3ERT5TY6UI8O",
      "situacao": "EM_PROCESSAMENTO",
      "valor": "300.00",
      "quando": "2026-09-18T12:00:02Z"
    }
  ],
  "procuradas": ["cobranca", "payout", "devolucao", "devolucao_recebida", "contingencia", "devolvido_pela_parceira", "venda_cartao", "boleto", "infracao", "bloqueio"],
  "naoProcuradas": []
}

Errores #