GAgate

Cancel OTC Recharge Order

Changed on

Cancel an OTC recharge order before payment is confirmed.

post/payment/open/otc/api/recharge/cancel

Request

  • Base URL
    https://openplatform.gateapi.io
  • URL
    https://openplatform.gateapi.io/payment/open/otc/api/recharge/cancel
  • Auth
    none declared. Required headers: X-GatePay-Certificate-ClientId, X-GatePay-Signature, X-GatePay-Timestamp, X-GatePay-Nonce

Headers

X-GatePay-Certificate-ClientIdstring required

Merchant application client ID used to identify the calling app.

X-GatePay-Signaturestring required

HMAC signature generated from the request according to GatePay signing rules.

X-GatePay-Timestampstring required

Millisecond timestamp; the difference from server time must not exceed 30 seconds.

X-GatePay-Noncestring required

Random nonce used together with the timestamp to prevent replay attacks.

X-GatePay-On-Behalf-Ofstring

Institutional sub-account UID. Only required when an institution submits a request on behalf of a sub-account; not required for direct merchant requests.

Request body

orderIdstring required

Order ID to cancel.

Example request

{
  "orderId": "71347515709194240"
}

Response

Success

codestring

Business response code.

statusstring

Top-level request status.

errorMessagestring

Error message when the request fails.

Changes