GET
https://api.mpay.com.au/reports/v1/settlement/{date}
You may choose to set your mAccounts to settle automatically every day. If so, the mAccount balance will be brought to zero at 4pm (Sydney time) each business day. Any positive balance will be disbursed to the bank account you have linked; any negative balance will be direct debited from the bank account you have linked. Transactions on weekends, public holidays and after 4pm wonβt appear in the settlement report until after 4pm the next business day.
This report returns an array of actual disbursements for each transaction that was settled on the given date. Date is represented by ISO8601 β β2016-03-01β for 1st March 2016.
What this report returns
Each entry is a disbursement - a movement of funds out of your mAccount
that formed part of that day's settlement. This is the money-out view of the
day, reported one row per settled transaction, with the fee charged on each.
The disbursementMethod field identifies the rail used:
| Payout type | disbursementMethod | Destination |
|---|
| NPP (Osko) to a bank account | NppCreditBankAccount | External Australian bank account |
| NPP (Osko) to a PayID | NppCreditPayId | External PayID |
| Direct Credit | directCredit | External Australian bank account |
| Direct Credit to a stored token | token | Tokenised bank account |
| Direct Debit | directDebit | Debits an external bank account |
| BPAY | bpay | BPAY biller, paid from an mWallet |
datestring<p><strong>Required</strong>. The settlement date to report on, in ISO 8601 <code>yyyy-MM-dd</code>
format. For example, <code>2016-03-01</code> returns the settlement that ran on
1 March 2016.</p>
acceptstringGenerated from available response content types
200Successful validation. The settlement report was generated.
400Bad request. The date supplied is missing or is not a valid ISO 8601 date.
401<p>Unauthorised. The API key is missing, invalid or has been revoked.</p>
500Internal server error. The request could not be completed by the Platform.
curl --request GET \
--url https://api.mpay.com.au/reports/v1/settlement/{date} \
--header 'accept: application/json'