Skip to main content
POST
/
open
/
v1
/
order
/
complete
Complete Subscription Order
curl --request POST \
  --url https://openplatform.gateapi.io/pay-subscription/open/v1/order/complete \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "operationType": "CANCEL"
}
'
{
  "code": "0",
  "message": "",
  "data": null,
  "success": true
}

​
Overview

This page documents the POST /open/v1/order/complete endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

​
Notes

Headers

​
X-GatePay-Certificate-ClientId
string
required

Merchant client ID, obtained from GatePay platform application

Example:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

​
X-GatePay-Signature
string
required

HMAC-SHA256 signature, used to verify request legitimacy

Example:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"

​
X-GatePay-Timestamp
string
required

Timestamp (milliseconds), time difference with server cannot exceed 5 minutes

Example:

"1672905655498"

​
X-GatePay-Nonce
string
required

Random number, used to prevent replay attacks

Example:

"9578"

Body

application/json

Subscription order status transition request parameters

​
operationType
enum<string>
required

Operation type: FINISH (complete) / CANCEL (cancel)

Available options:
FINISH,
CANCEL
Example:

"FINISH"

​
subscriptionOrderNo
string

Subscription order number (choose one with merchantSubscriptionOrderNo)

Example:

"SUB_20240101_001"

​
merchantSubscriptionOrderNo
string

Merchant subscription order number (choose one with subscriptionOrderNo)

Example:

"MSUB_20240101_001"

​
reason
string

Operation reason, maximum 100 characters

Maximum string length: 100
Example:

"User actively cancels subscription"

Response

200 - application/json

Subscription order status transition successful

​
code
string

Response code, 0 indicates success

Example:

"0"

​
message
string

Response description, empty when successful

Example:

""

​
success
boolean

Whether the request was successful

Example:

true

​
data
object

Response data