HOME Reference Thailand API Introduction Transaction Api Payout Api Payout Request Payout API integration paves the way for streamlined, secure, efficient money transfers to various stakeholders, including employees, customers, vendors, and partners.
Request Path: {Base URL}/v2.0/disbursement/pay-out
Field Attribute Type Description Content-Type
M String application/json
X-TIMESTAMP
M String yyyy-MM-ddTHH:mm:ss[zoneOffset]
eg: 2020-12-17T10:55:00+07:00
X-SIGNATURE
M String signature, How to signature X-PARTNER-ID
M String merchant ID
Body Parameters Field Attribute Type Description orderNo M String(32) unique no. Focus OrderNumber Rule purpose M String(64) purpose productDetail O String(128) production description money M Object Object Model Money merchant M Object Object Model Merchant paymentMethod M String(6) Model Object PaymentMethod cashAccount M String(32) Bank Account number area M Number Fixed value : 11 callbackUrl O String(256) notify address
Example Body – Disbursement Request: Header Min Body
POST {Base URL}/v2.0/disbursement/pay-out HTTP/1.2
Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
X-SIGNATURE: 7MHd9v5/m9JeqmDZVwWBZUZ5J5...7120QnFEny7Qm7uQR1G0TWCh10fsU6nVxiRoeoQ==
X-PARTNER-ID: 20001
{
"orderNo" : "2000102900000000000001" ,
"paymentMethod" : "KBANK" ,
"purpose" : "Purpose For Disbursement from Java SDK" ,
"additionalParam" : { } ,
"area" : 11 ,
"cashAccount" : "17385238451" ,
"merchant" : {
"merchantId" : "20001"
} ,
"money" : {
"amount" : 200 ,
"currency" : "THB"
}
}
Response HTTP Request Field Attribute Type Description Content-Type M String application/json
X-TIMESTAMP M String yyyy-MM-ddTHH:mm:ss[zoneOffset]
eg: 2020-12-17T10:55:00+07:00
Body Parameters Field Attribute Type Description code M String success = "00" message M String Response message orderNo M String transaction unique no merchant M Merchant Object Model Merchant disbursementTime M String yyyy-MM-ddTHH:mm:ss+07:00
eg: 2020-12-17T10:55:00+07:00
money M Money Object Model Money channel M Payer channel tradeNo O String smilepayz order no status O String Object Model Status
Example Body – Transaction Request: Header Response Body
Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
{
"code" : "00" ,
"message" : "successful" ,
"orderNo" : "2000102900000000000001" ,
"tradeNo" : "20001032432400001" ,
"status" : "PROCESSING" ,
"disbursementTime" : "2020-12-17T10:55:00+07:00" ,
"merchant" : {
"merchantId" : "10002" ,
"merchantName" : "Betty" ,
"accountNo" : "2000124234782342"
} ,
"money" : {
"currency" : "THB" ,
"amount" : 10000
} ,
"channel" : {
"paymentMethod" : "KBANK" ,
"cashAccount" : "17385238451" ,
"accountName" : "test"
}
}
Notification HTTP Request Field Attribute Type Description Content-Type M String application/json
X-TIMESTAMP M String yyyy-MM-ddTHH:mm:ss[zoneOffset]
eg: 2020-12-17T10:55:00+07:00
X-SIGNATURE M String how to check this value
Body Parameters Field Attribute Type Description orderNo M String merchant transaction unique no tradeNo M String smilepayz trade no. merchantId M String merchant id merchantName M String merchant name subMerchantId O String sub merchant id subMerchantName O String sub merchant name paymentMethod M String payment method. eg:BCA transactionTime M String yyyy-MM-ddTHH:mm:ss
status M String Object Model Status money M Object Object Model Money
Return Important
Notification please return only string SUCCESS
Request Response
{
"merchantId" : "20001" ,
"merchantName" : "test" ,
"money" : {
"amount" : 1000.0000 ,
"currency" : "THB"
} ,
"orderNo" : "0TIn7z0G96HAGV8I734290310" ,
"status" : "SUCCESS" ,
"tradeNo" : "112200012412160218303176" ,
"transactionTime" : "2024-12-16T02:18:30"
}
Prev
Api Payin
Next
Api Refund