退款
将收到的 Pix 全部或部分退还给付款人。id 由您生成。允许部分退款,直到累计金额达到原始金额,期限为结算后 90 天内。
PUT /v2/pix/{e2eId}/devolucao/{id}
权限范围:pix.write。
PUT /v2/pix/E12345678202609181200000000000001/devolucao/DEV01J1ZK7M9QW3ERT5TY6UI8O
{
"valor": "50.00",
"descricao": "Pedido 4471 cancelado"
}
→ 201
{
"id": "DEV01J1ZK7M9QW3ERT5TY6UI8O",
"endToEndId": "E12345678202609181200000000000001",
"rtrId": "D12345678202609181200000000000001",
"valor": "50.00",
"natureza": "ORIGINAL",
"status": "EM_PROCESSAMENTO",
"descricao": "Pedido 4471 cancelado",
"horario": { "solicitacao": "2026-09-18T12:00:00Z" }
}
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
valor |
字符串 | 是 | 退款金额,两位小数。 |
natureza |
字符串 | 否 | ORIGINAL。默认值。 |
descricao |
字符串 | 否 | 随退款发送的文字,最多 140 个字符,不能包含换行、制表符或其他控制字符。并非所有账户都会把该文字转给付款人。 |
| 响应字段 | 类型 | 说明 |
|---|---|---|
status |
字符串 | EM_PROCESSAMENTO,之后变为 DEVOLVIDO 或 NAO_REALIZADO。 |
rtrId |
字符串 | 退款在本 API 中的标识符。视账户而定,付款人的回单上可能是另一个标识符;GET /v2/ex/transacoes/mapear 用这两个标识符都能找到该退款。 |
结果通过 webhook devolucao.concluida 或 devolucao.nao_realizada 送达。退款免费。
能否退款取决于收到该 Pix 的账户:GET /v2/ex/config 返回 capacidades.devolucao(子账户的 Pix 请带 ?subconta=)。为 false 时,该路由返回 503 capacidade_indisponivel,detail 会说明是哪个账户以及原因。
在某些账户中,只能退还 Pix 的全额。在这些账户中,valor 小于收到的金额时返回 422 devolucao_so_integral,且不会预留任何金额。
如果 Pix 到账后您的账户更换了机构,退款会从该 Pix 到账的账户发出。调用方式不变。如果账户余额已从一家机构转移到另一家机构,转移前到账的 Pix 的退款会返回 422 devolucao_de_outra_conta,退款由我们处理。
查询 #
GET /v2/pix/{e2eId}/devolucao/{id}
权限范围:pix.read。
GET /v2/pix/E12345678202609181200000000000001/devolucao/DEV01J1ZK7M9QW3ERT5TY6UI8O
→ 200
{
"id": "DEV01J1ZK7M9QW3ERT5TY6UI8O",
"endToEndId": "E12345678202609181200000000000001",
"rtrId": "D12345678202609181200000000000001",
"valor": "50.00",
"natureza": "ORIGINAL",
"status": "EM_PROCESSAMENTO",
"horario": { "solicitacao": "2026-09-18T12:00:00Z" }
}
GET /v2/ex/devolucoes 使用游标列出您发起的退款。我们发起的退款不在其中:它们只通过 webhook devolucao.criada(带 motivo)送达,并以 devolucao.concluida 结束。我们发起的退款也可能以 devolucao.nao_realizada 结束:这笔 Pix 没有退回付款人,已入账给您。它的 motivo 与 devolucao.criada 中的相同:是这笔 Pix 被拒绝的原因。同一笔 Pix 的 pix.creditado 会单独送达,可能在它之前或之后:两者之间的顺序不作保证。
错误 #
| 状态码 | title |
触发条件 |
|---|---|---|
| 400 | id_invalido |
id 格式错误。 |
| 400 | valor_invalido |
金额不符合 "0.00" 格式,或不是正数。 |
| 400 | natureza_invalida |
natureza 不在列表中。 |
| 400 | descricao_invalida |
descricao 超过 140 个字符,或包含控制字符(换行、制表符)。 |
| 409 | id_duplicado |
同一个 id 已存在,但正文不同。 |
| 422 | pix_nao_creditado |
该 endToEndId 不是此账户中已入账的 Pix,或该 Pix 已被冻结(ex.situacaoFundos 为 RETIDO)。 |
| 422 | devolucao_unica |
此账户中每笔 Pix 只接受一次退款,而这笔已经有一次了。 |
| 422 | devolucao_so_integral |
此账户中只能退还 Pix 的全额,而请求的 valor 更小。 |
| 422 | devolucao_de_outra_conta |
该 Pix 在您的账户余额转移机构之前到账。其退款由我们处理:请联系技术支持。 |
| 422 | devolucao_excede_recebido |
退款累计金额将超过收到的金额。 |
| 422 | devolucao_prazo_excedido |
已超过结算后 90 天。 |
| 422 | saldo_insuficiente |
可用余额不足以支付该金额。 |
| 503 | capacidade_indisponivel |
该账户没有 capacidades.devolucao。 |