การโอนจ่าย (Pay-out · ฟิลิปปินส์)
API Pay-out ภูมิภาค ฟิลิปปินส์ (PHP). ดู Payment methods。
Request
POST/v2.0/disbursement/pay-out
Request Path:
sandbox: https://sandbox-gateway.smilepayz.com/v2.0/disbursement/pay-out
production: https://gateway.smilepayz.com/v2.0/disbursement/pay-out
| Field | Required | Type | Description |
|---|
Content-Type | M | String | application/json request body. |
X-TIMESTAMP | M | String | Format: yyyy-MM-ddTHH:mm:ss±HH:mm (e.g. PHT +08:00). |
X-SIGNATURE | M | String | Signature of JSON body (see product Signature doc). |
X-PARTNER-ID | M | String | Your merchantID (alphanumeric). |
Body Parameters
| Field | Required | Type | Description |
|---|
orderNo | M | String(32) | Merchant-unique id, 6–32 alphanumeric. |
purpose | M | String(64) | Memo to payer, 1–64 UTF-8 chars. |
merchant | M | Object | Wraps merchantId and optional sub-merchant fields. |
merchantId | M | String | Smilepayz merchantId for this call. |
merchantName | O | String | UTF-8 merchant display name. |
subMerchantId | O | String | Sub-merchant ID. |
subMerchantName | O | String | UTF-8 name for subMerchantId. |
money | M | Object | Currency plus amount for this transaction. |
currency | M | String | Fixed to PHP. |
amount | M | Number | PHP integer minor units (e.g. 10050 = PHP 100.50). |
paymentMethod | M | String | Code (see Payment methods doc). |
cashAccount | M | String(32) | Beneficiary bank account number. |
receiver | M | Object | Beneficiary object (see Receiver model). |
name | M | String | Beneficiary full name (UTF-8). |
callbackUrl | O | String(256) | HTTPS async status URL, max 256 chars. |
Example Body – Disbursement Request:
Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+08:00
X-SIGNATURE: 7MHd9v5/m9JeqmDZVwWBZUZ5J5...7120QnFEny7Qm7uQR1G0TWCh10fsU6nVxiRoeoQ==
X-PARTNER-ID: 20001
{
"orderNo": "2000102900000000000001",
"purpose": "Payroll — Cebu hub",
"merchant": {
"merchantId": "20001"
},
"money": {
"currency": "PHP",
"amount": 150000
},
"paymentMethod": "BPI",
"cashAccount": "123456789012",
"receiver": {
"name": "Maria Santos Cruz"
}
}
Responses
HTTP Request
| Field | Required | Type | Description |
|---|
Content-Type | M | String | application/json request body. |
X-TIMESTAMP | M | String | Format: yyyy-MM-ddTHH:mm:ss±HH:mm |
Body Parameters
| Field | Required | Type | Description |
|---|
code | M | String | 00 success, other values error. |
message | M | String | UTF-8 human-readable result line. |
orderNo | M | String | Merchant-unique id, 6–32 alphanumeric. |
tradeNo | O | String | Smilepayz tradeNo for this order. |
merchant | M | Object | Wraps merchantId and optional sub-merchant fields. |
merchantId | M | String | Smilepayz merchantId for this call. |
merchantName | O | String | UTF-8 merchant display name. |
subMerchantId | O | String | Sub-merchant ID. |
subMerchantName | O | String | UTF-8 name for subMerchantId. |
accountNo | O | String | Settlement accountNo if gateway returns it. |
money | M | Object | Currency plus amount for this transaction. |
currency | M | String | Fixed to PHP. |
amount | M | Number | PHP integer minor units (e.g. 10050 = PHP 100.50). |
disbursementTime | M | String | Format (yyyy-MM-ddTHH:mm:ss±HH:mm). |
channel | M | Object | Channel payload (paymentUrl, qrString, …). |
paymentMethod | M | String | Code (see Payment methods doc). |
cashAccount | M | String | Beneficiary bank account number. |
accountName | O | String | Account holder name. |
status | O | String | Order or payment status enum value. |
Example Body – Disbursement Response:
Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+08:00
{
"code": "00",
"message": "successful",
"orderNo": "2000102900000000000001",
"tradeNo": "1822000109e998347483949",
"merchant": {
"merchantId": "20001",
"merchantName": "Smilepayz Demo Store",
"accountNo": "2000124234782342"
},
"money": {
"currency": "PHP",
"amount": 150000
},
"disbursementTime": "2024-12-17T10:55:00+08:00",
"channel": {
"paymentMethod": "BPI",
"cashAccount": "123456789012",
"accountName": "Maria Santos Cruz"
},
"status": "PROCESSING"
}
Notification/Callback
HTTP Request
| Field | Required | Type | Description |
|---|
Content-Type | M | String | application/json request body. |
X-TIMESTAMP | M | String | Format: yyyy-MM-ddTHH:mm:ss±HH:mm |
X-SIGNATURE | M | String | Callback body signature (see Callback signature guide). |
Body Parameters
| Field | Required | Type | Description |
|---|
orderNo | M | String | Merchant-unique id, 6–32 alphanumeric. |
tradeNo | M | String | Smilepayz tradeNo for this order. |
merchantId | M | String | Smilepayz merchantId for this call. |
merchantName | M | String | UTF-8 merchant display name. |
subMerchantId | O | String | Sub-merchant ID. |
subMerchantName | O | String | UTF-8 name for subMerchantId. |
paymentMethod | M | String | Code (see Payment methods doc). |
transactionTime | M | String | Format: yyyy-MM-ddTHH:mm:ss |
money | M | Object | Currency plus amount for this transaction. |
currency | M | String | Fixed to PHP. |
amount | M | Number | PHP integer minor units (e.g. 10050 = PHP 100.50). |
status | M | String | Order or payment status enum value. |
Return
Important
Respond with the string SUCCESS only.
{
"orderNo": "2000102900000000000001",
"tradeNo": "1822000109e998347483949",
"merchantId": "20001",
"merchantName": "Smilepayz Demo Store",
"subMerchantId": "",
"subMerchantName": "",
"paymentMethod": "BPI",
"transactionTime": "2024-12-17T10:55:00+08:00",
"money": {
"currency": "PHP",
"amount": 150000
},
"status": "SUCCESS"
}