Payouts

Payout Interac.

post/v0.2.4/payouts/interac

Request

Base URL
https://api.chimoney.io
Auth
API key in header X-API-KEY
TypeScript
https://skmtc.dev/chimoney/apis/chimoney-api-docs/docs/v0.2.4/payouts/interac/post.ts
A function with typed inputs. Its response is checked against the schema.

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"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.