对账单
三种查看资金变动的方式:已结束日期的对账单、当前的交易和某个期间的汇总。都使用权限范围 ex.extrato.read。
当日对账单 #
GET /v2/ex/extrato/{data}
仅适用于已结束的日期。data 是 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 }
}
| 字段 | 类型 | 说明 |
|---|---|---|
totais.creditos、totais.debitos |
字符串 | 当天已生效各行的合计,按整天计算,而不是按页。每一行归属于它产生的那一天,已付出的提现和退款除外,它们归属于资金付出的那一天:某天请求、次日结算的提现,在付出之前以未结状态留在第一天,付出后移到第二天。若某行在同一天之后才生效,那一天的合计会随之变化。存款计入其入账当天,即使之后退回付款人或被冻结也是如此:退款和冻结各自成行,计入它们发生的日期。某一天的贷方减借方,就是您的 disponivel 在当天的变动,分账划走的部分除外。 |
totais.emAberto |
对象 | 仍未完成的部分:未结算的提现、尚未成为余额就退回付款人的存款。 |
conciliado |
布尔值 | 当天已由我们完成日终结账和核对时为 true。false 并不代表这些行无效。 |
geradoEm |
字符串 | 读取对账单的时间。同一天的两次读取,未完成的行可能不同。 |
transacoes[].tipo |
字符串 | DEPOSITO、CREDITO_DE_DEPOSITO(原本在退款中、后来入账的存款的入账,记在变为余额的当天)、SAQUE、PREMIO、COMISSAO(分账合作方的提现)、DEVOLUCAO、DEVOLUCAO_DE_SAQUE(收款人的银行从已完成的提现中退回的款项)、BLOQUEIO(因争议、法院命令或风险审查而冻结的余额)、DESBLOQUEIO(解冻回到余额的金额)、TARIFA、PENALIDADE(合同规定的罚金,由机构记账)或 CREDITO_AVULSO(由机构记账的入账,例如奖励)。遇到不认识的类型,请按 sentido 处理。 |
transacoes[].sentido |
字符串 | CREDITO 或 DEBITO。 |
transacoes[].efetivado |
布尔值 | 该行是已实际转手的资金时为 true。 |
transacoes[].referencia |
字符串 | 存款为 txid,存款的入账为 credito:<txid>,提现为 idEnvio,退款为 endToEndId:id,提现退回为 idEnvio:rtrId,手续费为 tarifa:<meio>:<referência>,冻结与解冻为 bloqueio:<tipo>:<id> 或 desbloqueio:<tipo>:<id>,其中注明冻结类型(MED、JUDICIAL 或 CAUTELAR),机构记账的罚金和入账为 lancamento:<id>。完整的冻结记录见 GET /v2/ex/bloqueios。 |
transacoes[].idEnvio |
字符串 | 仅出现在机构拆分为多笔 Pix 的提现所对应的行(每笔 Pix 的提现、其费用及其退回):即您所请求提现的 idEnvio。这些行的参考号为 idEnvio 加连字符和序号,例如 SAQ01J1ZK7M9QW3ERT5TY6UI8O-002。 |
transacoes[].parte |
整数 | 仅出现在这些行:该笔 Pix 在提现中的位置,与 查询提现 中的 pix[].parte 相同。 |
当日对账单的分页方式与列表相同:只要 cursor.temMais 为 true,就把 cursor.proximo 传入 ?cursor=。
GET /v2/ex/extrato/{data}/arquivo 以 CSV 返回同一天的数据,内容的 SHA-256 放在 trailer x-conteudo-sha256 中。带 ?formato=zip 时,返回一个 zip,里面是同一个 CSV,体积约为五分之一,trailer 仍然是该 CSV 的 SHA-256。formato 为其他值时返回 400 formato_invalido。
当前交易 #
GET /v2/ex/transacoes
时间窗口使用 RFC 3339 时间点:包含 de,不包含 ate。缺少其中一个时,该侧不设边界。存款在入账时出现;提现和退款在请求时出现,并带有当时的 status,付出后移到资金付出的时间点:请检查 efetivado。
如果只想列出某一类型或某一状态,请传入 tipo 和 situacao:每个参数都可以传多个值,用逗号分隔。不存在的值返回 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 }
}
要把同样的筛选结果导出为文件,请使用 GET /v2/ex/transacoes/arquivo,并传入 de 和 ate(必填,最多 31 天)、tipo 和 situacao。返回供电子表格使用的 CSV,以分号分隔,行和顺序与列表相同;传入 ?formato=zip 时,返回装有同一 CSV 的 zip。trailer x-linhas 给出返回的交易数。该文件不带 SHA-256:对账请使用已结束当日的文件。
期间汇总 #
GET /v2/ex/resumo
汇总 de 与 ate 之间已结束的日期,两者都是 AAAA-MM-DD,最长 366 天。如果 ate 包含当天,atePedido 表示请求的日期,ate 表示实际汇总到的日期。
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 }
]
}
没有资金变动的日期不会出现在 porDia 中。ticketMedio 等于 creditos 除以 operacoesCredito。
带 incluirHoje=true 时,汇总包含当天,截至查询时刻。响应带有 parcialAte,即当天已汇总到的时刻,ate 则为最后一个已汇总的日期。该数字在当天结束前会变化。
用任意 id 查找交易 #
GET /v2/ex/transacoes/mapear
在 ref 中传入 txid、idEnvio、endToEndId、rtrId、您的外部参考号或某项冻结的 id(与 GET /v2/ex/bloqueios 列出的相同),接口会返回在哪里找到了它。响应中的 procuradas 列表是服务器查找过的范围,其中包括内部领域。
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": []
}
错误 #
| 状态码 | title |
触发条件 |
|---|---|---|
| 400 | data_invalida |
data 不符合 AAAA-MM-DD。 |
| 400 | periodo_obrigatorio |
汇总缺少 de 或 ate。 |
| 400 | periodo_invalido |
de 或 ate 格式错误,或 de 晚于 ate。 |
| 400 | ref_obrigatoria |
mapear 缺少 ref。 |
| 400 | ref_invalida |
ref 超过 140 个字符。 |
| 422 | dia_nao_encerrado |
请求了当天或将来日期的对账单。请使用当前交易。 |
| 422 | periodo_nao_encerrado |
该期间还没有任何一天结束。 |
| 422 | periodo_longo_demais |
汇总超过 366 天。 |