取消付款请求

本文档介绍了用于取消支付请求的服务器端 API。使用此接口可以终止尚未完成的交易。

端点

方法：POST

沙盒	https://sandbox.codapayments.com/airtime/api/restful/v2.0/Payment/Cancel
生产	https://airtime.codapayments.com/airtime/api/restful/v2.0/Payment/Cancel

请求正文

请求体必须以 JSON 格式发送，并包含以下参数：

cancelPaymentRequest.apiKey	string	Yes	您的 Coda API 身份验证密钥。
cancelPaymentRequest.projectId	string	Yes	项目的唯一标识符。
cancelPaymentRequest.txnId	string	Yes	需要捕获的与该笔付款相关的交易 ID。

示例请求

{
  "cancelPaymentRequest": {
    "apiKey": "your_api_key_here",
    "projectId": "your_project_id",
    "txnId": "123456789"
  }
}

回复

请求成功后，会返回确认信息，表明捕获请求已被确认。

示例回复

{
  "cancelPaymentRequest": {
    "status": "received",
    "txnId": "123456789"
  }
}