Skip to content

Create Payout Order

HTTP Request

API EndPoint

POST baseUrl + /api/payOut

Request Parameters

ParameterRequiredTypeDescriptionExample
accountNameYstring(32)Beneficiary NameBrandme
accountNoYstring(32)Beneficiary bank account64618000007
accountTypeYintBeneficiary Account Type11 pls refer toPayout Account Type
currencyYstring(32)Currency codeTHB
amountYdecimal(20,2)Amount[15.00,500000.00]
bankIdYintBank IdPayout Bank Query
mchOrderNoYstring(32)Merchant order number1386556787811426305
notifyUrlYstring(250)webhooks (callback) addresshttps://merchant.com/webhooks
nonceStrYstring(32)Random string1863484722378907648
idCardYstring(32)Beneficiary ID number1910100012345
remarkYstring(32)Order remarksremark
idTypeNstring(32)Payout Payee ID Type
phoneNstring(32)Beneficiary phonenumber0982212345
emailNstring(32)Beneficiary emailxyz@gamil.com

Request Example

bash
curl -L 'baseUrl/api/payOut' \
-H 'MerchantId: 1002001' \
-H 'Sign: A6FC73F7D22EC8B4A064C8FFCC592CBF' \
-H 'Content-Type: application/json' \
-d '{"nonceStr":"test001","accountName":"Test","accountNo":"0342912345","accountType":"3","currency":"THB","amount":1500.00,"bankId":11,"mchOrderNo":"order000000001","notifyUrl":"https://test.com/cashy/payOut/callback","idCard":"1910100012345","phone":"0982212345","remark":"PayOut"}'

Response Parameters

ParameterTypeDescription
merchantIdint商户 Id
mchOrderNostring(32)Merchant order number
orderNostring(32)Platform order number
amountdecimal(20,2)Amount
feedecimal(20,2)fee
orderStatusstringOrder Statuspls refer toPayout Order Status Enum

Response Example

json
{
  "msg": "SUCCESS",
  "code": 200,
  "data": {
    "merchantId": "1002001",
    "mchOrderNo": "order000000001",
    "orderNo": "PAYOUT8232147000000000001",
    "amount": 100,
    "fee": 0,
    "orderStatus": "PROCESSING"
  }
}
json
{
  "msg": "System_error",
  "code": 500
}

Query Payout Order

API EndPoint

POST baseUrl + /api/payOutQuery

Request Parameters

ParameterRequiredTypeExampleDescription
mchOrderNoNstring(32)1863484722378907648Merchant order number
orderNoNstring(32)PAYOUT8551739282639106048Platform order number
nonceStrYstring(32)9459931608Random string

TIP

We recommend using orderNo (platform order number) first. At least one of the platform order number and the merchant order number must be passed.

Request Example

bash
curl -L 'baseUrl/api/payOutQuery' \
-H 'MerchantId: 1002001' \
-H 'Sign: A6FC73F7D22EC8B4A064C8FFCC592CBF' \
-H 'Content-Type: application/json' \
-d '{"mchOrderNo":"1863484722378907648","nonceStr":"9459931608","orderNo":"PAYOUT8551739282639106048"}'

Response Parameters

ParameterTypeDescription
merchantIdintMerchant id
mchOrderNostring(32)Merchant order number
orderNostring(32)Platform order number
channelOrderNostring(32)Channel order number
amountdecimal(20,2)Amount
feedecimal(20,2)Fee
orderStatusstring(32)Payout Order Status Enum
resultDescstring(64)Order Status Description
completionTimeyyyy-MM-dd HH:mm:ssCompletion time

Response Example

json
{
  "msg": "SUCCESS",
  "code": 200,
  "data": {
    "merchantId": "1002001",
    "mchOrderNo": "1863484722378907648",
    "orderNo": "PAYOUT8551739282639106048",
    "amount": "60000",
    "fee": "5150",
    "orderStatus": "PAYING",
    "completionTime": null,
    "resultDesc": null
  }
}

Async Webhook Notification

The webhooks url is provided by the merchant

POST Merchant NotifyUrl

Webhook Request Parameters

ParameterTypeDescription
merchantIdintMerchant id
mchOrderNostring(32)Merchant order number
orderNostring(32)Platform order number
channelOrderNostring(32)Channel order number
amountdecimal(20,2)Amount
feedecimal(20,4)Fee
orderStatusstring(32)Payout Order Status Enum
resultDescstring(64)Order Status Description
completionTimeyyyy-MM-dd HH:mm:ssCompletion time

Webhook Request Example

bash
curl -L 'merchant.com/webhools/payout' \
-H 'MerchantId: 1002001' \
-H 'Sign: A6FC73F7D22EC8B4A064C8FFCC592CBF' \
-H 'Content-Type: application/json' \
-d '{"amount":60000.00,"completionTime":"2024-12-02 08:42:54","fee":5150.0000,"mchOrderNo":"1863484722378907648","merchantId":"3002124","nonceStr":"1733103774518","orderNo":"PAYOUT8551739282639106048","orderStatus":"SUCCESS","payType":"11"}'
json
{
  "amount": 60000.0,
  "completionTime": "2024-12-02 08:42:54",
  "fee": 5150.0,
  "mchOrderNo": "1863484722378907648",
  "merchantId": "1002001",
  "nonceStr": "1733103774518",
  "orderNo": "PAYOUT8551739282639106048",
  "orderStatus": "SUCCESS",
  "payType": "11"
}
json
{
  "amount": 60000.0,
  "completionTime": "2024-12-02 08:42:54",
  "fee": 5150.0,
  "mchOrderNo": "1863484722378907648",
  "merchantId": "1002001",
  "nonceStr": "1733103774518",
  "orderNo": "PAYOUT8551739282639106048",
  "orderStatus": "FAIL",
  "resultDesc": "ACCOUNT NOT EXITS",
  "payType": "11"
}

Order result reversal processing

Please note that in rare cases, a payment order will have a result reversal notification. Your callback processing logic should consider the processing of success->failure and failure->success status.

Webhook Response Example

json
{
  "status": "SUCCESS"
}

TIP

When the webhooks response HTTP status code is 200, 301 or 302, we believe that the merchant has successfully received and processed the callback. For other statuses, we believe that the merchant has failed to process the callback.

After the webhooks fails, it will be retried in 1, 2, 4, 8, 16, 32, 64, 128, 256, 512 minutes, and the webhooks will be retried 10 times in total

Released under the MIT License.