Payout

This process will create a payout to be run. The process will take Bank account ID request to validate with the customer's contact being added to a payout.

To get Bank account ID, please check GET Customer account

If the customer's contact does not exist, a new one will be created and proceed to the payout process. This is to verify that the customer being paid matches a payment record.

To create a payout, the customer has used their PayId to make a payment process at least once and a payment record.

Request prarameter definitions

• customer_id* : Customer short ID.

• account_id* : Customer account ID.

• amount* : Amount in cent.

• asset* : Payout currency.

• name* : Title of this payout.

• description : Payout description.

• reference* : For customer description. What customer sees.

*is mandatory prarameter

Request body

{
  "customer_id": "WlgXhMXPBj"
  "account_id": "63e06495d28b3b3f1a5b0c64"
  "amount": 1111,
  "asset": "AUD",
  "name": "Payout for David",
  "description": "this is a payment",
  "reference": "Hi David! Here is your payment :)"
}

Response body

{
    "status": "ok",
    "message": "Payout Successful",
    "payout": {
        "status": "scheduled",
        "payout_id": "63d8bc80acb87389230dcfc5",
        "received_time": 1636486425
    }
}