跳到正文
A AmunPay API Pix版本 3.38 · 更新于 页面

列出收款

按从新到旧的顺序列出账户的收款,使用游标分页。

GET /v2/ex/cobrancas

权限范围:cob.read。

GET /v2/ex/cobrancas?limite=2
→ 200
{
  "cobrancas": [
    {
      "txid": "COB02J1ZK7M9QW3ERT5TY6UI8O",
      "status": "ATIVA",
      "valor": "80.00",
      "devedor": { "cpf": "12345678909", "nome": "" },
      "criacao": "2026-09-18T12:00:01.768267Z",
      "expiracao": 900,
      "revisao": 0
    },
    {
      "txid": "COB01J1ZK7M9QW3ERT5TY6UI8O",
      "status": "ATIVA",
      "valor": "150.00",
      "devedor": { "cpf": "12345678909", "nome": "Fulano de Tal" },
      "criacao": "2026-09-18T12:00:00.767154Z",
      "expiracao": 900,
      "revisao": 0
    }
  ],
  "cursor": { "proximo": "MTc4OTcyMzIyMzc2NzE1NH5DT0Iw...", "temMais": true }
}
参数 类型 必填 说明
limite 整数 否 每页条数,1 至 200。默认为 50。
cursor 字符串 否 上一页的 cursor.proximo。
inicio、fim 字符串 否 创建时间区间,RFC 3339:包含 inicio,不包含 fim。要查询一整天,请将 fim 设为次日零点。
status 字符串 否 按状态过滤:ATIVA、CONCLUIDA、REMOVIDA_PELO_USUARIO_RECEBEDOR、REMOVIDA_PELO_PSP。
cpf 字符串 否 只返回 devedor.cpf 为该值的收款。
cnpj 字符串 否 只返回 devedor.cnpj 为该值的收款。cpf 和 cnpj 只用其一,切勿同时使用。
subconta 字符串 否 只返回该子账户的收款。
situacaoFundos 字符串 否 资金状态:RECEBIDO、CREDITADO、RETIDO、EM_DEVOLUCAO 或 DEVOLVIDO。可以传多个,用逗号分隔。status=CONCLUIDA&situacaoFundos=RECEBIDO,EM_DEVOLUCAO 表示已经付款但尚未计入余额的收款。

列表不包含 pixCopiaECola。要重新发送 QR 码,请使用查询收款。

GET /v2/cob?inicio=...&fim=... 是巴西中央银行标准格式的列表,按创建时间区间查询。

错误 #

状态码 title 触发条件
400 cursor_invalido 游标格式错误。
400 filtro_invalido 同时使用了 cpf 和 cnpj。
400 limite_invalido limite 不在 1 至 200 之间。
400 periodo_invalido inicio 或 fim 不符合 RFC 3339。
400 status_invalido status 或 situacaoFundos 不在列表中。
403 subconta_de_outro 凭证属于某个子账户,却请求了另一个子账户。