v1

latestOpenAPI 3.0.02026-07-14866188.2 KB

Payouts

Payout Canadian Bill payment.

post/v0.2.4/payouts/bills/ca

Request body

subAccountstring

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

turnOffNotificationboolean

disables email and other notifications from Chimoney.

debitCurrencystring

Wallet Currency to debit from.

Example request

{
  "subAccount": "1234567",
  "debitCurrency": "CAD",
  "billingData": [
    {
      "email": "test@bills.com",
      "firstname": "Daniel",
      "lastname": "Chimoney",
      "payeeCode": "000000",
      "payeeName": "Test Name",
      "amount": 1.25,
      "accountID": "TEST1234567",
      "narration": "Monthly payment for plumbing fixes",
      "collectionPaymentIssueID": "1209992222"
    }
  ]
}

Response

Success.

statusstring

Status of the request.

messagestring

Message describing the outcome.

Example response

{
  "status": "success",
  "message": "Payout to bills processed successfully.",
  "data": {
    "payoutLink": "undefined/pay/?issueID=XQTUvRBntIU3AHgQ3jFuN9ZcHIC3_1_1661114934226",
    "error": "None"
  }
}