Get Disbursement Status

  • Get Disbursement Status
Request URL
  • /api/payOutQuery
Request Type
  • [POST]
  • [content-type: application/json;charset=UTF-8]
Header Parameter
  • Reference Request Standards
Request Parameters
Name M/O/C Type Example value Description
mchOrderNo Optional String(32) mchOrderNo1628381288000 The order No. in the merchant system, can not be repeatable<br>mchOrderNo or orderNoOne of the two is Mandatory
orderNo Optional String(32) PAYOUTxxxxxx First useorderNo <br>mchOrderNo or orderNoOne of the two is Mandatory
nonceStr Mandatory String(32) 1628381288000 Random Number
Sample Code API Response
    &quot;msg&quot;: &quot;SUCCESS&quot;,
    &quot;code&quot;: 200,
    &quot;data&quot;: {
        &quot;merchantId&quot;: &quot;100001&quot;,
        &quot;mchOrderNo&quot;: &quot;M1656756338536&quot;,
        &quot;orderNo&quot;: &quot;PAYOUT8231515112790892544&quot;,
        &quot;amount&quot;: 100.00,
        &quot;fee&quot;: null,
        &quot;orderStatus&quot;: &quot;PAYING&quot;,
        &quot;completionTime&quot;: null,
Response Parameters
Name Type Description
merchantId int Merchant ID
mchOrderNo String(32) Send by merchant
orderNo String(32) Cashy Order No.
amount decimal(20,2) Amount to disburse
fee decimal(20,4) Fee
orderStatus String(32) PROCESSING, PAYING=Disbursement in process<br>SUCCESS=Bank has confirmed transmission of funds<br>FAIL=Disbursement failed because of failure msg<br>CANCEL=Rejected by Cashy
completionTime date Completion timeGMT+7 yyyy-MM-dd HH:mm:ss
resultDesc String(32) PAYMENT_SUSPECT_SURVEY=Suspect disburse inquiry.</br>PAYMENT_QUERY_FAIL=Failed disburse inquiry.</br> BANK_ACCOUNT_ERROR=Wrong bank account number. </br>BANK_ACCOUNT_CLOSE=Closed bank account.</br> BANK_REFUSE=Inquiry rejected by the vendor bank. </br>BANK_CLOSE=Inquiry vendor bank is down.</br> UNKNOWN_ERROR=Unknown error </br> SUCCESS=Success