Inquiry Status API
About 1 min
Tips
The request frequency must be less than 10 times per minute, otherwise access will be prohibited.
Introduce
Service Code | 92 |
---|---|
Name | API Inquiry Status |
Version | 1.0 |
HTTP Method | POST |
Path | .../{version}/inquiry-status |
Request Header
Field | Attribute | Type | Description |
---|---|---|---|
Content-Type | Mandatory | String | String represents indicate the media type of the resource (e.g. application/json, application/pdf) |
Authorization | Mandatory | String | String starts with keyword “Bearer ” followed by access_token (e.g. Bearer eyJraWQiOi...Jzc29zIiiY) |
X-TIMESTAMP | Mandatory | String | Merchant's current local time in yyyy-MM-ddTHH:mm:ssTZD format |
X-SIGNATURE | Mandatory | String | Created using Symmetric signature HMAC_SHA512 algorithm. Refer to:Authentication Specification |
ORIGIN | Optional | String | Origin Domain www.yourdomain.com |
X-PARTNER-ID | Mandatory | String | MerchantID. Unique ID for a partner as MerchantID |
X-EXTERNAL- ID | Mandatory | String | Numeric String. Reference number that should be unique in the same day |
CHANNEL-ID | Mandatory | String | PJP’s channel id Device identification on which the API services is currently being accessed by the end user (customer) |
Request Parameter
Field | Attribute | Type | Description |
---|---|---|---|
tradeType | Mandatory | number | tradeType PayIn/PayOut. 1: PayIn Order, 2: PayOut Order |
orderNo | Mandatory | String(32) | orderNo is generated by the merchant and the merchant transaction is Unique ID |
tradeNo | Mandatory | String(32) | tradeNo is generated by the Smilepay platform and the merchant transaction is the unique ID |
Response Parameter
Field | Attribute | Type | Description |
---|---|---|---|
responseCode | Mandatory | String(32) | String Response code. success=2009200 |
responseMessage | Mandatory | String(64) | String Response description |
tradeNo | Optional | String | String identifier on service consumer system |
status | Optional | String | String status: SUCCESS, FAILED... Refer to Data TransactionStatus |
paymentMethod | Mandatory | String(6) | String Payment option which shows the provider of this payment. PayIn PaymentMethod. Refer to: PayIn PaymentMethod PayOut PaymentMethod Refer to: PayOut PaymentMethod |
money | Mandatory | Money | Json String Net amount of the transaction. Refer to: Money |
remark | Optional | String | String remark |
Sample Parameter
Sample Request
curl -X POST 'https://sandbox-gateway.smilepay.id/v1.0/inquiry-status' \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYmYiOjE3NDA0NzA0NzIsImV4cCI6MTc0MDQ3MTM3MiwiaWF0IjoxNzQwNDcwNDcyLCJNRVJDSEFOVF9JRCI6InNhbmRib3gtMTAwMDEifQ.eMcSoq4bSnJJOPhplQwW7wSz8f6rdh6U7Tv0L4lZxog' \
-H 'X-TIMESTAMP: 2025-02-25T16:14:05+07:00' \
-H 'X-SIGNATURE: ArcCzWoA78ZCImILC7eQ1rHAh6XVRApExC4GUzVGwFirIcS6Kx4eGei3zAaWVJcWFpChUcs6ATsikalptvGuBg==' \
-H 'ORIGIN:www.yourdomain.com' \
-H 'X-PARTNER-ID: sandbox-10001' \
-H 'X-EXTERNAL-ID: T_1737537970911' \
-H 'CHANNEL-ID: 95221' \
-H 'Content-Type: application/json' \
-d '{
"tradeType": 2,
"orderNo": "D_1740470950370"
}'
Sample Response
{
"tradeType": 2,
"orderNo": "D_1740470950370",
"tradeNo": null,
"status": "PROCESSING",
"paymentMethod": "BCA",
"money": {
"currency": "IDR",
"amount": 10000
},
"remark": null,
"responseCode": "2009200",
"responseMessage": "Successful"
}