• This API endpoint is used to disburse fund into beneficiary's bank account.
Request URL
  • /api/payOut
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
accountName Mandatory String(32) Brandme The name of the customer registered in your system, it's required to comply with disbursement regulation.
accountNo Mandatory String(32) 64618000007 The beneficiary's bank account number.
accountType Mandatory int 3 Only accept3, means bank account number.
currency Mandatory String(32) IDR Only IDR
amount Mandatory decimal(20,2) 10000 Amount to disburse.</br>Minimum Amount (IDR)=10,000, Maximum Amount (IDR)=5,000,000
bankId Mandatory int 1 Destination bank </br>Reference Get Supported Banks
mchOrderNo Mandatory String(32) mchOrderNo1628381288000 The order No. in the merchant system, can not be repeatable.
notifyUrl Mandatory String(250) Registered disbursement webhook URL, only http and https.</br>Only public IPs or domains are allowed</br>DetailsDisbursement Status Webhook/Callback
nonceStr Mandatory String(32) 1628381288000
remark Mandatory String(32) remark
phone Optional String(32) 6285812345678 Beneficiary's mobile number
email Optional String(32) Beneficiary's email
idType Optional String(32) idCard Beneficiary's ID Type
idCard Optional String(32) Beneficiary's ID 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;M1656907083234&quot;,
        &quot;orderNo&quot;: &quot;PAYOUT8232147367892025344&quot;,
        &quot;amount&quot;: 100,
        &quot;fee&quot;: 0,
        &quot;orderStatus&quot;: &quot;PROCESSING&quot;
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,2) Fee
orderStatus String 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