Overview

the monoova api supports all major payout types in australia, including direct credit, direct debit, bpay, and npp transactions, as well as transactions between monoova accounts all disbursements are made through a single multifunctional endpoint for simplicity execute a transaction docid\ nmknovkipahgvaev5znxp each payout has an optional source object (where funds come from) and a disbursement object (where funds go to) if the source is omitted, funds will come out of your sign in maccount by default below are all supported payout methods external disbursements send funds to destinations off the monoova platform, e g a bank account payout type speed description npp (osko) instant payout to a bank account or payid funds clear in a few seconds direct credit docid\ sdo44zgadhlqonmtch69q 1 2 days payout to bank account or by batch to multiple bank accounts bpay docid\ hofqqzdggee1hgw0ae dn 1 3 days send funds to bpay billers internal disbursements send funds on platform, e g to another maccount payout type speed description internal transfers docid\ wwxz1tualoiifpcgaokn2 instant transfer funds to another maccount or a ledger account on the monoova platform, using the maccount number of the recipient ledger accounts docid\ elwcgpvalvynkpdyhyj4s instant transfer funds to one of your ledger accounts source object the paymentsource object controls where funds are sourced from, and can be any of the following maccount, mwallet, directdebit, token directdebit and token are only valid for direct debit docid\ dw36eboz2nrn6umen0mgz transactions maccount when disbursing funds from an maccount, the maccount number must be provided in the maccount parameter mwallet and ledger account when disbursing funds from an mwallet or ledger account, provide the account token in the mwallet object the mwallet pin is required for bpay transactions using an mwallet this can be omitted for payments from a ledger account direct debit if the payment source is direct debit, the funds must land in a monoova account the direct debit source object can only be used with the directdebit disbursement method disbursement method the disbursementmethod type is used to control which payment method is used the request body depends on the payment method selected npp "disbursementmethod" "nppcreditbankaccount" when paying to a bank account, or "disbursementmethod" "nppcreditpayid" when paying to a payid pay external australian bank accounts or payids, with payments settling instantly in the recipients account responses are returned instantly in some instances a ‘pending’ status is returned, this means that we are waiting for confirmation that the payment has been processed by the processor subscribe to the npppaymentstatus webhook to receive a notification when the payment clears direct entry "disbursementmethod" "directcredit" when paying to a bank account, "disbursementmethod" "directdebit" when debiting a bank account, and "disbursementmethod" "token" when paying a bank account token pay or direct debit external australian bank accounts or payment tokens docid\ q4coqy4kuhldxc6eqneom direct debits can be made to single accounts or as a larger batch for efficiency bpay "disbursementmethod" "bpay" when paying via bpay you must first create an mwallet follow the instructions in the bpay docid\ hofqqzdggee1hgw0ae dn guide to set this up, and pass the mwallet id in the paymentsource object mwallet is the only valid disbursement source for this payment method lodgement reference custom lodgement references can be provided with direct credit, direct debit, and npp payments these lodgement references appear in a customers bank statement and are generally used to identify the purpose of the payment if this parameter is not provided we will insert a default value dynamic remitter name monoova's dynamic remitter name feature provides the ability to define the remitter name, such as your company name, on the end beneficiaries bank statement dynamic naming is applicable for local push payments including npp out and direct credit you can pass the remittername object when calling execute a transaction docid\ nmknovkipahgvaev5znxp with a name up to 140 characters for npp payments, or 16 characters for direct entry payments only english letters and numbers are permitted dynamic source account the source account appears on a benificiaries bank statement and is where funds are sent from to enable easier returning of funds you can choose to specify a source account when making a payment by direct credit or npp by passing the sourcebsb and sourceaccountnumber