跳转到主要内容
POST
申请交易退款

授权

Authorization
string
header
必填

通过 POST /auth(client_id + client_secret)获取的访问令牌。有效期 300 秒。

请求头

X-Sub-Account
string

执行操作的子账户的 reference。省略时,操作在主账户上执行;保留值 principal 同样解析为主账户,等同于省略该请求头。除 POST /auth 和 /sub-accounts 自身的端点(始终在主账户上操作)外,所有端点均接受该请求头。

可能的错误:404 SUB_ACCOUNT_NOT_FOUND、403 SUB_ACCOUNT_FORBIDDEN、403 SUB_ACCOUNT_SUSPENDED。

要求凭证已启用子账户访问(设置 → 集成 → API 凭证)。该项默认关闭,任何权限都无法替代,FULL_ACCESS 也不例外:未启用时响应为 403 SUB_ACCOUNT_FORBIDDEN。

Pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
示例:

"loja-centro"

路径参数

id
string<uuid>
必填

待退款的支付交易 ID

请求体

application/json
reason
string

退款原因(可选,最多 255 个字符)

Maximum string length: 255
示例:

"Cliente solicitou cancelamento"

响应

退款申请成功。在通过 webhook 确认之前,状态为 PENDING。

originalTransactionId
string<uuid>
必填

被退款的原始交易 ID

pspProvider
string
必填

处理退款的 PSP

pspRefundTransactionId
string
必填

PSP 侧的退款交易 ID

status
enum<string>
必填

PSP 返回的状态。PENDING 表示退款已受理但尚未确认——确认将通过 webhook refund_completed 送达。

可用选项:
PENDING,
CONFIRMED,
ERROR
示例:

"PENDING"