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

创建 Pix 收款

创建一笔带动态 QR 码的收款。txid 由您生成:重复使用同一个 txid 会返回已创建的收款,不做修改,状态码为 200,并带有响应头 x-replayed: true。若债务人证件号、金额、ex.subconta 或 ex.splitConfig 不同,则返回 409。要创建另一笔收款,请使用另一个 txid。

PUT /v2/cob/{txid}

权限范围:cob.write。

PUT /v2/cob/COB01J1ZK7M9QW3ERT5TY6UI8O
{
  "calendario": { "expiracao": 900 },
  "devedor": { "cpf": "12345678909", "nome": "Fulano de Tal" },
  "valor": { "original": "150.00" },
  "solicitacaoPagador": "Pedido 778812"
}
→ 201
{
  "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"
}

请求字段 #

字段 类型 必填 说明
valor.original 字符串 是 带两位小数的金额,大于零。
valor.modalidadeAlteracao 整数 否 只能是 0:付款人不能修改金额。省略时为 0。
devedor.cpf 字符串 二选一 付款人的 CPF,11 位数字。只有用该证件号支付的 Pix 才会计入余额。
devedor.cnpj 字符串 二选一 付款人的 CNPJ,在 capacidades.devedorPJ 为 true 时可代替 cpf。14 位,不含标点。
devedor.nome 字符串 视情况 付款人姓名。capacidades.cobrancaSemNome 为 false 时必填。
calendario.expiracao 整数 否 QR 码过期前的秒数。省略时为 900;若账户接受的最大值更小,则取该最大值。超过该最大值时,也取该最大值。
solicitacaoPagador 字符串 否 向付款人显示的文字。
ex.subconta 字符串 否 收款的子账户 id。省略时由主账户收款。
ex.splitConfig 字符串 否 分账配置的 id。请参阅内部参考文档。

有些账户接受的最大过期时间小于 900 秒。不带 calendario.expiracao 或其值超过该最大值时,收款以账户的最大值创建,响应中会返回实际记录的数值。请求低于账户的最小值时,返回 422 expiracao_nao_suportada_no_custodiante,限制值在 violacoes 中,收款不会创建。

在有些账户中,二维码的有效期由机构决定,而不是由请求的过期时间决定。在这些账户中,收款与二维码同时过期,响应中的 calendario.expiracao 返回该有效期,可能长于或短于请求的值。在有效期内支付的 Pix 会入账。请始终以响应中的过期时间为准。

有些账户在没有付款人姓名时不签发收款。可读取 GET /v2/ex/config 中的 capacidades.cobrancaSemNome 确认:为 false 时请发送 devedor.nome,否则收款返回 422 nome_do_pagador_obrigatorio,且不会创建。

有些账户只在一定金额范围内签发收款。超出该范围时,收款返回 422 valor_abaixo_do_minimo 或 422 valor_acima_do_maximo,限制值在 detail 中,收款不会创建。当您的收款有多个账户可用时,收款会在接受该金额的另一个账户中创建,只有在所有账户都不接受时才会被拒绝。

使用 ex.subconta 时,上述两条规则以子账户为准:请读取 GET /v2/ex/config?subconta={id}。

ex 中的未知字段返回 400 campo_desconhecido。chave 由我们填写,不应发送。

向企业收款时,请发送 devedor.cnpj 代替 cpf。这在 GET /v2/ex/config 中 capacidades.devedorPJ 为 true 时可用;为 false 时,cnpj 会被拒绝。两者只发送其一,切勿同时发送。

在 capacidades.cobrancaSemDevedor 为 true 的账户,收款可以既不带 devedor.cpf 也不带 devedor.cnpj,此时任何人都可以支付。在这些账户中,无效的 devedor.cpf 或 devedor.cnpj 会连同 devedor 一起被丢弃,收款在没有付款人的情况下创建;带标点但去掉标点后有效的证件号照常使用,去掉标点。

只有付款人的证件号与 devedor 相同时,Pix 才会计入余额。如果其他个人或企业支付了该 QR 码,款项不会计入余额,仍归付款人:您会收到 motivo 为 TITULARIDADE 的 cob.pagamento_rejeitado;如果款项已经到账,还会收到原因相同的 devolucao.criada。请在 devedor 中填写实际付款人的证件号。

