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
| Header | Content | Description |
|---|---|---|
| Content-Type | text/plain | |
| X-Transaction-Signature | {transaction_signature} | Please refer to Transaction Signature |
| Param | Type | Required | Sign | Description |
|---|---|---|---|---|
| user_id | String | ✅ | ✅ | Merchant identification |
| order_id | String | ✅ | ✅ | Payment order Id of merchant system. The order id should be unique. |
| timestamp | Integer | ✅ | ✅ | Request timestamp (10 digits), If the time difference is allowed to be 5 seconds, it will fail. |
| sign | String | ✅ | ❌ | Signature string. Please refer to Data Signature and Verification |
Response
| Param | Type | Required | Sign | Description |
|---|---|---|---|---|
| user_id | String | ✅ | ✅ | Merchant identification |
| order_id | String | ✅ | ✅ | Payment order Id of merchant system. The order id should be unique. |
| transaction_id | String | ✅ | ✅ | FTIPH transaction id |
| channel | String | ✅ | ✅ | Please refer to Support Channel |
| submit_currency | String | ✅ | ✅ | Submit currency |
| submit_amount | Float | ✅ | ✅ | Submit amount (Support up to 6 decimal places) |
| accept_currency | String | ✅ | ✅ | The currency real paid |
| accept_amount | Float | ✅ | ✅ | Paid amount of accept currency (Support up to 6 decimal places) |
| exchange_rate | Float | ✅ | ✅ | Exchange rate |
| enabled | Boolean | ✅ | ✅ | Subscription status. true = enabled, false = disabled. |
| period_count | Integer | ✅ | ✅ | Payment cycle (count). Only 1-12 can be filled in. |
| period_unit | Integer | ✅ | ✅ | Payment cycle (unit). 1 = Week. 2 = Month. 3 = Year. |
| subscribe_at | Integer | ✅ | ✅ | Subscription timestamp (10 digits) |
| last_payment_at | Integer | ✅ | ✅ | Last payment timestamp (10 digits) |
| next_payment_at | Integer | ✅ | ✅ | Next payment timestamp (10 digits) |
| timestamp | Integer | ✅ | ✅ | Transaction last update timestamp (10 digits) |
| payments | Array<Payment> | ⭕ | ❌ | Payment list. |
| sign | String | ✅ | ❌ | Signature string. Please refer to Data Signature and Verification |
Payment Object
| Param | Type | Description |
|---|---|---|
| payment_id | String | Subscribe Payment FTIPH transaction id |
| status | String | 0000 = Waiting 1000 = Processing 2000 = Success 3000 = Failed 4000 = Order error |
| timestamp | Integer | Transaction 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........"
}
}