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

查询收款

按 txid 返回收款。付款情况见 status(CONCLUIDA)和 ex.situacaoFundos。

GET /v2/cob/{txid}

权限范围:cob.read。

GET /v2/cob/COB01J1ZK7M9QW3ERT5TY6UI8O
→ 200
{
  "txid": "COB01J1ZK7M9QW3ERT5TY6UI8O",
  "revisao": 0,
  "status": "ATIVA",
  "calendario": { "criacao": "2026-09-18T12:00:00.767Z", "expiracao": 900 },
  "devedor": { "cpf": "12345678909", "nome": "Fulano de Tal" },
  "valor": { "original": "150.00" },
  "chave": "01J8Z3QK5W7R2N4M6P8T0V2X4Y",
  "solicitacaoPagador": "Pedido 778812",
  "pixCopiaECola": "00020126480014br.gov.bcb.pix0126...6304C057"
}

已支付的收款返回 status: CONCLUIDA 和 ex 块:

GET /v2/cob/FIN02J1ZK7M9QW3ERT5TY6UI8O
→ 200
{
  "txid": "FIN02J1ZK7M9QW3ERT5TY6UI8O",
  "revisao": 1,
  "status": "CONCLUIDA",
  "valor": { "original": "150.00" },
  "ex": {
    "endToEndId": "E12345678202609181200000000000001",
    "situacaoFundos": "CREDITADO"
  }
}
字段 类型 说明
ex.endToEndId 字符串 该 Pix 在结算中的标识符。退款时使用的就是它。
ex.situacaoFundos 字符串 CREDITADO 表示可用余额。RETIDO 表示已冻结。EM_DEVOLUCAO 表示正在退还付款人,不会计入余额。DEVOLVIDO 表示已退还付款人。只有 CREDITADO 才是余额。
ex.subconta 字符串 收款的子账户,在创建收款时指定了子账户时返回。
ex.splitConfig 字符串 收款的分账配置,如有。

使用 ex.subconta 或 ex.splitConfig 时,ex 块在付款前就会返回,此时 situacaoFundos 和 endToEndId 为空。

收到的 Pix #

同一笔付款也可以按 endToEndId 读取。

GET /v2/pix/{e2eId}

权限范围:pix.read。

GET /v2/pix/E12345678202609181200000000000001
→ 200
{
  "endToEndId": "E12345678202609181200000000000001",
  "txid": "FIN02J1ZK7M9QW3ERT5TY6UI8O",
  "valor": "150.00",
  "horario": "2026-09-18T12:00:00Z",
  "pagador": { "cpf": "12345678909" },
  "ex": { "situacaoFundos": "CREDITADO", "ispbPagador": "00000000" }
}
字段 类型 说明
ex.titularidadeOk 布尔值 付款人是收款的持有人时为 true。只有执行了核验时才会出现。

付款人为企业时,devedor 和 pagador 返回 cnpj 代替 cpf。

GET /v2/pix?inicio=...&fim=... 按巴西中央银行的标准格式,列出某个时间区间内收到的 Pix。

错误 #

状态码 title 触发条件
404 nao_encontrado 该 txid 在此账户中不存在。