Debit Customers Bank Accounts
Monoova provides a flexible and scalable way to debit customer accounts and fund your ledger. This guide walks through three primary methods for funding a ledger:
- PayTo (NPP) (Preferred)
- Direct Debit (BECS) fallback
- Manual Deposit via PayID or BSB/Account fallback
All funds settle into your Monoova Ledger, either directly in production or via transfer in the sandbox.
Step 1: PayTo Debit (Primary Method)
PayTo provides real-time debiting of a customer's bank account through an approved Payment Agreement.
Endpoint
POST https://sand-api.monoova.com/au/payto/pam-v1/PaymentInitiation
Auth
Bearer Token (from Step 4 of onboarding)
Request
Response
Result
Funds settle instantly to the ledger account you specified during onboarding.
Step 2: Check Ledger Balance
After any funding event (PayTo, Direct Debit, etc.), confirm the balance.
Endpoint
GET https://api.m-pay.com.au/ledger/v1/balance/{ledgerAccountNumber}
Response
Step 3: Direct Debit (Fallback Method)
When PayTo is unavailable, you can use a traditional BECS Direct Debit as a fallback. In production, this takes T+2 for settlement.
Endpoint
POST https://api.m-pay.com.au/financial/v2/transaction/execute
Request
Response
Sandbox Note
In sandbox, the funds will settle to your mAccount, not the ledger. You must manually transfer them.
Move funds to ledger
Endpoint: POST https://api.m-pay.com.au/financial/v2/transaction/execute
Request
Response
Step 4: Manual Deposit (PayID / BSB Fallback)
If the customer prefers to transfer funds manually, you can display their PayID or BSB/account number.
No API Required
Simply show the ledger deposit information:
- PayID (auto-generated from onboarding step)
- BSB: 802-985
- Account: 917567642
Notes
- PayID enables real-time NPP deposits
- BSB/Account supports traditional EFT
- In sandbox, deposits via PayID or BSB are not simulated
- In production, they settle directly to the ledger
Summary
Method | Settlement Time | API Call | Destination |
|---|---|---|---|
PayTo | Real-time | Yes | Ledger |
Direct Debit | T+2 | Yes | mAccount → transfer to ledger |
PayID | Real-time | No | Ledger |
You can safely combine all three methods to provide a robust and reliable account funding experience for your users.