# 1. Create Payout

# Request URL

  • {domain}/open-api/disbursement/transfer

# Request Method

  • POST

# Request Header

Parameter name Required Type of data Description
Content-Type Y string application/json

# Request Param

Parameter name Required Type of data Length Example Description
appId Y string - - Application ID
param Y string - - Parameter Body
sign Y string - 45eebd745dcf0b5f6d6f9fcde28cd9fe8116a892 Sign

# param

Parameter name Required Type of data Length Example Description
timestamp Y long - 1678356680000 Current timestamp
mchOrderId Y string 10-32 CCP20220428011068111 Merchant order id (unique for merchant), 1-32 characters
idempotencyId Y string 10-32 - Idempotency ID KEY, format:letter + space,10-30 characters
amount Y long - 50000 Payout amount (unit: cents) THB:500.20, should set 50020 cents
payMethodCode Y string - Reference List Platform payMethodCode
transferCode N string - Reference List Transfer code. Required when payMethodCode is 'BANK'
promptpayAccountType N string - - PromptPay Account Type. Required when payMethodCode is 'PROMPTPAY'. value is 'NATID' or 'MSISDN'
accountNo Y string 1-50 - Beneficiary account.
accountName N string 1-128 - Payee Name. Required when payMethodCode is 'BANK'
accountType N string - - Receiver Type value is 'INDIVIDUAL' or 'ORGANIZATION'. Required when payMethodCode is 'BANK'
accountTaxId N string 1-50 - ID Card Number / Business Registration No. Required when payMethodCode is 'BANK'
mobile N string 10 - Receiver mobile (format: start with 06, 08 or 09). Required when payMethodCode is 'BANK'
relationship N string 1-50 - relationship
remark N string 1-256 - remark

# Request Example

# Request Body

{
  "appId":"349094b672f3479692ca70790477a8af",
  "sign":"hu4O4kDytpZdDZeETIDFpcZWA4t3Jf7OMOlS9Zuy5fPc/aUUwxSU6O+KVgg0gnL67wttjDV4Bls+gF6tZJ/BjPfk/O2UYy3z+RH6NA0c3qVrHV5jgdQG8MGI8kFA5FXQM96DvS3sKMb6vO2/Cuxhl9Lae+kArLQS/sRjTJ19hnijs0NK1TTfWDZO3SFwX0KN6uBf19luy6ti4xy20Ha61N7V+W4zXj0DJJco3srr0/SI+IRYzO7o8O5UpXiWjkSnlKGMW9JS1MM4w8qeitm3weYgnbC5hmuG1R4QzoC5ZAiI4xpJsFQ1ZC1qNUrOB127pEnOZBJtoB3XtMqqAyeRCg==",
  "param":"{\"mchOrderId\":\"8af0448965624571100\",\"idempotencyId\":\"8af0448965624571100\",\"amount\":2000,\"accountNo\":\"1613945551\",\"accountName\":\"ข้อความต้นฉบับ\",\"payMethodCode\":\"BANK\",\"transferCode\":\"KBANK\",\"accountType\":\"INDIVIDUAL\",\"accountTaxId\":\"123\",\"timestamp\":1690448966}"
}

How to construct request body


# Response Param

Parameter Name Type Description
code integer response code
message string response message
data Object data

# data

Parameter Name Type Example Description
mchOrderId String - mch order id
transactionId String D1656505190221611009 Platform transaction id
transactionStatus String Reference List transaction status
transactionTime String 2023-05-04 11:43:08 transaction create time

# Response Example

{
  "code": 10000,
  "message": "Success",
  "data": {
    "mchOrderId": "MCHORDERIDC00001",
    "transactionId": "D1656581872743874560",
    "transactionStatus": "PENDING",
    "transactionTime": "2023-05-04 16:47:50"
  }
}

Code Collection

# Failed Response Example

{
  "code": 21000,
  "message": "Server error, Please try again later.",
  "data": null
}