Sign in

v1

latestOpenAPI 3.0.02026-07-14866188.2 KB
Payouts

Payout Interac.

post/v0.2.4/payouts/interac

Request body

subAccountstring

Subaccount (Wallet Account) to payout from, if any.

turnOffNotificationboolean

disables email and other notifications from Chimoney.

debitCurrencystring required

Wallet Currency to debit from.

Example request

{
  "subAccount": "1234567",
  "debitCurrency": "CAD",
  "interacs": [
    {
      "email": "user@mail.com",
      "name": "Jane Doe",
      "amount": 10,
      "narration": "Monthly Rent Payment",
      "collectionPaymentIssueID": "1209992222"
    }
  ]
}

Response

Success.

statusstring

Status of the request.

messagestring

Message describing the outcome.

Example response

{
  "status": "success",
  "message": "Payout completed successfully",
  "data": {
    "paymentLink": "http://localhost:4000/pay/?issueID=63576330-b5f6-4279-9324-80633ce14710_11_1726571303087",
    "error": "none"
  }
}