跳转到主要内容
Localpayment 允许您通过 API 集成取消待处理的 APM 付款。本指南涵盖了使用直接取消方法取消 APM 交易的完整工作流程,该方法仅需要交易的 externalId。

开始之前

请确保您已备好:

API凭证

用于身份验证的有效 API 凭据和访问令牌。

账户设置

为您的目标国家/地区正确设置账户并进行业务验证。

IP白名单

将服务器 IP 地址加入 API 访问白名单。

Webhook endpoint

设置 webhook URL 以接收付款通知。

其他取消要求:

  • 具有取消权限的用户角色(请参阅用户角色文档)。
  • 原始交易必须处于可取消状态。
  • 您要取消的 APM 付款交易的 externalId。
  • 提供完整的受益人信息,以便进行数据必要的退款。

APM 付款的直接取消

APM 付款的取消按直接取消处理,这意味着您只需提供原始交易的 externalId,并将 status 参数设置为 CANCELLED。系统会立即停止对该付款的任何后续处理。
重要的APM 付款只能在待处理或进行中状态下取消。一旦 APM 付款完成或结算,您必须办理退款,而不能取消。

步骤 1:通过 API 取消 APM 付款

要取消 APM 付款,请向取消endpoint 发送 PATCH 请求。

关键请求参数

该请求需要几个关键参数:

示例请求

以下是使用 curl 的示例:
curl
查看请求中所有可用的参数。

步骤 2:处理响应

成功响应

成功取消的 APM 付款将返回确认详情:

关键响应字段

错误响应

取消请求失败时,您将收到错误信息:

常见错误场景


步骤 3:跟踪取消状态

发起取消后,可通过以下方式监控其进度:

Webhooks(推荐)

交易状态变更时接收实时通知。最适用于生产环境。

状态 API endpoint

以编程方式查询事务状态。可用于轮询或恢复丢失的 webhook 通知。

Business Portal 视图

用于监控交易的可视化界面。非常适合人工监督和详细的交易分析。

常见取消状态码

完整参考请查看我们的交易状态文档,了解所有状态代码。

测试您的集成

测试场景

请确认您的集成方案能够处理以下场景:
  1. 取消成功:使用有效的 externalId 取消待处理的 APM 付款。
  2. 无效交易:尝试取消不存在的 externalId。
  3. 已完成:尝试取消已完成的交易。
  4. 权限验证:使用具有不同权限级别的用户进行测试。
  5. 缺少状态参数:尝试在没有必填的 status 字段的情况下取消。

后续步骤

查看交易状态

使用交易状态 API 查看交易和取消的当前状态。

处理退款

了解如何为无法取消的已完成 APM 付款处理退款。
最后修改于 2026年11月10日