有些账户中,机构只提供付款人被遮蔽的 CPF,例如 ***456789**。在机构确认这是付款人 CPF 的账户中,Pix 按六位可见数字以及 devedor.nome 的名和姓进行核对,您收到的付款人 CPF 也是遮蔽的。在这些账户中 capacidades.cobrancaSemNome 为 false:带 devedor.cpf 的收款必须在 devedor.nome 中填写付款人的名和姓,否则返回 422 nome_do_pagador_obrigatorio,且不会创建。在其他 CPF 被遮蔽的账户中,带 devedor 的收款返回 422 titularidade_sem_confirmacao,且不会创建;在按六位数字核对的账户中,带 devedor.cnpj 的收款也是如此。

响应字段 #

字段 类型 说明
status 字符串 ATIVA、CONCLUIDA、REMOVIDA_PELO_USUARIO_RECEBEDOR 或 REMOVIDA_PELO_PSP。
pixCopiaECola 字符串 BR Code。以 QR 码或可复制文本的形式展示。
revisao 整数 收款每次修改时递增。
calendario.criacao 字符串 创建时间。

款项计入余额时,您会收到 webhook pix.creditado。被拒绝的 Pix 不会产生 pix.creditado:它以 situacaoFundos 为 EM_DEVOLUCAO 的 pix.recebido 到达,随后是 devolucao.criada。可在查询收款中查询收款。

另有 POST /v2/cob,正文相同,txid 由我们生成。建议使用 PUT。

错误 #

状态码 title 触发条件
400 txid_invalido txid 不是 26 至 35 位字母数字字符。
400 valor_invalido 金额不符合 "0.00" 格式,或不是正数。
400 cpf_invalido devedor.cpf 格式错误。在 capacidades.cobrancaSemDevedor 为 true 的账户不会出现此错误:收款在没有付款人的情况下继续。
400 cnpj_invalido devedor.cnpj 格式错误或校验位错误。在 capacidades.cobrancaSemDevedor 为 true 的账户不会出现此错误:收款在没有付款人的情况下继续。
400 documento_invalido 同时发送了 devedor.cpf 和 devedor.cnpj。
400 devedor_obrigatorio 在 capacidades.cobrancaSemDevedor 为 false 的账户,既没有 devedor.cpf 也没有 devedor.cnpj。原因在 detail 中。
400 devedor_pj_nao_permitido 在 capacidades.devedorPJ 为 false 时发送了 devedor.cnpj。
400 campo_desconhecido ex 中有不存在的字段。
403 subconta_indisponivel ex.subconta 存在,但状态不是 ATIVA。
409 txid_duplicado 同一个 txid 已存在,但债务人证件号、金额、ex.subconta 或 ex.splitConfig 不同。
422 nome_do_pagador_obrigatorio 账户要求 devedor.nome,但请求中没有,或者在用姓名核对 Pix 的账户中缺少名和姓。收款未创建。
422 titularidade_sem_confirmacao 该账户不报告付款人,带付款人证件的收款会被退回。收款未创建;请联系支持。
422 cobranca_recusada_no_custodiante 账户所在机构拒绝签发 QR 码。原因在 detail 中。收款未创建;不要用相同的正文重试。
422 expiracao_nao_suportada_no_custodiante calendario.expiracao 低于账户接受的最小值。限制值在 violacoes 中。
422 valor_abaixo_do_minimo valor.original 低于该账户的最低收款金额。最低金额在 detail 中返回,收款不会创建。
422 valor_acima_do_maximo valor.original 高于该账户的最高收款金额。最高金额在 detail 中返回,收款不会创建。
422 subconta_nao_encontrada ex.subconta 不存在。
422 split_config_nao_encontrada ex.splitConfig 不存在。
502 custodiante_indisponivel 在机构签发 QR 码失败。收款未创建;请使用同一个 txid 重试。如果再次返回 502 且没有 Retry-After 头,请用新的 txid 创建。带有 Retry-After 时,请在指示的秒数后使用同一个 txid 重试:当机构响应慢而签发仍在继续时(之后到达的 QR 码会被保存,重试会收到该收款)、当同一笔收款正在另一个请求中签发时、或当机构等待中的收款过多或您的收款已占用其一半名额时,为 1;当机构停止为您的收款签发 QR 码、签发处于暂停状态时,为暂停剩余的时间;当机构限制了请求时,为机构要求的时间。