Skip to main content

Subscribe Query

Request

API URL: /merchant/v2.1/{GUID}/subscribe/query

Note

{GUID} Obtained from the merchant backend (API Docking -> GUID)

✅ Required ⭕ Optional ❌ Not used

HeaderContentDescription
Content-Typetext/plain
X-Transaction-Signature{transaction_signature}Please refer to Transaction Signature
ParamTypeRequiredSignDescription
user_idStringMerchant identification
order_idStringSubscribe order Id of merchant system. The order id should be unique.
timestampIntergerRequest timestamp (10 digits), If the time difference is allowed to be 5 seconds, it will fail.
signStringSignature string. Please refer to Data Signature and Verification

Response

ParamTypeRequiredSignDescription
user_idStringMerchant identification
order_idStringSubscribe order Id of merchant system. The order id should be unique.
transaction_idStringPTS transaction id
channelStringPlease refer to Support Channel
submit_currencyStringSubmit currency
submit_amountFloatSubmit amount (Support up to 6 decimal places)
accept_currencyStringThe currency real paid
accept_amountFloatPaid amount of accept currency (Support up to 6 decimal places)
exchange_rateFloatExchange rate
enabledBooleanSubscription status. true = enabled, false = disabled.
subscribe_atIntegerSubscription timestamp (10 digits)
timestampIntegerTransaction last update timestamp (10 digits)
paymentsArray<Payment>Payment list.
signStringSignature string. Please refer to Data Signature and Verification

Payment Object

ParamTypeDescription
payment_idStringSubscribe Payment PTS transaction id
statusString0000 = Waiting
1000 = Processing
2000 = Success
3000 = Failed
4000 = Order error
timestampIntegerTransaction last update timestamp (10 digits)

Response Example