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_idString✅✅Merchant identification
order_idString✅✅Payment order Id of merchant system. The order id should be unique.
timestampInteger✅✅Request timestamp (10 digits), If the time difference is allowed to be 5 seconds, it will fail.
signString✅❌Signature string. Please refer to Data Signature and Verification

Response​

ParamTypeRequiredSignDescription
user_idString✅✅Merchant identification
order_idString✅✅Payment order Id of merchant system. The order id should be unique.
transaction_idString✅✅FTIPH transaction id
channelString✅✅Please refer to Support Channel
submit_currencyString✅✅Submit currency
submit_amountFloat✅✅Submit amount (Support up to 6 decimal places)
accept_currencyString✅✅The currency real paid
accept_amountFloat✅✅Paid amount of accept currency (Support up to 6 decimal places)
exchange_rateFloat✅✅Exchange rate
enabledBoolean✅✅Subscription status. true = enabled, false = disabled.
period_countInteger✅✅Payment cycle (count). Only 1-12 can be filled in.
period_unitInteger✅✅Payment cycle (unit).
1 = Week.
2 = Month.
3 = Year.
subscribe_atInteger✅✅Subscription timestamp (10 digits)
last_payment_atInteger✅✅Last payment timestamp (10 digits)
next_payment_atInteger✅✅Next payment timestamp (10 digits)
timestampInteger✅✅Transaction last update timestamp (10 digits)
paymentsArray<Payment>⭕❌Payment list.
signString✅❌Signature string. Please refer to Data Signature and Verification

Payment Object​

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

Response Example​

{
"code": "1000",
"message": "Order Success",
"data": {
"user_id": "1",
"order_id": "TP20250110091712",
"transaction_id": "1062299063447326720",
"channel": "MAYA",
"submit_currency": "PHP",
"submit_amount": 125,
"accept_currency": "PHP",
"accept_amount": 125,
"exchange_rate": 1,
"enabled": true,
"subscribe_at": 1736500633,
"timestamp": 1736500634,
"payments": [
{
"payment_id": "1062299068027506688",
"status": "1000",
"timestamp": 1736500634
}
],
"sign": "eDjle27XFldeLCn........"
}
}