Request
Tips
Welcome to the smilepayz Pay API documentation page. Integrate this API to start transacting using smilepayz on your
site.
smilepayz API is a third party API that functions as a payment gateway system.
smilepayz API helps you in terms of receiving online payments from your customers.
With just one smilepayz API, you can accept payments from a variety of available payment methods.
Tips
smilepayz API is a restful Web service, which enables programmatic communication between you and smilepayz
paymentsystem. You can easily integrate to any of your internet-capable system (Web, App, PoS, IoT, etc.) and can fully
build & customize the payment UI, on your side without smilepayz hosted payment UI. smilepayz Core API is suitable for
medium size as well as large size businesses.
Tips
HTTP Request
Header Format Structure Components – inquiry status
| Service Code | 92 |
|---|---|
| Name | API Inquiry Status |
| Version | 1.0 |
| HTTP Method | POST |
| Path | .../{version}/inquiry-status |
Tips
Header Parameters
API Header Format Structure for inquiry status:
| Area | Field | Attribute | Type | Description |
|---|---|---|---|---|
| Header | 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 | Represents signature of a request.Identify Signature Type used | |
| ORIGIN | Optional | String | Origin Domain www.yourdomain.com | |
| X-PARTNER-ID | Mandatory | String | Merchant_ID. Unique ID for a partner as merchant_id | |
| X-EXTERNAL- ID | Mandatory | String | Numeric String. Reference number that should be unique in the same day | |
| CHANNEL-ID | Mandatory | String | Fixed value: 95221 |
Notes:
X-SIGNATURE
- HMAC_SHA512 (merchantSecret, stringToSign) with formula stringToSign = HTTPMethod +”:“+ EndpointUrl +":"+
AccessToken +":“+ Lowercase(HexEncode(SHA-256(minify(RequestBody))))+ ":“ + TimeStamp- Complete URL endpoint including all parameters in related URL (Relative path, example: Path in general information
of each API service)- For the minify(Request Body) parameter, in case there is no Request Body then an empty string is used.
Tips
Example Header – inquiry status Request:
POST .../v1.0/inquiry-status HTTP/1.2
Content-type: application/json
Authorization: Bearer gp9HjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a"
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
ORIGIN: www.hostname.com
X-PARTNER-ID: 10001
X-EXTERNAL-ID: 41807553358950093184162180797837
CHANNEL-ID: 95221
Body Parameters
| Area | Field | Attribute | Type | Description |
|---|---|---|---|---|
| Body | tradeType | Mandatory | number | tradeType payin/payout Refer to Data Trade Type |
| orderNo | Mandatory | String(32) | String merchant transaction Unique ID |
Tips
Example Body – inquiry status Request:
POST .../v1.0/inquiryStatus HTTP/1.2
Content-type: application/json
Authorization: Bearer gp9HjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a"
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
ORIGIN: www.hostname.com
X-PARTNER-ID: 82150823919040624621823174737537
X-EXTERNAL-ID: 41807553358950093184162180797837
CHANNEL-ID: 95221
{
"tradeType": 1,
"orderNo": "M-2373282627238237"
}