# 2. Check Payout Status

# Request URL

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

# Request Method

  • POST

# Request Header

Parameter name Required Type Description
Content-Type Yes string application/json

# Request Param

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

# param

Parameter Name Required Type Length Example Description
mchOrderId No string 1-32 - Merchant order id (require one of mchOrderId and transactionId)
transactionId No string 1-32 - Platform transaction id (require one of mchOrderId and transactionId)
countryCode Yes string - - Country code (PH, ID, MY, TH)
timestamp Yes long Current timestamp

# Request Body Example

{
    "appId": "733b887a4a784708bb369524db5b6ded",
    "sign": "Platform",
    "param": "{\"mchOrderId\":\"Platform0001\",\"countryCode\":\"PH\",\"timestamp\":\"1677133173758\"}"
}

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 - Merchant order id
transactionId String D1656505190221611009 Platform transaction id
countryCode String - Country code (PH, ID, MY, TH)
currency String - Currency (PHP, IDR, MYR, THB)
amount long 3000 Amount (Unit is in cents, when the country is Indonesia, the unit is in yuan)
transactionStatus String Reference List Transaction status (PENDING, COMPLETED, FAILED)
createTime String - Transaction create time
returnTime String - Transaction finish time
remark String - remark
failedCode String Reference List Failed code
failedMessage String - Failed message

# Response Example

# Response Param

{
  "code": 10000,
  "message": "Success",
  "data": {
    "mchOrderId": "8af3776584873647100",
    "transactionId": "D1656505190221611008",
    "amount": 3000,
    "transactionStatus": "FAILED",
    "createTime": "2024-07-18T19:32:25+08:00",
    "returnTime": "2024-07-18T19:33:45+08:00",
    "failedCode": -10004,
    "failedMessage": "Transaction Channel Rejected"
  }
}

Code Collection

# Failed Response Example

{
  "code": 21010,
  "message": "transaction not found",
  "data": null
}