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

列出提现

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

GET /v2/ex/pix

权限范围:ex.pix.send.read。

GET /v2/ex/pix?limite=2
→ 200
{
  "payouts": [
    {
      "idEnvio": "SAQ01J1ZK7M9QW3ERT5TY6UI8O",
      "endToEndId": "E12345678202609181200000000000003",
      "status": "EM_PROCESSAMENTO",
      "tipo": "SAQUE",
      "valor": "300.00",
      "solicitadoEm": "2026-09-18T12:00:00Z",
      "prazoRegulatorio": "2026-09-18T14:00:00Z",
      "favorecido": { "chave": "12345678909", "cpf": "12345678909" },
      "sla": { "estouradoNaEntrada": false, "restanteSegundos": 7199 }
    }
  ],
  "cursor": { "proximo": "", "temMais": false }
}
参数 类型 必填 说明
limite 整数 否 每页条数,1 至 200。默认为 50。
cursor 字符串 否 上一页的 cursor.proximo。
inicio、fim 字符串 否 创建时间区间,即我们收到提现的时间,RFC 3339。不包含 fim。
status 字符串 否 AGUARDANDO_APROVACAO、EM_PROCESSAMENTO、REALIZADO 或 NAO_REALIZADO。
cpf、cnpj 字符串 否 只列出付给持有该证件的收款人的提现,带或不带格式符号均可。二者选一。
subconta 字符串 否 只返回该子账户的提现。
ordem 字符串 否 prazo:期限队列,按期限从短到长排列,只能与 status=EM_PROCESSAMENTO 一起使用,且只包含有期限的提现。第一页就是最紧急的提现。省略时按从新到旧排列。

每一项的结构与查询提现相同。企业收款人返回 cnpj 代替 cpf。

错误 #

状态码 title 触发条件
400 cursor_invalido 游标格式错误。
400 periodo_invalido inicio 或 fim 不符合 RFC 3339。
400 limite_invalido limite 不在 1 至 200 之间。
400 status_invalido status 不在列表中。
400 filtro_invalido ordem 不在列表中,prazo 没有搭配 status=EM_PROCESSAMENTO,或同时传了 cpf 和 cnpj。