{"info":{"_postman_id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","name":"Moneytech Payments Platform","description":"

Overview

Moneytech Payments thanks you for your interest in our Platform. This document describes our latest offering. It is the result of combining several bespoke and public API offerings with which we have provided clients in the past with the goal of providing a rich set of services to satisfy the majority of customers.

While we remain open to providing bespoke solutions to clients when the need arises, we feel that the APIs presented in this document will provide the flexibility to solve almost any financial payment requirement your business may have.

We want your experience of using these APIs to be seamless, easy and ‘just work’. For this to happen you need to understand the key concepts discussed in the Overview section of this document. We highly recommend that your developers arrange a meeting with our Platform team. This does a few things to expedite your development:

You get to ask and have any concepts explained by some of the people who have written the APIs you will be using
You get to know who we are and who to send any questions too
Explain to our team what business problem you are solving, we can then guide you to which APIs you need to use and those you can ignore. It also gives us context for future correspondence

The Platform is a payment gateway developed by Moneytech Payments which provides a high performance and flexible payment solution to enable 3rd parties to develop custom business solutions with ease. Funds may be debited from:

Credit-Card (Visa, Mastercard, Diners, Amex)
Australian Bank Account
mAccount
mWallet

Funds can be credited to one or a multiple of the following destinations in a single API call:

BPAY
Australian Bank Account
mAccount
mWallet

Tokenization is fully supported for both the debit and credit transactions:

BPAY
Australian Bank Account
Credit-Card

What is an mWallet and mAccount?

At the core of the Platform is an extremely rich set of services that were developed for mPOS (another Moneytech Payments product). The mPOS product was designed and developed for the Point of Sale market supporting (although not limited to):

Over the counter bill payments (BPAY)
Loyalty
Point of Sale purchases
Statements
Daily Settlement
Consumer stored value
Auto Top-Up
Transactions via SMS
Much more…

Because of this heritage, the Platform has two key concepts:

mWallet
mAccount

mWallet

Think of an mWallet as the wallet in your back pocket. This is where you keep funds to purchase goods and services. Funds are deposited into this wallet by withdrawing cash from an ATM, your bank branch or other means. The cash stays in your wallet until you wish to purchase goods.

On the Platform, funds stored in an mWallet are kept in a Trust account on behalf of the owner. In general, there are no fees charged on mWallet accounts including deposits (credit) and withdraws (debit). For security, any debits from an mWallet require a four-digit PIN. Deposits into mWallets are cleared funds immediately. The funds stay in the mWallet until required.

An mWallet financials API (mWallet/v1/financials) is available at any time as well as financial statements (if an email address is available).

Moneytech Payments has an exemption from ASIC (Australian Securities and Investments Commission) to implement the mWallet, as a consequence, there are some restrictions in-place according to ASIC’s rules.

Moneytech Payments is an authorised BPAY PIM. A requirement of BPAY is that BPAY payments must be through an mWallet with sufficient details to enable Moneytech Payments to contact the owner of the mWallet if there is a problem with the payment.

If a payment is being made that does NOT include BPAY, then an mWallet is optional. If an mWallet is supplied, then the Platform will route the funds through the supplied mWallet providing full disclosure on the mWallet Financial Statement.

An mWallet is represented by a 16-Digit account number.
You may create as many mWallets as you require
The balance of an mWallet can never fall below $0.00
An mWallet may be Debited or Credited by anyone as a PIN is required for both operations.

mAccount

Think of an mAccount as the till in a shop. When a consumer purchases goods in this shop, cash is handed over and stored in the till. At the end of the day, these funds are removed from the till and deposited into the shops physical bank account for safe keeping.

Each mAccount is backed by an ABN and a physical Australian Bank Account. See the section titled Settlement.

You may create mAccounts through the mAccount/v1 APIs in this document. If you debit an mAccount, you MUST also hold a signed direct-debit authority.

When a Sign-In Account creates an mAccount (using the mAccount/v1 APIs) the Sign-In Account is set as the new mAccounts parent. Only a parent of an mAccount can Debit, Update, Retrieve Financials, Request Statements, Close the account etc.

A nmAccount is represented by a 16-Digit account number.
An mAccount can be credited by anyone.

You can create as many mAccounts as you require, although monthly and/or set-up fees may be configured based on your agreements with Moneytech Payments

There are some financial limits when you create an mAccount through the mAccount/v1 APIs. If you require higher limits, contact your Moneytech Payments account representative.
An mAccount financials API (mAccount/v1/financials) is available at any time as well as emailing a financial statement (if an email address is available).
A balance below $0.00 indicates the Platform will DEBIT the mAccounts physical Australian Bank Account (ABA)
A balance above $0.00 indicates the Platform will CREDIT the mAccounts physical Australian Bank Account (ABA)

mAccount Issuers

An issuer is a high-level mAccount with the following rights

Product co-branding
Develop, market and and sell a product to others who will be given their own mAccount and access to this API
Additional reporting
Additional support
Ability to impersonate an mAccount that you own – create custom reports, statemens etc

mAccount Sign-In Account

The Sign-In Account is simply the mAccount used to sign-in to the payment gateway.

mAccount Fee Account

Any Sign-In Account may have an optional Fee Account linked to it. The Platform will use the Fee Account when debiting or crediting fees from the Sign-In Account. The Fee Account can have the same ABA details as the Sign-In Account or may be different. A separate statement will be sent providing clear concise information regarding fees.

Fee Accounts have the following attributes:

Debit T+0
Credit T+0
Daily Settlement statement
Daily/Monthly Statements
To request a Fee Account contact your Moneytech Payments account representative.

Direct Debit and Direct Credit

The financial/v2/transaction/execute API provides the ability to either debit or credit any Australian Bank Account directly by providing the following details:

Bank-State-Branch (BSB) Number
Bank Account Number
Bank Account Title

By using Direct Debit, you MUST hold a signed direct debit authority. (Or show that you have the authority to debit the account)

Settlement

In Platform terms, the act of a settlement is to calculate the balance of each mAccount at 4PM (Sydney Time) each business day (this balance is called the ‘Settlement Balance’). The ‘Settlement Balance’ is used to create a reversing transaction (called a ‘Settlement Transaction’) to bring the mAccount balance to $0.00. These ‘Settlement Transactions’ are then submitted to either Debit or Credit the physical Australian Bank Account (ABA) attached to the mAccount.

A ‘Settlement Balance’ below $0.00 (-ve) will Debit the mAccounts physical Australian Bank Account (ABA)
A ‘Settlement Balance’ above $0.00 (+ve) will Credit the mAccounts physical Australian Bank Account (ABA)

Settlement Frequency

By default, mAcounts are settled every business day at 4PM. Many other options are available by contacting your Moneytech Payments representative. Some of the options are:

Daily at 4PM (Sydney Time)
Daily at 10AM (Sydney Time)
On-Demand
Beginning of Month
Mid-Month
End of Month
Never Settle

Deferred Settlement - T+n

T+n is a term that indicates how many business days after the Transaction you want the funds Debited from or Credited to the mAccounts linked Australian Bank Account (ABA). When an mAccount is created/updated using the mAccount/v1 APIs, you can set the T+n values independently for both the Debit and Credit settlements. The default is to settle Debit and Credits as T+0 – same day if the transaction occurred before 4pm Sydney time.

How T+n works: The mAccount ‘Settlement Transaction’ is created as usual at 4pm each business day. The ‘Settlement Transaction’ date is set to the calculated date in the future (+n business days) and will appear on the statement with this future date (so you know when to expect it). The actual instructions to Debit or\nCredit the funds are delayed until the calculated date.

Settlement Notifications

mAccounts receive a settlement email at the end of the settlement run, explaining the amount to be Debited/Credited to their mAccounts physical Australian Bank Account, the date the settlement will occur (remember T+n) and a financial statement (as a PDF) which lists each transaction that was settled, as well as an Excel Spreadsheet with all the transactions listed in the PDF statement for further analysis.

Sample Settlement Email

\n\n

Note

The above ‘Credit Date’ would have the actual date the settlement would occur if T+n are > 0.

Sample PDF Settlement Statement

The Statement From Date and the To date in the statement below (inside the green box) are from 4pm the previous settlement date (5th May 2017 – A Friday) to 4pm the current settlement date (8th May 2017 – A Monday). This is why it’s called a Settlement Statement. It’s only showing transactions that were settled on the 8th May 2017 (a Monday) which included any transactions over the weekend.

When looking at any of the Platform statements, think of the Platform as a bank. In the example below, the Settlement transaction (row 2) shows there is a Debit of $85.00 for the settlement. This is a Debit FROM your Platform account and will therefore be a Credit INTO your physical bank account.

\n\n

Sample Excel Settlement Spreadsheet

The Settlement Notification email includes an Excel spreadsheet with the same details as the PDF Settlement Statement. This provides you with the same data that you can use for analysis.

\n\n

Financial Statements

The Platform will automatically send financials statements to both mAccounts and mWallets if an email address is provided. These include Month to Date, Last Month, Last Financial Year and others.

Statements are emailed as a PDF attachment along with an Excel spreadsheet containing the same details as the PDF statement.

Using the mAccount/v1/sendStatement and mWallet/v1/sendStatement APIs you may request a statement to be sent at any time.

A Credit Settlement transaction will appear as a Debit on your physical Bank Statement and a Debit Settlement transaction will appear as a Credit on your physical Bank Statement. Both mAccounts and mWallets represent a financial account held on the Platform. The Statements are in respect to the Platform NOT your physical bank account.

Example – mAccount Month To Date Financial Statement

\n\n

Tokens

A token is used to obfuscate either the source or destination of the funds (Credit-Cards, BPAY & Australian Bank Account (ABA)). The details associated with tokens are stored encrypted on the Platform attached to an existing mAccount or mWallet.

Tokens are created using the token/v1 APIs by passing the BPAY, ABA or Credit-Card details. A token is returned which is used in subsequent calls to identify the source (Debit) or destination (Credit) details. By using tokens, you never store any of these details on your own servers.

\n\n

The Sign-In Account is nothing more than the mAccount used to access the APIs discussed in this document.

When creating a token, you are required to attach this to an existing mAccount or mWallet. For example, if an mWallet holder wants to create a Credit-Card token, that token would be associated with the mWallet, NOT the sign-in or any other mAccount.

What you end up with is a hierarchy of the Sign-In Account, mWallets/mAccounts and tokens:

\n\n

A Practical Example

Scenario

Say you have a website that sells flowers. The following business rules have been defined by you.

For customers who are regular buyers you create an mWallet and you provide a ‘Cash Incentive’ of 1% for each purchase.
You need to pay a courier for delivery. The cost is included in the total amount.
You donate $0.50 from each purchase to a local Charity.

Solution

As this customer is well known (we are assuming he/she is), you have previously created an mWallet when they registered on your site. The customer may have registered a Credit-Card with you previously and therefore you can query the token/v1 APIs for a displayable list of Credit-Cards or bank accounts that the customer may choose from to make the payment.

For this example, the total cost of the flowers is $100.00 including freight of $7.00 which is to be paid via BPAY. The cash loyalty on this purchase is $1.00 (keeping it simple) to be deposited into the customers mWallet and $0.50 to your local Charity.

The customer decides to pay by a previously registered Credit-Card we therefore want to deposit $2.00 into the Sign-In Fee Account to cover the processing fee Moneytech Payments will debit (see the API tools/v1/creditCardValidate to calculate the Credit Card fees and surcharge. You can also use the financial/v1/transaction/validate API to retrieve a breakdown of all fees although no surcharge will be returned). \nThe remainder of the funds are deposited into an mAccount that you created called Revenue.

In brief, we can do all the above (and much more) with a single RESTful API call to the Platform. All you need to do is to create a JSON object that matches the specification for the financial/v1/transaction/ APIs.

Debit

Credit-Card via token: $1.00

Disbursements - Credits

Customer's mWallet: $1.00 (Loyalty payment)
Courier's BPAY details: $7.00 (Courier Payment via BPAY)
Sign-In Fee mAccount: $2.00 (Cover the Processing Fee)
Charity: $0.50 (Local Charity Donation)
Revenue mAccount: $89.50 (The remaining funds payment)

Processing Fee

Processing Fee: $1.50

In the following diagram, a single RESTful API call is made to the Platform which contains the following instructions:

where the source of the funds are (whom do we Debit)
a list of disbursements or payments (whom do we Credit and how)

The Platform moves the funds to the correct accounts (mWallet, mAccounts, ABA or BPAY). At the next settlement the balance in each mAccount is required to be settled to $0.00. Therefore, funds are debited from the mAccount and credited to a physical ABA account (as in this diagram). In the case of BPAY, the funds are moved to BPAY which will then deposit it into the couriers account.

\n\n

As the customer has an mWallet, he/she will see the funds flowing through the mWallet on their statement. This is visible on the above diagram with the ‘Action Performed by the Platform’ arrows in red.

\n\n

Note

The mWallet Closing Balance is $1.00 which is exactly what we expected given the $1.00 loyalty incentive.

Conclusion

A single API call is all that was required to Debit a Credit-Card and make five disbursements.

\n\n

When you call the API financial/v1/transaction/execute the Sign-In Account accepts liability for the transaction.

Debiting via Direct Debit or mAccount

Debiting from a Direct Debit or mAccount, the Platform makes the assumption that the associated bank account will honour the request. If the bank dishonours the debit request for any reason (insufficient funds, incorrect account details etc) Moneytech Payments will debit the amount from the Sign-In Accounts bank plus a dishonour fee. If the Sign-In Account dishonours the next day, then the Sign-In Account will be placed OnHold and action taken to recover the funds.

If the same Direct Debit or mAccount is dishonouring on a regular basis then the mAccount will be placed OnHold or Closed. The Australian Bank Account could also be blocked from further transactions.

If you don’t want to use Direct Debit, inform your Moneytech Payments representative and that option can be disabled.

Debiting via Credit-Card

When debiting from a Credit-Card the Platform asks the Credit-Card provider if the debit will be honoured. If the response is “no\", then no further action is taken and the transaction fails – This step only happens during a call to the API financial/v1/transaction/execute. Executing the API financial/v1/transaction/validate will not guarantee the Credit-Card transaction will be successful.

If the response is \"yes\", the Platform assumes the funds will be credited then completes the rest of the transaction. If the card is reported stolen or the bank demands the funds returned, the Platform will debit the amount from the Sign-In Accounts bank plus any dishonour or processing fees. These are called ‘Chargebacks’ and can be up to 12 months after the transaction

Debiting via an mWallet

When debiting from an mWallet there is no issue as Moneytech Payments is holding the mWallet funds in trust.

\n\n

For a transaction, the Platform receives a request to debit funds and make payments (i.e. as BPAY). The Platform will make the payment the same day, although the funds may not arrive for several days. We could hold the payment of funds until the funds arrive, but by then the BPAY may have expired or the payment becomes a ‘Late Payment’ (You could do this yourself, paying into an mWallet. If you don’t receive a dishonour notification after a few days then make the payments from the mWallet. This will not resolve possible BPAY issues).

If you need to debit a supplier on a regular basis and you are concerned about the risk, talk to your Moneytech Payments representative. We can sign up the mAccount directly with a 100 point ID, legal contracts and even have them place a security deposit if we deem it required. You are still liable for any failed transactions and there is a monthly fee for each mAccount that we manage. We may provide a higher credit limit on the mAccount if it’s managed by Moneytech Payments.

Legal Requirements

As in the previous section, you must hold a Direct Debit Request for any Direct Debit or mAccount you debit from. There could be other reporting requirements under the ‘Australian Anti-money laundering and counter terrorism financing’ Act. Your Moneytech Payments representative will be able to help you with these enquiries.

See https://www.ag.gov.au/CrimeAndCorruption/AntiLaunderingCounterTerrorismFinancing/Pages/default.aspx

If there are any enquiries from government agencies you will be required to provide any and all documentation regarding the transactions in question. We recommend you keep these financial records for a period no less than seven (7) years or as prescribed by Australian law.

Authentication

Live Authentication Credentials

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Value
Username	Your Platform 16-Digit account number OR API Key (obtained from the developer portal)
Password	TBA
Base URL	https://api.mpay.com.au/

The RESTful APIs in this document all use BASIC Authentication (except those APIs in public/v1) in four scenarios; either:

UserName/Password
API KEY
OneShotSecurityToken

When using the LIVE Platform, your Sign-In Account is given five (5) attempts to authenticate your credentials. On the fifth failure your Sign-In Account is locked for one (1) hour. The returned data will indicate that your account is locked and the time in UTC that the account will be unlocked.

When using the Staging system, you are given fifty (50) attempts with a lockout time of two (2) minutes.

If you require the account to be unlocked on the LIVE system you may contact your Moneytech Payments representative and at his or her discretion they will unlock the account. A fee may be applied for this service.\nSee the API routes in Security to manage Passwords and Tokens.

UserName/Password

Using this scenario you configure BASIC Authentication with the following:

UserName - your mAccounts 16-Digit account number (This is called the Sign-In Account) OR API Key (obtained from the developer portal)
Password - password that will be supplied by Moneytech Payments when you have demonstrated successful implementation of the API on our Staging environment. When using your API Key, no password is required. If the key is compromised, it can be re-rolled via the developer portal.

Passwords are stored in a cryptographic format that is not reversible. If you forget your password, it cannot be recovered. You will need to contact Moneytech Payments and have a new password generated.

SecurityToken

Using this scenario, you make an API call to security/v1/createSecurityToken using UserName/Password. A SecurityToken is returned that may be used multiple times until it expires. See the security/v1 section for further details.

The SecurityToken returned is used in place of your UserName when configuring BASIC Authentication for future API calls (No password is required).

Expiry time is between 1 and 15 minutes.

OneShotSecurityToken

Using this scenario, you make an API call to security/v1/createOneShotSecurityToken using UserName/Password. A OneShotSecurityToken is returned that can be used only once or until it expires.

An OneShotSecurityToken is exactly the same as the SecurityToken scenario except the token will be deleted on first use.

Expiry time is between 1 and 15 minutes.

Testing

Staging Authentication Credentials

\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Value
Base URL	https://api.m-pay.com.au/

To access our sandbox environment please sign up at our developer portal

Staging Test Credit-Cards

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Card Type	Card Number	Expiry Date
MasterCard	5123456789012346	05/21
Visa	4987654321098769	05/21
Amex	345678901234564	05/21
Diners Club	30123456789019	05/21

To allow testing Credit-Card failures, you can set the status code you wish to have returned by changing the Credit-Cards CVN (Amex has a 4 digit CVN)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Description	CVN	CVN (American Express)
Transaction approved	000	0000
Transaction could not be processed	010	0010
Transaction declined	005	0005
No reply from processing host	068	0068
Card has expired	033	0033
Insufficient credit	051	0051

Direct Debit Authorisation Forms

When performing a Direct Debit transaction on an Australian Bank account, you are required to have direct debit authorisation. Please contact Moneytech for further information and assistance.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Sign-In Account Liability","slug":"sign-in-account-liability"},{"content":"Authentication","slug":"authentication"},{"content":"Testing","slug":"testing"},{"content":"Direct Debit Authorisation Forms","slug":"direct-debit-authorisation-forms"}],"owner":"2248716","collectionId":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","publishedId":"6fSWRD9","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"1D396A","highlight":"F7941D"},"publishDate":"2018-09-26T04:14:19.000Z"},"item":[{"name":"Financial","item":[{"name":"/financial/v2/transaction/execute","id":"fecd976f-101f-36b2-95ca-b5b37082fc04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"uniqueReference\": \"Reference9281452\",\n \"totalAmount\": \"10\",\n \"printUniqueReferenceOnStatement\": true,\n \"description\": \"SignInmAccount to DirectCredit\",\n \"disbursements\": [\n {\n \"disbursementMethod\": \"directCredit\",\n \"description\": \"SignInmAccount to DirectCredit\",\n \"toDirectCreditDetails\": {\n \"bsbNumber\": \"032-000\",\n \"accountNumber\": \"56654983\",\n \"accountName\": \"Monoova\"\n },\n \"amount\": \"{{amount}}\"\n }\n ]\n}"},"url":"https://api.m-pay.com.au/financial/v2/transaction/execute","description":"

The purpose of the execute API is to debit a source for funds then distribute those funds to one or more supplied disbursement accounts.

You can use the Transaction/validate API to determine if the parameters are correct.

Example 1 - Credit-Card -> mWallet

Debit Credit-Card with the funds going to an mWallet.

For example we are going to debit a credit card for $100 and credit an mWallet for the full amount.

Statement

Sign-in Account - 6279059610001205

\n\n

As can be seen, there was a credit to the Sign-In Account from the Credit-Card for $100.00 then immediately paid the mWallet account.

Moneytech Payments took $3.57 as a processing fee leaving the Sign-In Account with a debt of -$3.57.

mWallet- 6279059700010827

\n\n\n

The mWallet owner simply sees a credit into his/her account for $100.00

Example 2 – Credit-Card -> mAccount

In this example, we are going to debit a Credit card for flowers costing $100 + a $2 processing fee. We will have the Platform credit two separate mAccounts for the $100 and the $2 fee. This allows you to keep the products cost separate from the fees account.

Statement

Sign-in Account - 6279059610001205

\n\n

As expected, there was a credit to the Sign-In Account for $2.00 to cover the fees, with Moneytech Payments debiting the account for $2.84, leaving a closing balance in the account of $-0.84.

Where is the transfer to mAccount 6279059610001205 for $2.00? As the mAccount 6279059610001205 is the same as the Sign-In Account, the Credit-Card funds are credited to the Sign-In Account and therefore the $2.00 is already in the account. The Platform simply ignores the request.

mAccount – 6279059700002972

\n\n

As expected, the mAccount sees a credit into their account from the Sign-In Account.

Example 3 – Credit-Card -> Direct Credit

In this example, we are going to extend Example 2 by having the flowers cost ($100) split into $15 and $85. We will have the $85 paid into the principal account while the $15 paid to a courier bank account.

For example. Let’s say the flowers cost $100 and you have added $2.00 as a processing fee and we are paying an Australian Bank Account $15 for the fee taken from the $100 principal.

Statement

Sign-in Account - 6279059610001205

\n\n

With $85.00 being paid to an mAccount, $15.00 being a Direct Credit. Moneytech Payments debited a processing fee of $3.72 leaving a balance of $-1.72.

mAccount – 6279059700002980

\n\n

BSB Account

\n\n

Behind the scenes, the Platform creates an mAccount for the Direct Credit request. As you can see from the statement for this mAccount, there has been a Direct Credit made for $85.00.

Example 4 – Credit-Card -> BPAY

In this example, we are going to extend Example 3 by having the flowers cost ($100) split into $85 & $15. We will have the $85 paid into a BPAY account, $15 paid to the courier bank account via Direct Credit.

We are once again adding $2 as a processing fee to be paid into the Sign-In Account

Statement

Sign-in Account - 6279059610001205

\n\n

With $85.00 being paid to an mAccount, $15.00 being a Direct Credit and Moneytech Payments has debited a processing fee of $3.34, leaving a balance of $-1.34.

BSB Account

\n\n

Behind the scenes, the Platform creates an mAccount for the direct credit request. As can see from the statement for this mAccount there has been a Direct Credit made for $15.00.

mWallet – 6279059700002980

\n\n

As an mWallet was specified, the statement shows how the funds were deposited along with the payment details.

Example 5 – mWallet -> mWallet

In this example, we will debit an mWallet for $100 and credit another mWallet for $100

Statement

Sign-in Account - 6279059610001205

\n\n

Note

The ID’s are all 6 indicating they belong to the same transaction.

Source mWallet- 6279059700010827

\n\n

The first row is from Example 1 (we needed some money in the mWallet to transfer).

The second row is the transfer of $100 and who is receiving the funds.

Destination mWallet- 6279059700010835

\n\n

The destination mWallet account shows the deposit for $100 and who it’s from.

Example 6 – Direct Debit -> mWallet & mAccount

Debit an Australian Bank Account for the funds crediting an mWallet and an mAccount.

For example; Debit an mWallet for $27 and put this into another mWallet

Statement

Sign-in Account - 6279059610001205

\n\n

You can see the Direct Debit for $27 followed by the payment to the mWallet. Moneytech Payments debited $0.88 for the processing fee. The $2 disbursement has been optimized away.

BSB Account

\n\n

Behind the scenes, the Platform creates an mAccount for the direct debit request. As you can see from the statement for this mAccount there has been a Direct Debit made for $27.00.

Destination mWallet- 6279059700010835

\n\n

The destination mWallet account shows the deposit for $25 and who it’s from.

Example 7 – directDebit -> directCredit

In this example, we are going debit an ABA (directDebit) for $100 and credit another ABA (directCredit) for the same amount.

\n","urlObject":{"protocol":"https","path":["financial","v2","transaction","execute"],"host":["api","m-pay","com","au"],"query":[],"variable":[]}},"response":[{"id":"0c766085-3b79-d42b-cd9b-27d5f42638ca","name":"Credit-Card to mAccount","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"totalAmount\": 100,\n \"description\": \"Credit Card to sign in mAccount\",\n \"printUniqueReferenceOnStatement\": true,\n \"paymentSource\": \"creditCard\",\n \"creditCard\": {\n \"nameOnCard\": \"Fred Smith\",\n \"cardNumber\": \"5123456789012346\",\n \"expiryMonth\": 5,\n \"expiryYear\": 21,\n \"cardValidationNumber\": \"000\"\n },\n \"disbursements\": [\n {\n \"disbursementMethod\": \"mAccount\",\n \"description\": \"Credit Card to sign in mAccount\",\n \"toMAccount\": \"6279059700002972\",\n \"amount\": 100\n }\n ]\n}"},"url":"https://api.m-pay.com.au/financial/v2/transaction/execute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"673","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 05 Feb 2018 05:23:59 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"ddoizudgaujvfzcgp5ogur1m","key":"ASP.NET_SessionId"}],"responseTime":"3408","body":"{\"durationMs\":3262,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\",\"bpayReceipts\":[],\"callerUniqueReference\":\"12342\",\"feeAmountExcludingGst\":1.7800,\"feeAmountGstComponent\":0.1780,\"feeAmountIncludingGst\":1.9580,\"feeBreakdown\":{\"debitFee\":{\"feeAmountExcludingGst\":1.7800,\"feeAmountGstComponent\":0.1780,\"feeAmountIncludingGst\":1.9580},\"disbursementFees\":[{\"disbursementArrayIndex\":0,\"disbursementFee\":{\"feeAmountExcludingGst\":0.0000,\"feeAmountGstComponent\":0,\"feeAmountIncludingGst\":0.0000}},{\"disbursementArrayIndex\":1,\"disbursementFee\":{\"feeAmountExcludingGst\":0.0000,\"feeAmountGstComponent\":0,\"feeAmountIncludingGst\":0.0000}}]},\"transactionId\":1819118}"},{"id":"1f668e2d-b7ec-c5d5-bd27-462b119bafa4","name":"Token To mAccount","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"totalAmount\": 100,\n \"description\": \"Token To sign in mAccount\",\n \"printUniqueReferenceOnStatement\": true,\n \"paymentSource\": \"token\",\n \"token\": \"5ef2ef95-583b-4a29-a69d-e5c95899ba56\"\n}"},"url":"https://api.m-pay.com.au/financial/v2/transaction/execute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"430","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 06 Feb 2018 04:50:11 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"ddoizudgaujvfzcgp5ogur1m","key":"ASP.NET_SessionId"}],"responseTime":"731","body":"{\"durationMs\":645,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\",\"bpayReceipts\":[],\"callerUniqueReference\":\"f21d3330-5d2e-40a2-97d5-4c1988058a4b\",\"feeAmountExcludingGst\":0.1500,\"feeAmountGstComponent\":0.0150,\"feeAmountIncludingGst\":0.1650,\"feeBreakdown\":{\"debitFee\":{\"feeAmountExcludingGst\":0.1500,\"feeAmountGstComponent\":0.0150,\"feeAmountIncludingGst\":0.1650},\"disbursementFees\":[]},\"transactionId\":1822828}"},{"id":"210eb18f-cd55-e7dc-f17d-dc5f3ee8c3e7","name":"mWallet to mAccount","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"totalAmount\": 100,\n \"description\": \"mWallet to sign in mAccount\",\n \"printUniqueReferenceOnStatement\": true,\n \"paymentSource\": \"mWallet\",\n \"mWallet\": {\n \"token\": \"6279059700010827\",\n \"pin\": \"5555\"\n }\n}"},"url":"https://api.m-pay.com.au/financial/v2/transaction/execute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"431","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 06 Feb 2018 04:46:34 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"ddoizudgaujvfzcgp5ogur1m","key":"ASP.NET_SessionId"}],"responseTime":"1345","body":"{\"durationMs\":1155,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\",\"bpayReceipts\":[],\"callerUniqueReference\":\"d47e9502-2c53-4362-a4dc-37ed0f1c868c\",\"feeAmountExcludingGst\":0.1000,\"feeAmountGstComponent\":0.0100,\"feeAmountIncludingGst\":0.1100,\"feeBreakdown\":{\"debitFee\":{\"feeAmountExcludingGst\":0.1000,\"feeAmountGstComponent\":0.0100,\"feeAmountIncludingGst\":0.1100},\"disbursementFees\":[]},\"transactionId\":1822814}"},{"id":"222572a2-4d97-203b-f4b5-b1aa60a6ec95","name":"DirectDebit -> DirectCredit","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"totalAmount\": 100,\n \"description\": \"Entertainment Transfer\",\n \"paymentSource\": \"directDebit\",\n \"directDebit\": {\n \"bsbNumber\": \"012-140\",\n \"accountNumber\": \"1234567\",\n \"accountName\": \"Operating Account\"\n },\n \"disbursements\": [\n {\n \"disbursementMethod\": \"directCredit\",\n \"description\": \"Friday afternoon beers\",\n \"amount\": 100,\n \"toDirectCreditDetails\": {\n \"bsbNumber\": \"012-140\",\n \"accountNumber\": \"1234568\",\n \"accountName\": \"Entertainment\\n Account\"\n }\n }\n ]\n}"},"url":"https://api.m-pay.com.au/financial/v2/transaction/execute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"571","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 05 Feb 2018 06:59:42 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"ddoizudgaujvfzcgp5ogur1m","key":"ASP.NET_SessionId"}],"responseTime":"1220","body":"{\"durationMs\":731,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\",\"bpayReceipts\":[],\"callerUniqueReference\":\"d5dd6985-dafc-43de-bcd5-a61ce36a1ac0\",\"feeAmountExcludingGst\":0.3000,\"feeAmountGstComponent\":0.0300,\"feeAmountIncludingGst\":0.3300,\"feeBreakdown\":{\"debitFee\":{\"feeAmountExcludingGst\":0.1500,\"feeAmountGstComponent\":0.0150,\"feeAmountIncludingGst\":0.1650},\"disbursementFees\":[{\"disbursementArrayIndex\":0,\"disbursementFee\":{\"feeAmountExcludingGst\":0.1500,\"feeAmountGstComponent\":0.0150,\"feeAmountIncludingGst\":0.1650}}]},\"transactionId\":1819553}"},{"id":"33cf6ca3-f836-4d90-81cc-42bb718c39e0","name":"Credit Card to BPAY","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"totalAmount\": 100,\n \"description\": \"Credit-Card to BPAY\",\n \"printUniqueReferenceOnStatement\": true,\n \"paymentSource\": \"creditCard\",\n \"creditCard\": {\n \"nameOnCard\": \"Fred Smith\",\n \"cardNumber\": \"5123456789012346\",\n \"expiryMonth\": 5,\n \"expiryYear\": 21,\n \"cardValidationNumber\": \"000\"\n },\n \"mWallet\": {\n \"token\": \"6279059700010843\",\n \"pin\": \"5555\"\n },\n \"disbursements\": [\n {\n \"disbursementMethod\": \"bpay\",\n \"description\": \"Credit-Card to BPAY\",\n \"toBPayDetails\": {\n \"billerCode\": 707364,\n \"referenceNumber\": \"3322013\"\n },\n \"amount\": 100\n }\n ]\n}"},"url":"https://api.m-pay.com.au/financial/v2/transaction/execute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"657","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Fri, 16 Feb 2018 05:26:29 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"g4qfb013i2igy1ipwsopjyop","key":"ASP.NET_SessionId"}],"responseTime":"3087","body":"{\"durationMs\":3030,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\",\"bpayReceipts\":[{\"amount\":100,\"billerCode\":707364,\"receiptNumber\":145619,\"referenceNumber\":\"3322013\"}],\"callerUniqueReference\":\"2d7ff8f4-50b1-4b0e-9e00-0d88fa7df415\",\"feeAmountExcludingGst\":1.8500,\"feeAmountGstComponent\":0.1850,\"feeAmountIncludingGst\":2.0350,\"feeBreakdown\":{\"debitFee\":{\"feeAmountExcludingGst\":1.7500,\"feeAmountGstComponent\":0.1750,\"feeAmountIncludingGst\":1.9250},\"disbursementFees\":[{\"disbursementArrayIndex\":0,\"disbursementFee\":{\"feeAmountExcludingGst\":0.1000,\"feeAmountGstComponent\":0.0100,\"feeAmountIncludingGst\":0.1100}}]},\"transactionId\":1867351}"},{"id":"38da7b39-77af-fe6f-7841-4660165d193c","name":"Credit-Card -> Direct Credit","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"totalAmount\": 100,\n \"description\": \"Credit Card to Direct Credit\",\n \"printUniqueReferenceOnStatement\": true,\n \"paymentSource\": \"creditCard\",\n \"creditCard\": {\n \"nameOnCard\": \"Fred Smith\",\n \"cardNumber\": \"5123456789012346\",\n \"expiryMonth\": 5,\n \"expiryYear\": 21,\n \"cardValidationNumber\": \"000\"\n },\n \"disbursements\": [\n {\n \"disbursementMethod\": \"directCredit\",\n \"description\": \"Credit Card to Direct Credit\",\n \"toDirectCreditDetails\": {\n \"bsbNumber\": \"012-030\",\n \"accountNumber\": \"123456\",\n \"accountName\": \"XYZCourier\"\n },\n \"amount\": 100\n }\n ]\n}"},"url":"https://api.m-pay.com.au/financial/v1/transaction/execute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"bpayReceipts\": [],\n \"callerUniqueReference\": \"12345\",\n \"feeAmountExcludingGst\": 1.50,\n \"feeAmountGstComponent\": 0.15,\n \"feeAmountIncludingGst\": 1.65,\n \"feeBreakdown\": {\n \"debitFee\": {\n \"feeAmountExcludingGst\": 1.00,\n \"feeAmountGstComponent\": 0.10,\n \"feeAmountIncludingGst\": 1.10\n },\n \"disbursementFees\": [\n {\n \"disbursementArrayIndex\" : 0,\n \"disbursementFee\": {\n \"feeAmountExcludingGst\": 0.30,\n \"feeAmountGstComponent\": 0.03,\n \"feeAmountIncludingGst\": 0.33\n }\n }\n ]\n },\n \"transactionId\": 3,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\",\n \"durationMs\": 773\n}"},{"id":"5b8c11da-afde-1030-4525-af5270237ae6","name":"mWallet -> Direct Credit","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"totalAmount\": 10,\n \"description\": \"mWallet To Direct Credit\",\n \"printUniqueReferenceOnStatement\": true,\n \"paymentSource\": \"mWallet\",\n \"mWallet\": {\n \"token\": \"6279059700015487\",\n \"pin\": \"5555\"\n },\n \"disbursements\": [\n {\n \"disbursementMethod\": \"directCredit\",\n \"description\": \"mWallet To Direct Credit\",\n \"toDirectCreditDetails\": {\n \"bsbNumber\": \"012-030\",\n \"accountNumber\": \"123456\",\n \"accountName\": \"XYZCourier\"\n },\n \"amount\": 10\n }\n ]\n}"},"url":"https://api.m-pay.com.au/financial/v2/transaction/execute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"572","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 06 Feb 2018 06:20:14 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"ddoizudgaujvfzcgp5ogur1m","key":"ASP.NET_SessionId"}],"responseTime":"1177","body":"{\"durationMs\":1130,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\",\"bpayReceipts\":[],\"callerUniqueReference\":\"a775272a-4da8-4b46-a0fb-30b21a73e12e\",\"feeAmountExcludingGst\":0.2500,\"feeAmountGstComponent\":0.0250,\"feeAmountIncludingGst\":0.2750,\"feeBreakdown\":{\"debitFee\":{\"feeAmountExcludingGst\":0.1000,\"feeAmountGstComponent\":0.0100,\"feeAmountIncludingGst\":0.1100},\"disbursementFees\":[{\"disbursementArrayIndex\":0,\"disbursementFee\":{\"feeAmountExcludingGst\":0.1500,\"feeAmountGstComponent\":0.0150,\"feeAmountIncludingGst\":0.1650}}]},\"transactionId\":1823133}"},{"id":"6fa5efa8-cc17-8d4c-f762-0d638ab8b346","name":"mAccount -> mAccount","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"totalAmount\": 100,\n \"description\": \"mAccount to sign in mAccount\",\n \"paymentSource\": \"mAccount\",\n \"mAccount\": {\"token\" : \"6279059700002972\"},\n \"disbursements\": [{\n \"disbursementMethod\": \"mAccount\",\n \"description\": \"fee\",\n \"toMAccount\": \"6279059610001205\",\n \"amount\": 100\n }]\n}"},"url":"https://api.m-pay.com.au/financial/v1/transaction/execute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"durationMs\": 462,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\",\n \"bpayReceipts\": [],\n \"callerUniqueReference\": \"1234158\",\n \"feeAmountExcludingGst\": 0.8,\n \"feeAmountGstComponent\": 0.08,\n \"feeAmountIncludingGst\": 0.88,\n \"feeBreakdown\": {\n \"debitFee\": {\n \"feeAmountExcludingGst\": 0.8,\n \"feeAmountGstComponent\": 0.08,\n \"feeAmountIncludingGst\": 0.88\n },\n \"disbursementFees\": [\n {\n \"disbursementArrayIndex\": 0,\n \"disbursementFee\": {\n \"feeAmountExcludingGst\": 0,\n \"feeAmountGstComponent\": 0,\n \"feeAmountIncludingGst\": 0\n }\n }\n ]\n },\n \"transactionId\": 1117426\n}"},{"id":"7250ef37-c327-4f92-2ef2-7fdf4a23799a","name":"mAccount To mAccount","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","warning":"","disabled":false}],"body":{"mode":"raw","raw":"{\n \"totalAmount\": 100,\n \"description\": \"Principal payment Inv# 2421\",\n \"printUniqueReferenceOnStatement\": true,\n \"disbursements\": [\n {\n \"disbursementMethod\": \"mAccount\",\n \"description\": \"Principal payment Inv# 2421\",\n \"toMAccount\": \"6279059700002972\",\n \"amount\": 100\n }\n ]\n}"},"url":"https://api.m-pay.com.au/financial/v2/transaction/execute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"557","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 06 Feb 2018 02:19:59 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"ddoizudgaujvfzcgp5ogur1m","key":"ASP.NET_SessionId"}],"responseTime":"1175","body":"{\"durationMs\":1047,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\",\"bpayReceipts\":[],\"callerUniqueReference\":\"63f1a3c8-1983-4cc1-b4fa-ce7a39ae740b\",\"feeAmountExcludingGst\":0.1000,\"feeAmountGstComponent\":0.0100,\"feeAmountIncludingGst\":0.1100,\"feeBreakdown\":{\"debitFee\":{\"feeAmountExcludingGst\":0,\"feeAmountGstComponent\":0,\"feeAmountIncludingGst\":0},\"disbursementFees\":[{\"disbursementArrayIndex\":0,\"disbursementFee\":{\"feeAmountExcludingGst\":0.1000,\"feeAmountGstComponent\":0.0100,\"feeAmountIncludingGst\":0.1100}}]},\"transactionId\":1822368}"},{"id":"75a64f11-a4c3-8bb7-8f87-a32649f70a4f","name":"mWallet -> mWallet","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"totalAmount\": 100,\n \"description\": \"Loan repayment\",\n \"paymentSource\": \"mWallet\",\n \"mWallet\": {\n \"token\": \"6279059700010827\",\n \"pin\": \"5555\"\n },\n \"disbursements\": [\n {\n \"disbursementMethod\": \"mWallet\",\n \"description\": \"Payment to XYZ for loan repayment\",\n \"toMWallet\": \"6279059700010835\",\n \"amount\": 100\n }\n ]\n}"},"url":"https://api.m-pay.com.au/financial/v2/transaction/execute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"572","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 05 Feb 2018 06:39:56 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"ddoizudgaujvfzcgp5ogur1m","key":"ASP.NET_SessionId"}],"responseTime":"1409","body":"{\"durationMs\":1287,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\",\"bpayReceipts\":[],\"callerUniqueReference\":\"22ad29ef-52b0-4483-b52a-173e295b91fd\",\"feeAmountExcludingGst\":0.2000,\"feeAmountGstComponent\":0.0200,\"feeAmountIncludingGst\":0.2200,\"feeBreakdown\":{\"debitFee\":{\"feeAmountExcludingGst\":0.1000,\"feeAmountGstComponent\":0.0100,\"feeAmountIncludingGst\":0.1100},\"disbursementFees\":[{\"disbursementArrayIndex\":0,\"disbursementFee\":{\"feeAmountExcludingGst\":0.1000,\"feeAmountGstComponent\":0.0100,\"feeAmountIncludingGst\":0.1100}}]},\"transactionId\":1819490}"},{"id":"76b53643-d9e8-3a27-5763-95d83514acf3","name":"Direct Debit to mAccount","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"totalAmount\": 100,\n \"description\": \"Direct Debit to sign in mAccount\",\n \"printUniqueReferenceOnStatement\": true,\n \"paymentSource\": \"directDebit\",\n \"directDebit\": {\n \"bsbNumber\": \"012-140\",\n \"accountNumber\": \"1234567\",\n \"accountName\": \"Fee Account\"\n }\n}"},"url":"https://api.m-pay.com.au/financial/v2/transaction/execute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"431","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 06 Feb 2018 04:48:07 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"ddoizudgaujvfzcgp5ogur1m","key":"ASP.NET_SessionId"}],"responseTime":"1268","body":"{\"durationMs\":1198,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\",\"bpayReceipts\":[],\"callerUniqueReference\":\"e56199e7-fd71-4e33-a107-13a119b0dbf0\",\"feeAmountExcludingGst\":0.1500,\"feeAmountGstComponent\":0.0150,\"feeAmountIncludingGst\":0.1650,\"feeBreakdown\":{\"debitFee\":{\"feeAmountExcludingGst\":0.1500,\"feeAmountGstComponent\":0.0150,\"feeAmountIncludingGst\":0.1650},\"disbursementFees\":[]},\"transactionId\":1822818}"},{"id":"97888108-1b86-0636-673c-08dcb85593bd","name":"mAccount to Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"totalAmount\": 100,\n \"description\": \"sign in mAccount to Token\",\n \"printUniqueReferenceOnStatement\": true,\n \"disbursements\": [\n {\t\n \"disbursementMethod\": \"token\",\n \"descriptn\": \"sign in mAccount to Token\",\n \"toToken\": \"5ef2ef95-583b-4a29-a69d-e5c95899ba56\",\n \"amount\": 100\n }\n ]\n}"},"url":"https://api.m-pay.com.au/financial/v2/transaction/execute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"557","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 06 Feb 2018 04:14:10 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"ddoizudgaujvfzcgp5ogur1m","key":"ASP.NET_SessionId"}],"responseTime":"1979","body":"{\"durationMs\":1922,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\",\"bpayReceipts\":[],\"callerUniqueReference\":\"6b0d1949-cead-4498-b845-7b00199856a4\",\"feeAmountExcludingGst\":0.1500,\"feeAmountGstComponent\":0.0150,\"feeAmountIncludingGst\":0.1650,\"feeBreakdown\":{\"debitFee\":{\"feeAmountExcludingGst\":0,\"feeAmountGstComponent\":0,\"feeAmountIncludingGst\":0},\"disbursementFees\":[{\"disbursementArrayIndex\":0,\"disbursementFee\":{\"feeAmountExcludingGst\":0.1500,\"feeAmountGstComponent\":0.0150,\"feeAmountIncludingGst\":0.1650}}]},\"transactionId\":1822642}"},{"id":"bdc66a35-f9eb-7865-e411-7ada9c390559","name":"Credit-Card to mAccount","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","warning":""}],"body":{"mode":"raw","raw":"{\n \"totalAmount\": 100,\n \"description\": \"Principal payment Inv# 2421\",\n \"printUniqueReferenceOnStatement\" : true, \n \"paymentSource\": \"creditCard\",\n \"creditCard\": {\n \"nameOnCard\": \"Fred Smith\",\n \"cardNumber\": \"4987654321098769\",\n \"expiryMonth\": 5,\n \"expiryYear\": 21,\n \"cardValidationNumber\": \"000\"\n }\n}"},"url":"https://api.m-pay.com.au/financial/v2/transaction/execute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"431","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 06 Feb 2018 04:37:38 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"ddoizudgaujvfzcgp5ogur1m","key":"ASP.NET_SessionId"}],"responseTime":"2553","body":"{\"durationMs\":2281,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\",\"bpayReceipts\":[],\"callerUniqueReference\":\"4e0088f2-7577-4460-8769-4c2979c9409d\",\"feeAmountExcludingGst\":1.7500,\"feeAmountGstComponent\":0.1750,\"feeAmountIncludingGst\":1.9250,\"feeBreakdown\":{\"debitFee\":{\"feeAmountExcludingGst\":1.7500,\"feeAmountGstComponent\":0.1750,\"feeAmountIncludingGst\":1.9250},\"disbursementFees\":[]},\"transactionId\":1822780}"},{"id":"dfdd0c22-5b56-ede4-f687-fac58f8301ad","name":"mAccount to mAccount","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","warning":"","disabled":false}],"body":{"mode":"raw","raw":"{\n \"totalAmount\": 100,\n \"description\": \"Principal payment Inv# 2421\",\n \"paymentSource\": \"mAccount\",\n \"mAccount\": {\n \"token\": \"6279059708612806\"\n }\n}"},"url":"https://api.m-pay.com.au/financial/v2/transaction/execute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"400","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Tue, 06 Feb 2018 04:44:27 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"ddoizudgaujvfzcgp5ogur1m","key":"ASP.NET_SessionId"}],"responseTime":"751","body":"{\"durationMs\":667,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\",\"bpayReceipts\":[],\"callerUniqueReference\":\"ccc98931-6fc2-42cf-88ca-9f1a48a6300c\",\"feeAmountExcludingGst\":0,\"feeAmountGstComponent\":0,\"feeAmountIncludingGst\":0,\"feeBreakdown\":{\"debitFee\":{\"feeAmountExcludingGst\":0,\"feeAmountGstComponent\":0,\"feeAmountIncludingGst\":0},\"disbursementFees\":[]},\"transactionId\":1822808}"},{"id":"f5266405-8603-39b6-0ea9-b107f7d41879","name":"Credit-Card -> mWallet","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"totalAmount\": 100,\n \"description\": \"Credit Card to mWallet\",\n \"printUniqueReferenceOnStatement\": true,\n \"paymentSource\": \"creditCard\",\n \"creditCard\": {\n \"nameOnCard\": \"Fred Smith\",\n \"cardNumber\": \"345678901234564\",\n \"expiryMonth\": 5,\n \"expiryYear\": 21,\n \"cardValidationNumber\": \"0000\"\n },\n \"disbursements\": [\n {\n \"disbursementMethod\": \"mWallet\",\n \"toMWallet\": \"6279059700010827\",\n \"amount\": 100\n }\n ]\n}"},"url":"https://api.m-pay.com.au/financial/v1/transaction/execute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"bpayReceipts\": [],\n \"callerUniqueReference\": \"12345\",\n \"feeAmountExcludingGst\": 1.20,\n \"feeAmountGstComponent\": 0.12,\n \"feeAmountIncludingGst\": 1.32,\n \"feeBreakdown\": {\n \"debitFee\": {\n \"feeAmountExcludingGst\": 1.20,\n \"feeAmountGstComponent\": 0.12,\n \"feeAmountIncludingGst\": 1.32\n },\n \"disbursementFees\": [\n {\n \"disbursementArrayIndex\": 0,\n \"disbursementFee\": {\n \"feeAmountExcludingGst\":0.00,\n \"feeAmountGstComponent\":0.00,\n \"feeAmountIncludingGst\":0.00\n }\n }\n ]\n }, \n \"transactionId\": 3,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\",\n \"durationMs\": 693\n}"}],"_postman_id":"fecd976f-101f-36b2-95ca-b5b37082fc04"},{"name":"/financial/v2/transaction/validate","id":"8b77bc29-4fea-fd32-2d56-fd1653638822","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"uniqueReference\": \"Reference9281452\",\n \"totalAmount\": \"10\",\n \"printUniqueReferenceOnStatement\": true,\n \"description\": \"SignInmAccount to DirectCredit\",\n \"disbursements\": [\n {\n \"disbursementMethod\": \"directCredit\",\n \"description\": \"SignInmAccount to DirectCredit\",\n \"toDirectCreditDetails\": {\n \"bsbNumber\": \"062-205\",\n \"accountNumber\": \"12354983\",\n \"accountName\": \"Monoova\"\n },\n \"amount\": \"10\"\n }\n ]\n}"},"url":"https://api.m-pay.com.au/financial/v2/transaction/validate","description":"

The purpose of the execute API is to debit a source for funds then distribute those funds to one or more supplied disbursement accounts.

You can use the Transaction/validate API to determine if the parameters are correct.

The body is the same as financial/v1/transaction/execute.

The callerUniqueReference will be reusable after the validate call is complete

\n","urlObject":{"protocol":"https","path":["financial","v2","transaction","validate"],"host":["api","m-pay","com","au"],"query":[],"variable":[]}},"response":[{"id":"8589a9a2-76f1-b82e-7413-212c14f6f721","name":"Credit Card to mWallet","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"uniqueReference\": \"12345\",\n \"totalAmount\": 100,\n \"description\": \"Flower Arrangement. Inv# 2421\",\n \"printUniqueReferenceOnStatement\": true,\n \"paymentSource\": \"creditCard\",\n \"creditCard\": {\n \"nameOnCard\": \"Fred Smith\",\n \"cardNumber\": \"345678901234564\",\n \"expiryMonth\": 5,\n \"expiryYear\": 17,\n \"cardValidationNumber\": \"0000\"\n },\n \"disbursements\": [\n {\n \"disbursementMethod\": \"mWallet\",\n \"toMWallet\": \"6279059700010827\",\n \"amount\": 100\n }\n ]\n}"},"url":"https://api.m-pay.com.au/financial/v1/transaction/validate"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":"0","body":"{\n \"bpayReceipts\": [],\n \"callerUniqueReference\": \"12345\",\n \"feeAmountExcludingGst\": 1.20,\n \"feeAmountGstComponent\": 0.12,\n \"feeAmountIncludingGst\": 1.32,\n \"feeBreakdown\": {\n \"debitFee\": {\n \"feeAmountExcludingGst\": 1.20,\n \"feeAmountGstComponent\": 0.12,\n \"feeAmountIncludingGst\": 1.32\n },\n \"disbursementFees\": [\n {\n \"disbursementArrayIndex\": 0,\n \"disbursementFee\": {\n \"feeAmountExcludingGst\":0.00,\n \"feeAmountGstComponent\":0.00,\n \"feeAmountIncludingGst\":0.00\n }\n }\n ]\n }, \n \"transactionId\": 3,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\",\n \"durationMs\": 693\n}"}],"_postman_id":"8b77bc29-4fea-fd32-2d56-fd1653638822"},{"name":"/financial/v2/status/{uniquereference}","id":"de93f216-798e-4771-3e2f-ee78271f8e2a","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.m-pay.com.au/financial/v2/status/{{uniqueReference}}","description":"

Returns the status of a previous transaction; this is important because a directDebit transaction may be dishonoured up to 10 days after the transaction was executed.

\n","urlObject":{"protocol":"https","path":["financial","v2","status","{{uniqueReference}}"],"host":["api","m-pay","com","au"],"query":[],"variable":[]}},"response":[{"id":"cf98a374-6517-27b4-7cb2-d0c6dba2b956","name":"A 'complete' transaction","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic NjI3OTA1OTYxMDAwMTIwNTokTVBAeW1lbnRzMjk2OA==","disabled":true}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.m-pay.com.au/financial/v1/status/2421"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"137","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 26 Jun 2017 05:31:19 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 15:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"5w0iozaxzrpeevvl0kxahauq","key":"ASP.NET_SessionId"}],"responseTime":"1542","body":"{\"durationMs\":46,\"status\":\"Ok\",\"statusDescription\":\"Flower Arrangement. Inv# 2421\",\"dishonouredDate\":null,\"transactionStatus\":\"Complete\"}"},{"id":"efe46fbc-d16c-71b0-99ac-9b4c23d7fc24","name":"A 'dishonored' transaction","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.m-pay.com.au/financial/v1/status/2422"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"dishonouredDate\" : \"2016-03-07\",\n \"transactionStatus\" : \"Dishonoured\",\n \"status\" : \"Ok\",\n \"statusDescription\" : \"Operation completed successfully\",\n \"durationMs\" : 92\n}"}],"_postman_id":"de93f216-798e-4771-3e2f-ee78271f8e2a"},{"name":"/financial/v2/status/{daterange}","id":"6fd3f6f7-71af-9901-8296-467a9e8bd2b1","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.m-pay.com.au/financial/v2/status/{{StartDate}}/{{EndDate}}","description":"

To request bulk transaction status information a daterange can be used

Date format is YYYY-MM-DD

\n","urlObject":{"protocol":"https","path":["financial","v2","status","{{StartDate}}","{{EndDate}}"],"host":["api","m-pay","com","au"],"query":[],"variable":[]}},"response":[{"id":"b42f8633-de44-a3f5-1484-ebdf8d336089","name":"Daterange status check","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.m-pay.com.au/financial/v1/status/2018-01-30/2018-02-08"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\r\n \"durationMs\": 227,\r\n \"status\": \"Ok\",\r\n \"statusDescription\": \"Operation completed successfully\",\r\n \"statuses\": [\r\n {\r\n \"dishonouredDate\": null,\r\n \"statusDescription\": \"Principal payment Inv# 2421\",\r\n \"transactionStatus\": \"Complete\",\r\n \"uniqueReference\": \"3b01fa6b-f5a7-4f7a-8f1f-9af5a006c983\"\r\n }\r\n ]\r\n}\r\n"}],"_postman_id":"6fd3f6f7-71af-9901-8296-467a9e8bd2b1"},{"name":"/financial/v2/refund/validate","id":"7d1b45bc-8517-7742-cf31-391b6aaca682","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"uniqueReference\" : \"Ref-748382918\",\n\t\"refundAmount\": \"5\",\n\t\"description\": \"Test refund description\",\n\t\"originalTransactionId\": \"997201757\"\n}"},"url":"https://api.m-pay.com.au/financial/v2/refund/validate","description":"

The purpose of the financial/v1/refund/execute API is to refund funds back on a Credit-Card that was used in a previousfinancial/v1/transaction/execute API call.

Funds are debited from the Sign-In mAccount then refunded back to the Credit-Card. It is your responsibility to ensure there are sufficient funds in your mAccount.

Body is same as financial/v1/transaction/execute. The callerUniqueReference will be reusable after the validate call is complete.

\n","urlObject":{"protocol":"https","path":["financial","v2","refund","validate"],"host":["api","m-pay","com","au"],"query":[],"variable":[]}},"response":[{"id":"3730858e-fc2d-f6a0-10b6-68beab9c83c3","name":"Basic Refund Validation","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"uniqueReference\": \"Refund-00001\",\n\t\"refundAmount\": 25,\n\t\"description\": \"test refund description\",\n\t\"originalTransactionId\": 155\n}"},"url":"https://api.m-pay.com.au/financial/v1/refund/validate"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":"0","body":"{\n \"callerUniqueReference\": \"Refund-00001\",\n \"feeAmountExcludingGst\": 0.20,\n \"feeAmountGstComponent\": 0.02,\n \"feeAmountIncludingGst\": 0.22,\n \"transactionId\": 326,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\",\n \"durationMs\": 793\n}"}],"_postman_id":"7d1b45bc-8517-7742-cf31-391b6aaca682"},{"name":"/financial/v2/refund/execute","id":"d8544e5e-4a4c-d3ed-1ad1-bfade044d361","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"uniqueReference\" : \"Ref-748382918\",\n\t\"refundAmount\": \"5\",\n\t\"description\": \"Test refund description\",\n\t\"originalTransactionId\": \"997201757\"\n}"},"url":"https://api.m-pay.com.au/financial/v2/refund/execute","description":"

The purpose of the financial/v1/refund/execute API is to refund funds back on a Credit-Card that was used in a previousfinancial/v1/transaction/execute API call.

Funds are debited from the Sign-In mAccount then refunded back to the Credit-Card. It is your responsibility to ensure there are sufficient funds in your mAccount.

\n","urlObject":{"protocol":"https","path":["financial","v2","refund","execute"],"host":["api","m-pay","com","au"],"query":[],"variable":[]}},"response":[{"id":"7b889815-8d38-d651-3baf-ac873319e063","name":"Basic Refund","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"uniqueReference\": \"Refund-00001\",\n\t\"refundAmount\": 25,\n\t\"description\": \"test refund description\",\n\t\"originalTransactionId\": 155\n}"},"url":"https://api.m-pay.com.au/financial/v1/refund/execute"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"callerUniqueReference\": \"Refund-00001\",\n \"feeAmountExcludingGst\": 0.20,\n \"feeAmountGstComponent\": 0.02,\n \"feeAmountIncludingGst\": 0.22,\n \"transactionId\": 326,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\",\n \"durationMs\": 793\n}"}],"_postman_id":"d8544e5e-4a4c-d3ed-1ad1-bfade044d361"}],"id":"fd555cf6-ce8c-3bba-2558-caa7061b49b5","description":"

Overview

The financial APIs provide the core financial functionality such as refunds, transactions and status.

You may Debit one of the following sources:

mWallet
mAccount
Australian Bank Account
Credit-Card (Refunds are supported, including partial)

You may Credit one of the following sources:

mWallet
mAccount
Australian Bank Account
BPay

Objects

AustralianBankAccount

{\n  \"bsbNumber\":      string,\n  \"accountNumber\":  string,\n  \"accountName\":    string\n}\n

Provides comprehensive biller information that may be required for further complex validation.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
*bsbNumber	string	7	This is the Bank-State-Branch number. Format is 3-3 digits. Eg.’ 000-000’
*accountNumber	string	9	This is the bank accounts number. Minimum length is 4
*accountName	string	32	This is the name of the account. Minimum length is 5

*Required Field

BpayDetails

{\n  \"billerCode\":       number,\n  \"referenceNumber\":  string\n}\n

Provides details of an Australian Bank Account (ABA). An Australian Bank Account can be used for Debit or Credit transactions.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
*billerCode	number		This is the BPAY Biller Code
*referenceNumber	string	20	This is the BPAY Reference Number. It’s really a number although leading ‘0’ are significant.

*Required Field

BpayDisbursementItem

{\n  \"disbursementMethod\": string,\n  \"amount\":             number,\n  \"description\":        string,\n  \"toBpayDetails\":      BpayDetails\n}\n\n

Provides payment details for a disbursement to a BPAY biller.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
*disbursementMethod	string		This must be \"bpay\"
*amount	number		This is the amount of funds to be paid
description	string	500	An optional description of the disbursement item
*toBpayDetails	BpayDetails		See BpayDetails class

*Required Field

BpayReceiptItem

{\n  \"receiptNumber\":    number,\n  \"billerCode\":       number,\n  \"referenceNumber\":  string,\n  \"amount\":           number\n}\n

Contains a BPAY receipt number and details for each BPAY disbursement. An array of these items is returned from the Execute API for each BPAY disbursement.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
receiptNumber	number	This is the unique receipt number issue by the Platform for the BPAY transaction.
billerCode	number	This is the BPAY Biller Code
referenceNumber	string	This is the BPAY Reference Number
amount	number	The amount that was disbursed

CreditCardDetails

{\n  \"nameOnCard\":           string,\n  \"cardNumber\":           string,\n  \"expiryMonth\":          number,\n  \"expiryYear\":           number,\n  \"cardValidationNumber\": string\n}\n

Provides details about the Credit-Card to be debited from.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
*nameOnCard	string	100	This is the name on the Credit-Card.
*cardNumber	string	16	This is the Credit-Cards number. This field must be numeric only.
*expiryMonth	number		This is the expiry month of the Credit-Card. Must be between 1 and 12
*expiryYear	number		This is the expiry year of the Credit-Card. Can be either a 2 or 4 digit year
*cardValidationNumber	string	4	This is the Credit-Cards validation number. Must be a 4 or 3 digit number depending on the card type.
*Required Field

DirectCreditDisbursementItem

{\n  \"disbursementMethod\":     string,\n  \"amount\":                 number,\n  \"description\":            string,\n  \"toDirectCreditDetails\":  AustralianBankAccount\n}\n

Provides payment details for a disbursement to an Australian Bank Account.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
*disbursementMethod	string		This must be \"directCredit\"
*amount	number		This is the amount of funds to be paid
description	string	500	An optional description of the disbursement item
*toDirectCreditDetails	AustralianBankAccount		See AustralianBankAccount class
*Required Field

DisbursementFeeItem

{\n  \"disbursementArrayIndex\": number,\n  \"disbursementFee\":        FeeDetailItem\n}\n\n

Contains detailed fee information for each disbursement

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
disbursementArrayIndex	number	This is the index into the Disbursement array that was passed to either financials/v1/transaction/validate or financials/v1/transaction/execute
disbursementFee	FeeDetailItem	This is the fee details applied to the disbursement at index disbursementArrayIndex. See FeeDetailItem section.

FeeBreakdownDetail

{\n  \"debitFee\":         FeeDetailItem,\n  \"disbursementFees\": [\n                        DisbursementFeeItem\n                      ]\n}\n

Returned in both the financials/v1/transaction/validate and financials/v2/transaction/execute APIs it contains details of the fees charged against the Sign-In Account.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
debitFee	FeeDetailItem	Returns the fee details for the Debit transaction. See FeeDetailItem section
disbursementFees	[DisbursementFeeItem]	Returns an array of disbursementFee, which is the fee details for each disbursement. See DisbursementFeeItem section.

FeeDetailItem

{\n  \"feeAmountExcludingGst\": number,\n  \"feeAmountGstComponent\": number,\n  \"feeAmountIncludingGst\": number\n}\n

Contains the breakdown of an individual fee into three parts:

Fee amount excluding GST
GST component
Fee amount including GST

All three fee amounts are accurate to 4 decimal places.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
feeAmountExcludingGst	number	The fee amount excluding GST
feeAmountGstComponent	number	The GST component of the fee
feeAmountIncludingGst	number	The fee amount including GST

MAccountDetails

{\n  \"token\": string\n}\n

Provides details about the mAccount you wish to move funds from or through.

Note:

Another structure called mAccountDetails exists in the mAccount/v1 API to retrieve extended details of the mAccount and this should not be confused by this structure which is used only in the financial/v2 APIs.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
*token	number	16	mAccount 16-Digit account number
*Required Field

","event":[{"listen":"prerequest","script":{"id":"acf86138-1fbf-4f51-8d15-0c87e9d0563c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6b5a16ba-611e-42f0-91fc-54fdca584e28","type":"text/javascript","exec":[""]}}],"_postman_id":"fd555cf6-ce8c-3bba-2558-caa7061b49b5","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]},"isInherited":true,"source":{"_postman_id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","name":"Moneytech Payments Platform","type":"collection"}}},{"name":"BPAY","item":[{"name":"/bpay/v1/validate","id":"8e735b04-a8e1-9aba-1a16-f86c711fe650","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.m-pay.com.au/bpay/v1/validate/{{billerCode}}?custRef={{customerReference}}&amount={{amount}}","description":"

This API validates the BPAY Biller Code and optionally the BPAY Customer Reference Number and Amount. For a complete BPAY validation the BPAY Biller Code, BPAY Customer Reference Number and Amount must be supplied.

When fully validated a BPAY financial transaction should be made as soon as practicable as some BPAY combinations are date sensitive. BPAY validation uses the BPAY subsystem error codes.

\n","urlObject":{"protocol":"https","path":["bpay","v1","validate","{{billerCode}}"],"host":["api","m-pay","com","au"],"query":[{"description":{"content":"

BPAY Customer Reference Number

\n","type":"text/plain"},"key":"custRef","value":"{{customerReference}}"},{"description":{"content":"

Amount to be paid

\n","type":"text/plain"},"key":"amount","value":"{{amount}}"}],"variable":[]}},"response":[{"id":"fd03ca20-337d-0978-bbab-66b1c3e67227","name":"Basic Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic NjI3OTA1OTYxMDAwMTIwNTokTVBAeW1lbnRzMjk2OA==","disabled":true}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.m-pay.com.au/bpay/v1/validate/857763?custRef=6279059700000505&amount=100.75","protocol":"https","host":["api","m-pay","com","au"],"path":["bpay","v1","validate","857763"],"query":[{"key":"custRef","value":"6279059700000505","description":"BPAY Customer Reference Number"},{"key":"amount","value":"100.75","description":"Amount to be paid"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"299","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 26 Jun 2017 05:01:11 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 11:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"5w0iozaxzrpeevvl0kxahauq","key":"ASP.NET_SessionId"}],"responseTime":"3935","body":"{\"durationMs\":254,\"status\":\"Ok\",\"statusDescription\":\"Validation has passed\",\"validation\":{\"amount\":\"100.75\",\"billerCode\":\"857763\",\"billerName\":\"MONEYTECH FINANCE PTY LTD\",\"customerReferenceNumber\":\"6279059700000505\",\"isVariableCrn\":false,\"maximumPaymentAmount\":50000,\"minimumPaymentAmount\":10.0000}}"}],"_postman_id":"8e735b04-a8e1-9aba-1a16-f86c711fe650"},{"name":"/bpay/v1/biller","id":"a1fd2d77-8150-14d0-ddda-7f4ee875c1dc","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.m-pay.com.au/bpay/v1/biller/{{billerCode}}","description":"

This API returns extended information for the BPAY biller.

Status will be “UnknownBillerCode” if Biller Code is invalid.

\n","urlObject":{"protocol":"https","path":["bpay","v1","biller","{{billerCode}}"],"host":["api","m-pay","com","au"],"query":[],"variable":[]}},"response":[{"id":"e66f10a2-05e2-b45d-0451-31fddc5b7cba","name":"Basic Example","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.m-pay.com.au/bpay/v1/biller/857763"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":"0","body":"{\n \"durationMs\":10,\n \"status\":\"Ok\",\n \"statusDescription\":\"Operation completed successfully\",\n \"biller\":\n {\n \"acceptedPaymentMethods\":\"1\",\n \"activationDate\":\"2013-05-29T00:00:00\",\n \"billerCode\":\"857763\",\n \"billerLongName\":\"MONEYTECH FINANCE PTY LTD\",\n \"billerShortName\":\"MONEYTECH\",\n \"checkDigitRuleName\":\"\",\n \"crnValidationRuleName\":\"\",\n \"deactivationDate\":\"\",\n \"fixedDigits\":\"627905 \",\n \"isVariableCrn\":false,\n \"lengthMask\":\" Y \",\n \"maxPaymentAmount\":50000,\n \"minPaymentAmount\":10.0000\n }\n}"}],"_postman_id":"a1fd2d77-8150-14d0-ddda-7f4ee875c1dc"},{"name":"/bpay/v1/billers","id":"68ca023e-4546-aaf3-c3e9-f998c23c05a9","request":{"method":"GET","header":[],"url":"https://api.m-pay.com.au/bpay/v1/billers?search={{search}}&skip={{skip}}&take={{take}}","description":"

This API returns an array of BPAY billers matched to the case insensitive search string. The system matches on the billerLongName and billerShortName.

Use skip and take to page through result set. Skip and take will be changed back to their defaults if they are over-range. Status will be “UnknownBillerCode” if there are no matches.

Text string to search for

\n","type":"text/plain"},"key":"search","value":"{{search}}"},{"description":{"content":"

Number of items to skip over (used to implement paging). Default is 0

\n","type":"text/plain"},"key":"skip","value":"{{skip}}"},{"description":{"content":"

The maximum number of records to return. Default is 50

\n","type":"text/plain"},"key":"take","value":"{{take}}"}],"variable":[]}},"response":[{"id":"d3d713ab-909f-e599-c6d8-34b83370e448","name":"Basic Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic NjI3OTA1OTYxMDAwMTIwNTokTVBAeW1lbnRzMjk2OA==","disabled":true}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.m-pay.com.au/bpay/v1/billers?search=pty ltd&skip=0&take=2","protocol":"https","host":["api","m-pay","com","au"],"path":["bpay","v1","billers"],"query":[{"key":"search","value":"pty ltd","description":"Text string to search for"},{"key":"skip","value":"0","description":"Number of items to skip over (used to implement paging). Default is 0"},{"key":"take","value":"2","description":"The maximum number of records to return. Default is 50"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"980","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 26 Jun 2017 04:56:11 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 08:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"5w0iozaxzrpeevvl0kxahauq","key":"ASP.NET_SessionId"}],"responseTime":"3364","body":"{\"durationMs\":431,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\",\"billers\":[{\"acceptedPaymentMethods\":\"1\",\"activationDate\":\"2011-07-11T00:00:00\",\"billerCode\":\"1040\",\"billerLongName\":\"GMK Partners Pty Ltd\",\"billerShortName\":\"GMK Partners Pty Ltd\",\"checkDigitRuleName\":\"\",\"crnValidationRuleName\":\"\",\"deactivationDate\":\"2017-03-10T00:00:00\",\"fixedDigits\":\" \",\"isVariableCrn\":false,\"lengthMask\":\" Y Y \",\"maxPaymentAmount\":50000,\"minPaymentAmount\":1.0000},{\"acceptedPaymentMethods\":\"1\",\"activationDate\":\"2011-07-11T00:00:00\",\"billerCode\":\"1073\",\"billerLongName\":\"GMK Partners Auditor Pty Ltd\",\"billerShortName\":\"GMK Partners Auditor\",\"checkDigitRuleName\":\"\",\"crnValidationRuleName\":\"\",\"deactivationDate\":\"2017-03-13T00:00:00\",\"fixedDigits\":\" \",\"isVariableCrn\":false,\"lengthMask\":\" Y Y \",\"maxPaymentAmount\":50000,\"minPaymentAmount\":1.0000}],\"search\":\"pty ltd\",\"skip\":0,\"take\":2,\"totalCount\":5490}"}],"_postman_id":"68ca023e-4546-aaf3-c3e9-f998c23c05a9"},{"name":"/bpay/v1/history","id":"89ba2b9b-5f6a-1433-a9b8-9755821bf6c8","request":{"method":"GET","header":[],"url":"https://api.m-pay.com.au/bpay/v1/history/{{mWalletAccountNumber}}?take={{take}}","description":"

This API returns the mWallets history of BPAY payments.

The returned history list is sorted by the count property of the BPAYHistoryItem descending.

The maximum number of records to return. Default is 50

\n","type":"text/plain"},"key":"take","value":"{{take}}"}],"variable":[]}},"response":[{"id":"369afdbb-71de-b694-00fe-3b4b5f5261bb","name":"Basic Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","name":"Authorization","value":"Basic NjI3OTA1OTYxMDAwMTIwNTokTVBAeW1lbnRzMjk2OA=="}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.m-pay.com.au/bpay/v1/history/6279059700022400?take=3","protocol":"https","host":["api","m-pay","com","au"],"path":["bpay","v1","history","6279059700022400"],"query":[{"key":"take","value":"3","description":"The maximum number of records to return. Default is 50"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"119","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 26 Jun 2017 04:58:42 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 10:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"5w0iozaxzrpeevvl0kxahauq","key":"ASP.NET_SessionId"}],"responseTime":"5964","body":"{\n \"history\": [\n {\n \"billerCode\": \"23796\",\n \"customerReferenceNumber\": \"2000046986210\",\n \"billerName\": \"TELSTRA CORPORATION LTD\",\n \"count\": 27\n },\n {\n \"billerCode\": \"1552\",\n \"customerReferenceNumber\": \"155907980\",\n \"billerName\": \"ERGON ENERGY QUEENSLAND P/L\",\n \"count\": 24\n },\n {\n \"billerCode\": \"747337\",\n \"customerReferenceNumber\": \"000000506479540\",\n \"billerName\": \"HOUSING AND PUBLIC WORKS\",\n \"count\": 22\n }\n ],\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\",\n \"durationMs\": 461\n}"}],"_postman_id":"89ba2b9b-5f6a-1433-a9b8-9755821bf6c8"}],"id":"22f94c39-b0ad-231f-3129-2554af09f551","description":"

Overview

The BPAY APIs do not perform any financial transactions and are used to validate BPAY information that is used in the financial/v2/transaction/ execute API. The financial/v2/transaction/validate APIs also validates BPAY information using the same sub-system as documented in this section before performing any financial transactions.

Important Notes:

By design, BPAY validation can be time sensitive. If you cache valid BPAY information for later use, it may become invalid due to time expiry.
By design, BPAY validation can be amount sensitive. If you cache valid BPAY information for later use and change the amount to pay then this could be invalid.
BPAY validation should be performed immediately before calling the financial/v2/transaction/execute API to perform the bill payment. You have the option of calling financial/v2/transaction/validate (The first validation error will be returned which may not be a BPAY error)

Objects

BPAYBiller

{\n  \"billerCode\":             string,\n  \"billerLongName\":         string,\n  \"billerShortName\":        string,\n  \"acceptedPaymentMethods\": string,\n  \"activationDate\":         string,\n  \"deactivationDate\":       string,\n  \"minPaymentAmount\":       number,\n  \"maxPaymentAmount\":       number,\n  \"crnValidationRuleName\":  string,\n  \"checkDigitRuleName\":     string,\n  \"lengthMask\":             string,\n  \"fixedDigits\":            string,\n  \"isVariableCrn\":          string\n}\n

Provides comprehensive biller information that may be required for further complex validation.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
billerCode	string	10	This is the BPAY biller code that was requested. billerCode must be numeric
billerLongName	string	50	A long description of the biller name
billerShortName	string	20	A short description of the biller name
acceptedPaymentMethods	string		Always set to “1”. Field reserved for future expansion.
activationDate	string		Date this biller was activated for BPAY. ISO 8601 date format with time set to 00:00:00. Note that Timezone is suppressed. The default Timezone is Sydney local time.
deactivationDate	string		Date this biller was deactivated for BPAY. ISO 8601 date format with time set to 00:00:00 or an empty string if not deactivated. Note that Timezone is suppressed. The default Timezone is Sydney local time.
minPaymentAmount	number		This is the minimum amount that the BPAY biller associated with the billerCode accepts for bill payment.
maximumPaymentAmount	number		This is the maximum amount that the BPAY biller associated with the billerCode accepts for bill payment.
crnValidationRuleName	string		For internal use only. Set to an empty string.
checkDigitRuleName	string		For internal use only. Set to an empty string.
lengthMask	string	20	A mask in which the position of each ‘Y’ character indicates each valid length that the reference number can take. At least one ‘Y’ character will be present.
fixedDigits	string	20	This describes which, if any, fixed digits that are standard in the BPAY Customer Reference Number.
isVariableCrn	boolean		Indicates whether BPAY Customer Reference Numbers (CRN) for this biller changes for each individual customer’s bill or do they remain the same. Non variable CRNs can be stored and used later, however they must always be validated as part of paying a bill via the gateway. Variable CRNs should not be stored as they are incorrect for subsequent bills.

BPAYBillerList

{\n  \"billers\":    [\n                  BPAYBiller\n                ],\n  \"search\":     string,\n  \"totalCount\": number,\n  \"skip\":       number,\n  \"take\":       number\n}\n

Provides an array of BPAYBiller classes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
billers	[BPAYBillers]	See BPAYBiller class.
search	string	The search string.
totalCount	number	The total number of BPAYBiller’s that match the search criteria.
skip	number	The actual number of records skipped.
take	number	The number of records that were requested.

BPAYHistoryItem

{\n  \"billerCode\":               string,\n  \"customerReferenceNumber\":  string,\n  \"billerName\":               string,\n  \"count\":                    number\n}\n

Contains previous BPAY payments when requesting a history list for an mWallet.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
billerCode	string	BPAY Biller code
customerReferenceNumber	string	BPAY Customer Reference Number. If this field is empty this denotes that the customerReferenceNumber is variable for each bill and should not be reused.
billerName	string	Long form of the BPAY Biller Name
count	number	The number of usages of these details that the mWallet has succeeded in paying previously.

BPAYValidation

{\n  \"billerCode\":               string,\n  \"customerReferenceNumber\":  string,\n  \"amount\":                   string,\n  \"billerName\":               string,\n  \"minimumPaymentAmount\":     number,\n  \"maximumPaymentAmount\":     number\n}\n\n

This is the result of a successful completion of a BPAY validation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
billerCode	string	10	This is the BPAY biller code that was used to validate. billerCode must be numeric.
customerReferenceNumber	string	20	This is the BPAY customer reference number that was used to validate. customerReferenceNumber must be numeric.
amount	string	13	This is the amount that was used to validate. The maximum value of the field is $9999999999.99 however BPAY Billers will generally restrict the maximum value accepted for bill payment.
isVariableCrn	boolean		Indicates whether BPAY Customer Reference Numbers (CRN) for this biller change for each individual customer’s bill or do they remain the same. Non variable CRNs can be stored and used later, however they must always be validated as part of paying a bill via the gateway. Variable CRNs should not be stored as they are incorrect for subsequent bills.
billerName	string	50	This is the BPAY biller long name associated with the billerCode.
minimumPaymentAmount	number		This is the minimum amount that the BPAY biller associated with the billerCode accepts for bill payment.
maximumPaymentAmount	number		This is the maximum amount that the BPAY biller associated with the billerCode accepts for bill payment.

","event":[{"listen":"prerequest","script":{"id":"ab21bdcc-d708-4589-9d40-8962281c7172","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d25d04dd-baaa-426b-9d79-850f20280461","type":"text/javascript","exec":[""]}}],"_postman_id":"22f94c39-b0ad-231f-3129-2554af09f551","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]},"isInherited":true,"source":{"_postman_id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","name":"Moneytech Payments Platform","type":"collection"}}},{"name":"Verify","item":[{"name":"/verify/v1/aba/initiate","id":"96db690a-8e37-7513-fe4e-7bedfc377ada","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic NjI3OTA1OTcwMDAwMjcwOTokTVBAeW1lbnRzODMwMQ=="}],"body":{"mode":"raw","raw":"{\"bsb\":\"062-002\",\"bankAccountNumber\":\"123456789\",\"bankAccountTitle\":\"MPayments Retail\",\"remitter\":\"MPRetail\",\"verificationIdentifier\":\"MP Retail Account\",\"hasDDAuthority\":\"True\"}"},"url":"https://api.m-pay.com.au/verify/v1/aba/initiate","description":"

Inititiates a verification transaction against a designated bank account

\n","urlObject":{"protocol":"https","path":["verify","v1","aba","initiate"],"host":["api","m-pay","com","au"],"query":[],"variable":[]}},"response":[{"id":"bb04afbf-ea71-22c6-3861-99a8a2306561","name":"Basic Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"bsb\": \"062-002\",\n \"bankAccountNumber\": \"012345678\",\n \"bankAccountTitle\": \"MPayments Retail\",\n \"remitter\": \"MPRetail\",\n \"verificationIdentifier\": \"MP Retail Account\",\n \"hasDDAuthority\": \"True\"\n}"},"url":"https://api.m-pay.com.au/verify/v1/aba/initiate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"durationMs\": 239,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\",\n \"feeAmountExGst\": 0.5,\n \"feeAmountGstComp\": 0.05,\n \"feeAmountIncGst\": 0.55,\n \"token\": \"7a8f4897-02ee-49c6-b9f9-02e1e8502b13\"\n}"}],"_postman_id":"96db690a-8e37-7513-fe4e-7bedfc377ada"},{"name":"/verify/v1/aba/validate","id":"85af1ff2-1239-1fd9-0e45-ccd6ce871f8a","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic NjI3OTA1OTcwMDAzOTA1NzokTVBAeW1lbnRzNTgyMw=="}],"body":{"mode":"raw","raw":"{\"token\":\"f45d1c83-1533-4cbb-ae05-4381e181cb18\",\"amount\":\"0.01\",\"code\":\"555555\"}"},"url":"https://api.m-pay.com.au/verify/v1/aba/validate","description":"

Validates a code against a token generated via the initiate call. After 3 failed attempts the token will expire and a new verification will be required.

\n","urlObject":{"protocol":"https","path":["verify","v1","aba","validate"],"host":["api","m-pay","com","au"],"query":[],"variable":[]}},"response":[{"id":"78705cbd-d3fd-9676-e6c6-9e8eeece11f5","name":"Basic Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"token\": \"7a8f4897-02ee-49c6-b9f9-02e1e8502b13\",\n \"amount\": \"0.01\",\n \"code\": \"555555\"\n}"},"url":"https://api.m-pay.com.au/verify/v1/aba/validate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"durationMs\": 141,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}"}],"_postman_id":"85af1ff2-1239-1fd9-0e45-ccd6ce871f8a"},{"name":"/verify/v1/aba/update","id":"10ce66a2-8e02-225e-7b8a-60dfa36ec970","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"token\":\"f45d1c83-1533-4cbb-ae05-4381e181cb18\",\"remitter\":\"MoneytechP\",\"hasDDAuthority\":\"True\",\"bankAccountTitle\":\"Moneytech Payments Pty Ltd\",\"verificationIdentifier\":\"Moneytech Pty Ltd\"}"},"url":"https://api.m-pay.com.au/verify/v1/aba/update","description":"

Update the folllowing fields for a verified account's without reverifiying the bank account:

Bank Account Title
Has DDR authority

\n","urlObject":{"protocol":"https","path":["verify","v1","aba","update"],"host":["api","m-pay","com","au"],"query":[],"variable":[]}},"response":[{"id":"46eeaff4-a563-5fba-04de-27c0df57a36f","name":"Basic Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"token\": \"7a8f4897-02ee-49c6-b9f9-02e1e8502b13\",\n \"remitter\": \"MoneytechP\",\n \"hasDDAuthority\": \"True\",\n \"bankAccountTitle\": \"Moneytech Payments Pty Ltd\",\n \"verificationIdentifier\": \"Moneytech Pty Ltd\"\n}"},"url":"https://api.m-pay.com.au/verify/v1/aba/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"durationMs\": 72,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}"}],"_postman_id":"10ce66a2-8e02-225e-7b8a-60dfa36ec970"},{"name":"/verify/v1/aba/list","id":"56016ab5-0459-8c7a-ccc8-bf08e5ef82a6","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.m-pay.com.au/verify/v1/aba/list","description":"

Get a list of all verified bank acocunts

\n","urlObject":{"protocol":"https","path":["verify","v1","aba","list"],"host":["api","m-pay","com","au"],"query":[],"variable":[]}},"response":[{"id":"38ec9c52-4ef4-2afb-f832-0f0e242c5d02","name":"Basic Example","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"Email\":\"sireland1963@gmail.com\",\"Password\":\"sireland1963@gmail.com\"}"},"url":"https://api.m-pay.com.au/verify/v1/aba/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"durationMs\": 37,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\",\n \"list\": [\n {\n \"bankAccountNumber\": \"123456789\",\n \"bankAccountTitle\": \"Moneytech Payments Pty Ltd\",\n \"bsb\": \"062-002\",\n \"comment\": null,\n \"created\": \"2017-12-01T12:02:21\",\n \"ddAuthorityChangedBy\": \"6279059709798471\",\n \"ddAuthorityChangedTimestamp\": \"2017-12-01T12:02:21\",\n \"hasDDAuthority\": true,\n \"isBlacklisted\": false,\n \"lastSystemBSBValidation\": \"\",\n \"remitter\": \"MoneytechP\",\n \"token\": \"f45d1c83-1533-4cbb-ae05-4381e181cb18\",\n \"updated\": \"2017-12-08T20:41:13\",\n \"verificationDEJobId\": 27460,\n \"verificationIdentifier\": \"Moneytech Pty Ltd\",\n \"verificationLastRetryLockoutMinutes\": 60,\n \"verificationLastRetryTimestamp\": \"2017-12-01T12:02:21\",\n \"verificationRetryCount\": 2,\n \"verificationRetyCountBeforeLockout\": 3,\n \"verificationRootId\": 96493,\n \"verificationSignonMerchant\": \"6279059709798471\",\n \"verificationStatus\": \"Approved\"\n },\n {\n \"bankAccountNumber\": \"123456781\",\n \"bankAccountTitle\": \"MPayments Retail\",\n \"bsb\": \"062-002\",\n \"comment\": null,\n \"created\": \"2018-02-05T10:13:47\",\n \"ddAuthorityChangedBy\": \"6279059709798471\",\n \"ddAuthorityChangedTimestamp\": \"2018-02-05T10:13:47\",\n \"hasDDAuthority\": true,\n \"isBlacklisted\": false,\n \"lastSystemBSBValidation\": \"\",\n \"remitter\": \"MPRetail\",\n \"token\": \"337c96ed-54f1-4960-88e8-28f2d16ff362\",\n \"updated\": \"2018-02-05T10:13:47\",\n \"verificationDEJobId\": 33876,\n \"verificationIdentifier\": \"MP Retail Account\",\n \"verificationLastRetryLockoutMinutes\": 60,\n \"verificationLastRetryTimestamp\": \"2018-02-05T10:13:47\",\n \"verificationRetryCount\": 0,\n \"verificationRetyCountBeforeLockout\": 3,\n \"verificationRootId\": 127625,\n \"verificationSignonMerchant\": \"6279059709798471\",\n \"verificationStatus\": \"Pending\"\n },\n {\n \"bankAccountNumber\": \"012345678\",\n \"bankAccountTitle\": \"Moneytech Payments Pty Ltd\",\n \"bsb\": \"062-002\",\n \"comment\": null,\n \"created\": \"2018-02-05T10:16:03\",\n \"ddAuthorityChangedBy\": \"6279059709798471\",\n \"ddAuthorityChangedTimestamp\": \"2018-02-05T10:16:03\",\n \"hasDDAuthority\": true,\n \"isBlacklisted\": false,\n \"lastSystemBSBValidation\": \"\",\n \"remitter\": \"MoneytechP\",\n \"token\": \"7a8f4897-02ee-49c6-b9f9-02e1e8502b13\",\n \"updated\": \"2018-02-05T10:19:26\",\n \"verificationDEJobId\": 33877,\n \"verificationIdentifier\": \"Moneytech Pty Ltd\",\n \"verificationLastRetryLockoutMinutes\": 60,\n \"verificationLastRetryTimestamp\": \"2018-02-05T10:16:03\",\n \"verificationRetryCount\": 0,\n \"verificationRetyCountBeforeLockout\": 3,\n \"verificationRootId\": 127628,\n \"verificationSignonMerchant\": \"6279059709798471\",\n \"verificationStatus\": \"Approved\"\n }\n ]\n}"}],"_postman_id":"56016ab5-0459-8c7a-ccc8-bf08e5ef82a6"},{"name":"/verify/v1/aba/list?status=Approved","id":"0b34540e-327c-8c18-9f64-3f50242a04ee","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Basic NjI3OTA1OTcwMDAzOTA1NzokTVBAeW1lbnRzNTgyMw=="}],"body":{"mode":"raw","raw":""},"url":"https://api.m-pay.com.au/verify/v1/aba/list?status=Approved","urlObject":{"protocol":"https","path":["verify","v1","aba","list"],"host":["api","m-pay","com","au"],"query":[{"key":"status","value":"Approved"}],"variable":[]}},"response":[{"id":"23cfcb43-e5d7-c962-ab9a-0d77b733b27e","name":"Basic Example","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"Email\":\"sireland1963@gmail.com\",\"Password\":\"sireland1963@gmail.com\"}"},"url":{"raw":"https://api.m-pay.com.au/verify/v1/aba/list?status=Approved","protocol":"https","host":["api","m-pay","com","au"],"path":["verify","v1","aba","list"],"query":[{"key":"status","value":"Approved"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"durationMs\": 15,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\",\n \"list\": [\n {\n \"bankAccountNumber\": \"123456789\",\n \"bankAccountTitle\": \"Moneytech Payments Pty Ltd\",\n \"bsb\": \"062-002\",\n \"comment\": null,\n \"created\": \"2017-12-01T12:02:21\",\n \"ddAuthorityChangedBy\": \"6279059709798471\",\n \"ddAuthorityChangedTimestamp\": \"2017-12-01T12:02:21\",\n \"hasDDAuthority\": true,\n \"isBlacklisted\": false,\n \"lastSystemBSBValidation\": \"\",\n \"remitter\": \"MoneytechP\",\n \"token\": \"f45d1c83-1533-4cbb-ae05-4381e181cb18\",\n \"updated\": \"2017-12-08T20:41:13\",\n \"verificationDEJobId\": 27460,\n \"verificationIdentifier\": \"Moneytech Pty Ltd\",\n \"verificationLastRetryLockoutMinutes\": 60,\n \"verificationLastRetryTimestamp\": \"2017-12-01T12:02:21\",\n \"verificationRetryCount\": 2,\n \"verificationRetyCountBeforeLockout\": 3,\n \"verificationRootId\": 96493,\n \"verificationSignonMerchant\": \"6279059709798471\",\n \"verificationStatus\": \"Approved\"\n },\n {\n \"bankAccountNumber\": \"012345678\",\n \"bankAccountTitle\": \"Moneytech Payments Pty Ltd\",\n \"bsb\": \"062-002\",\n \"comment\": null,\n \"created\": \"2018-02-05T10:16:03\",\n \"ddAuthorityChangedBy\": \"6279059709798471\",\n \"ddAuthorityChangedTimestamp\": \"2018-02-05T10:16:03\",\n \"hasDDAuthority\": true,\n \"isBlacklisted\": false,\n \"lastSystemBSBValidation\": \"\",\n \"remitter\": \"MoneytechP\",\n \"token\": \"7a8f4897-02ee-49c6-b9f9-02e1e8502b13\",\n \"updated\": \"2018-02-05T10:19:26\",\n \"verificationDEJobId\": 33877,\n \"verificationIdentifier\": \"Moneytech Pty Ltd\",\n \"verificationLastRetryLockoutMinutes\": 60,\n \"verificationLastRetryTimestamp\": \"2018-02-05T10:16:03\",\n \"verificationRetryCount\": 0,\n \"verificationRetyCountBeforeLockout\": 3,\n \"verificationRootId\": 127628,\n \"verificationSignonMerchant\": \"6279059709798471\",\n \"verificationStatus\": \"Approved\"\n }\n ]\n}"}],"_postman_id":"0b34540e-327c-8c18-9f64-3f50242a04ee"},{"name":"/verify/v1/aba/get/token","id":"09422a3c-e4f8-2aa3-63e2-293f4b12131b","request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://api.m-pay.com.au/verify/v1/aba/get/{{token}}","description":"

Return details for a specific verification token

\n","urlObject":{"protocol":"https","path":["verify","v1","aba","get","{{token}}"],"host":["api","m-pay","com","au"],"query":[],"variable":[]}},"response":[{"id":"a4dc56cc-2827-1928-5ce6-502493a2ee99","name":"Basic Example","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"Email\":\"sireland1963@gmail.com\",\"Password\":\"sireland1963@gmail.com\"}"},"url":"https://api.m-pay.com.au/verify/v1/aba/get/f45d1c83-1533-4cbb-ae05-4381e181cb18"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"durationMs\": 12,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\",\n \"details\": {\n \"bankAccountNumber\": \"123456789\",\n \"bankAccountTitle\": \"Moneytech Payments Pty Ltd\",\n \"bsb\": \"062-002\",\n \"comment\": null,\n \"created\": \"2017-12-01T12:02:21\",\n \"ddAuthorityChangedBy\": \"6279059709798471\",\n \"ddAuthorityChangedTimestamp\": \"2017-12-01T12:02:21\",\n \"hasDDAuthority\": true,\n \"isBlacklisted\": false,\n \"lastSystemBSBValidation\": \"\",\n \"remitter\": \"MoneytechP\",\n \"token\": \"f45d1c83-1533-4cbb-ae05-4381e181cb18\",\n \"updated\": \"2017-12-08T20:41:13\",\n \"verificationDEJobId\": 27460,\n \"verificationIdentifier\": \"Moneytech Pty Ltd\",\n \"verificationLastRetryLockoutMinutes\": 60,\n \"verificationLastRetryTimestamp\": \"2017-12-01T12:02:21\",\n \"verificationRetryCount\": 2,\n \"verificationRetyCountBeforeLockout\": 3,\n \"verificationRootId\": 96493,\n \"verificationSignonMerchant\": \"6279059709798471\",\n \"verificationStatus\": \"Approved\"\n }\n}"}],"_postman_id":"09422a3c-e4f8-2aa3-63e2-293f4b12131b"}],"id":"a622313a-d1ca-1983-70c7-650cafd76008","description":"

Bank Account Ownership Verification

The account verification API will credit a target bank account with a secret code as a remitter name.

This code can only be viewed by the owner of the target bank account by accessing and viewing their bank statement. The code can then be submitted against our records, and if it matches we will persist a verification token against that specific account.

This is useful in order to verify true ownership of a bank account, which may be necessary to meet compliance requirements or to mitigate fraud risk and reversals.

How it works:

POST verify/v1/aba/initiate to initiate a verification transaction on the target bank account
Moneytech will credit the target bank account with 1c amount and a secret remitter code (may take up to 48 hours for the code to show on target bank account)

Below image is how a sample verification code appears on a bank statement. In YELLOW is the code your client will need to return, in blue is your remittername.\n

Owner of target bank account views statement to obtain secret code.
Submit secret code to moneytech via POST verify/v1/aba/validate
If the submitted code and amount is correct, the target bank account is designated as verified.

\n","event":[{"listen":"prerequest","script":{"id":"d760b4ae-0354-4e5f-9d8b-fd22a4835705","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"643f383b-f559-4623-a997-25d712834643","type":"text/javascript","exec":[""]}}],"_postman_id":"a622313a-d1ca-1983-70c7-650cafd76008","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]},"isInherited":true,"source":{"_postman_id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","name":"Moneytech Payments Platform","type":"collection"}}},{"name":"Public","item":[{"name":"/mAccount/v1/public/activatePasswordReset","id":"012ac91b-b7b4-cbe5-ff5a-950fd7fdee0c","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"encryptedCreds","value":"string","description":"

The encrypted credentials passed to the landing page that should be used to activate the password. Note that these credentials will expire after 2 days.

\n","type":"text"}]},"url":"https://api.m-pay.com.au/mAccount/v1/public/activatePasswordReset","description":"

This API will make active a password that was sent to an mAccount account holder via email. The account holder and new password are encrypted and returned as part of the hyperlink encapsulated within the email and this encrypted data is passed to this API call for activation.

Note: This API call uses public non authenticated access and data security is protected by using base 64 encoding of encrypted credentials. Furthermore, the encrypted credentials have a time expiry of 2 days.

16-Digit account number that uniquely identifies the mAccount.

\n","type":"text"},{"key":"resetUrlLandingPage","value":"string","description":"

The email generated contains a hyperlink that refers to this page that allows the user to activate the auto-generated password. This URL will have a query param auth appended for use in activation. If this parameter is empty then the default page used is the default mAccount activation web page.

\n","type":"text"}]},"url":"https://api.m-pay.com.au/mAccount/v1/public/sendPasswordResetEmail","description":"

This API generates a new password that is sent to the mAccount owner via their registered email. The mAccount owner can then activate the new password by hitting the hyperlink in the email. The address of the landing page that the hyperlink references can be changed to a vendors page. If the address is left blank then the hyperlink generated will take the mAccount owner to the default Platform password activation page. The hyperlink has a request parameter appended called auth that is an encrypted Base 64 string that is used as the activation credentials in the activatePasswordReset API call.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]},"isInherited":true,"source":{"_postman_id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","name":"Moneytech Payments Platform","type":"collection"}},"urlObject":{"protocol":"https","path":["mAccount","v1","public","sendPasswordResetEmail"],"host":["api","m-pay","com","au"],"query":[],"variable":[]}},"response":[{"id":"a3e95619-ab79-a82f-96a2-b43e71c24e6c","name":"Basic Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accountNumber\": \"6279059700023317\",\n \"resetUrlLandingPage\": \"https://www.mygateway.com.au/activateMerchantPassword\"\n}"},"url":"https://api.m-pay.com.au/mAccount/v1/public/sendPasswordResetEmail"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"1293","name":"Content-Length","description":""},{"key":"Content-Type","value":"text/html","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 26 Jun 2017 05:43:22 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"WWW-Authenticate","value":"Basic Realm=mOApi","name":"WWW-Authenticate","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 17:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"5w0iozaxzrpeevvl0kxahauq","key":"ASP.NET_SessionId"}],"responseTime":"1074","body":"{\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\",\n \"durationMs\": 198\n}"}],"_postman_id":"01b90213-b6a5-e22b-6fe1-cda5e93009ba"},{"name":"/public/v1/ping","id":"13093569-c68c-b375-0e03-f89b58c85812","request":{"method":"GET","header":[],"url":"https://api.m-pay.com.au/public/v1/ping","description":"

The primary purpose of the ping API is to validate that the Platform servers are up and running.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]},"isInherited":true,"source":{"_postman_id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","name":"Moneytech Payments Platform","type":"collection"}},"urlObject":{"protocol":"https","path":["public","v1","ping"],"host":["api","m-pay","com","au"],"query":[],"variable":[]}},"response":[{"id":"d031785a-901a-bd42-f472-557b12e00061","name":"Basic Example","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.m-pay.com.au/public/v1/ping"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"252","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 26 Jun 2017 05:39:44 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 16:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"5w0iozaxzrpeevvl0kxahauq","key":"ASP.NET_SessionId"}],"responseTime":"71","body":"{\"durationMs\":9,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\",\"environment\":\"Staging\",\"version\":\"Moneytech Payments Platform Public - RESTful Service V:1.1 Engine V:4.60 Environment:Staging DateTime:26-Jun-2017 03:39:44 PM\"}"}],"_postman_id":"13093569-c68c-b375-0e03-f89b58c85812"}],"id":"dcde4766-951b-4f9b-d89d-4b4b644b4893","description":"

Overview

The public/v1/ API support’s the following services:

public/v1/mAccount/activatePasswordReset
public/v1/mAccount/sendPasswordResetEmail
public/v1/ping

The APIs in this section require NO authentication.

\n","_postman_id":"dcde4766-951b-4f9b-d89d-4b4b644b4893","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]},"isInherited":true,"source":{"_postman_id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","name":"Moneytech Payments Platform","type":"collection"}}},{"name":"Reports","item":[{"name":"/reports/v1/settlement","id":"7d27019c-63b3-d1db-ef24-d41e3695d398","request":{"method":"GET","header":[],"url":"https://api.m-pay.com.au/reports/v1/settlement/{date}","description":"

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.

The Platform settles transactions at 4pm (Sydney time) each business day. Therefore, transactions on weekends, public holidays and after 4pm won’t appear in the settlement report until after 4pm the next business day.

This API returns all successful transactions on the given date. Date is represented by ISO8601 – ‘2016-03-01’ for 1st March 2016.

Objects

SettlementItem

{\n  \"disbursementAmount\":     number,\n  \"transactionId\":       number,\n  \"uniqueReferenced\":     string, \n  \"disbursementMethod\":     string,\n  \"feeAmountExclGst\":     number,\n  \"feeAmountGstComponent\":   number,\n  \"feeAmountInclGst\":     number\n}\n

The Settlement API returns an array node, providing details of each settlement.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
disbursementAmount	number	This is the settlement or the requested disbursement amount.
transactionId	number	This is the transactionId that was returned when the transaction was executed
uniqueReference	string	This is your uniqueReference that was passed in when the transaction was executed
disbursementMethod	string	This is the disbursementMethod that was used to make the settlement payment
feeAmountExclGst	number	This is the fee amount of the disbursement excluding GST
feeAmountGstComponent	number	This is the GST component of the disbursement fee
feeAmountInclGst	number	This is the fee amount of the disbursement including GST

TransactionItem

{\n  \"dateTime\":         string,\n  \"feeAmountExcludingGst\":   number,\n  \"feeAmountGstComponent\":   number,\n  \"feeAmountIncludingGst\":   number,\n  \"totalAmount\":         number,\n  \"transactionId\":       number,\n  \"uniqueReferenced\":     string \n}\n

The Settlement API returns an array node, providing details of each transaction.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
dateTime	string	The date time that the transaction was executed on the Platform Servers. Format is ISO8601 - \"2015-09-01T19:19:58\"
feeAmountExcludingGst	number	This is the fee amount Excluding GST that has been debited from your mAccount
feeAmountGstComponent	number	This is the GST Component of the fee amount that has been debited from your mAccount
feeAmountIncludingGst	number	This is the total fee amount Including GST that has been debited from your mAccount
totalAmount	number	This is the total amount of the transaction what was disbursed.
transactionId	number	This is the transactionId that was returned when the transaction was executed
uniqueReference	string	This is your uniqueReference that was passed in when the transaction was executed

","_postman_id":"2f4f50a5-5d8c-722d-baf1-d2515012379e","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]},"isInherited":true,"source":{"_postman_id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","name":"Moneytech Payments Platform","type":"collection"}}},{"name":"Security","item":[{"name":"/security/v1/changePassword","id":"037e62a1-4f53-c431-a6c9-ef8be1bf5afc","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"password1\":\"$My Name is Fred@876\",\n\t\"password2\":\"$My Name is Fred@876\"\n}"},"url":"https://api.m-pay.com.au/security/v1/changePassword","description":"

This API allows the Sign-In Account to change their Sign-In password.

The new password must be passed in twice in fields password1 and password2.

This API returns a security token that can be used only once or until it expires. The purpose of this token is that it can be embedded in a web form to enable you to make a single call to the Platform without exposing your Sign-In Account credentials.

As an example, it is useful if you capture a customer’s Credit-Card details and want to pass those details to the Platform token/v1 APIs to create a new token. By making the call from the web page, the Credit-Card details are never exposed to your web server. Create the OneShotSecurityToken from your backend service and embed the token in the page so it can be used when you make the call to create the Credit-Card token.

When setting your security credentials to call any of the APIs in this document (except for security/v1/createOneShotToken and security/v1/createSecurityToken), set the Username to the returned OneShotSecurityToken and set the password to anything as it will be ignored.

If you create the token and no longer require it, call security/v1/deleteSecurityToken to have the token removed.

This API deletes the security token specified in the parameter {token}. If no {token} parameter is present, the token used to Sign-In will be used if present. This API is to be used when you no longer need the token and do not want to wait until it expires.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]},"isInherited":true,"source":{"_postman_id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","name":"Moneytech Payments Platform","type":"collection"}},"urlObject":{"protocol":"https","path":["security","v1","deleteSecurityToken","{token}"],"host":["api","m-pay","com","au"],"query":[],"variable":[]}},"response":[{"id":"a09bcd97-dff9-b7f6-4ae0-8d395ad4953f","name":"Delete the security token used to sign-in ","originalRequest":{"method":"DELETE","header":[],"url":"https://api.m-pay.com.au/security/v1/deleteSecurityToken"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Content-Type,Authorization,SecurityToken","name":"Access-Control-Allow-Headers","description":""},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":""},{"key":"Cache-Control","value":"private,private, max-age=0, no-cache","name":"Cache-Control","description":""},{"key":"Content-Length","value":"86","name":"Content-Length","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":""},{"key":"Date","value":"Mon, 05 Feb 2018 07:19:13 GMT","name":"Date","description":""},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":""},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":""},{"key":"X-Content-Type-Options","value":"nosniff","name":"X-Content-Type-Options","description":""},{"key":"X-Frame-Options","value":"DENY","name":"X-Frame-Options","description":""},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":""},{"key":"X-XSS-Protection","value":"1","name":"X-XSS-Protection","description":""}],"cookie":[{"expires":"Tue Jan 19 2038 03:14:07 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"api.m-pay.com.au","path":"/","secure":false,"value":"ddoizudgaujvfzcgp5ogur1m","key":"ASP.NET_SessionId"}],"responseTime":"1115","body":"{\"durationMs\":13,\"status\":\"Ok\",\"statusDescription\":\"Operation completed successfully\"}"},{"id":"b70de439-80e0-cbfc-1f5b-c5d59db85231","name":" Delete an individual security token","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.m-pay.com.au/security/v1/deleteSecurityToken/5fff1778-ee69-41c8-9ac8-229d56556046"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\",\n \"durationMs\": 97\n}"}],"_postman_id":"6a922cf2-5641-ccbe-ec6e-6067b9ce8f6f"},{"name":"/security/v1/signInAccountSettings","id":"81b32595-c90c-f9d8-4786-0cfcc9a28a2c","request":{"method":"GET","header":[],"url":"https://api.m-pay.com.au/security/v1/signInAccountSettings","description":"

This API returns the fees and permissions that have been given to the Sign-In Account.

Overview

The security/v1 APIs provide services to manage security tokens which give you an alternative to using your Credentials for BASIC authentication for each API call.

The OneshotSecuritytoken is used to replace your UserName when configuring BASIC Authentication (no password is required, it will be ignored if supplied). Each token has an expiry time between 1 and 15 minutes.

A OneShotSecurityToken can only be used only once. The token is deleted on its first use or when it expires.\nTokens may be deleted before they expire by calling security/v1/deleteSecurityToken.

Note: The security tokens discussed in this section provide secure sign-in from a web page. They have nothing to do within the token/v1 APIs described elsewhere in this document.

\n","event":[{"listen":"prerequest","script":{"id":"7cf0c715-a7cb-4c73-8cf0-f3031fab823f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8c635f19-a305-45c4-b0c8-c8714a158619","type":"text/javascript","exec":[""]}}],"_postman_id":"7a8038c7-e281-40c1-4c0e-64344995ae2a","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]},"isInherited":true,"source":{"_postman_id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","name":"Moneytech Payments Platform","type":"collection"}}},{"name":"Token","item":[{"name":"/token/v1/createAustralianBankAccount","id":"61df4eb1-b95a-52ef-57ef-9a8cf960e298","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accountNumber\": \"6279059700010827\",\n \"description\": \"Savings Account\",\n \"tokenToUpdate\": \"\",\n \"bankAccountName\": \"Test Bank Account\",\n \"bankAccountNumber\": \"123456789\",\n \"bsb\": \"012-366\"\n}"},"url":"https://api.m-pay.com.au/token/v1/createAustralianBankAccount","description":"

This API creates a token representing an Australian Bank Account by passing a TokenAustralianBankAccountPayload class in the body.

** Request Body Schema **

See TokenAustralianBankAccountPayload object.

This API creates a token representing BPAY details by passing a TokenBPAYPayload class in the body.

This API creates a token representing Credit Card details by passing a TokenCreditCardPayload class in the body.

This API will delete the payload attached to the specified token.

This API will return the payload attached to the specified token.

This API will return a list of all tokens associated with the provided mWallet or mAccount.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]},"isInherited":true,"source":{"_postman_id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","name":"Moneytech Payments Platform","type":"collection"}},"urlObject":{"protocol":"https","path":["token","v1","list","{accountNumber}"],"host":["api","m-pay","com","au"],"query":[],"variable":[]}},"response":[{"id":"3bf553db-1f90-0589-9e1d-7cc064a3f512","name":"Basic Example","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.m-pay.com.au/token/v1/list/6279059700010827"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"tokens\": [\n {\n \"hint\": \"Biller: MONEYTECH FINANCE PTY LTD Reference: 6279059700010918 \\nAmount: 100 IsVariable: False\",\n \"payloadType\": \"BPAY\",\n \"token\": \"8def2443-5139-4d93-9b61-ef7901363760\",\n \"description\": \"Insurance Premium BPAY\"\n },\n {\n \"hint\": \"Bank: ANZ Account: 123456789\",\n \"payloadType\": \"AustralianBankAccount\",\n \"token\": \"af980b64-c0fb-4d31-b84f-5e4a4ef095a0\",\n \"description\": \"Savings Account\"\n },\n {\n \"hint\": \"Credit-Card: Mastercard **** **** **** 2346 \\n Exp: 5/17\",\n \"payloadType\": \"CreditCard\",\n \"token\": \"0a4fe0d3-43c7-47ec-b089-4977cead9451\",\n \"description\": \"Personal Credit-Card\"\n },\n {\n \"hint\": \"Credit-Card: Visa **** **** **** 8769 \\n Exp: 5/17\",\n \"payloadType\": \"CreditCard\",\n \"token\": \"465f2a14-f24f-48ec-a80b-bed378bf968f\",\n \"description\": \"Company Credit-Card\"\n },\n {\n \"hint\": \"Biller: MONEYTECH FINANCE PTY LTD Reference: \\n 6279059700010918 Amount: 50 IsVariable: False\",\n \"payloadType\": \"BPAY\",\n \"token\": \"33ae9d47-a482-441a-89fe-92f3aa96db48\",\n \"description\": \"Electricity Account BPAY\"\n },\n {\n \"hint\": \"Bank: ANZ Account: 123456778\",\n \"payloadType\": \"AustralianBankAccount\",\n \"token\": \"4112f32f-ff76-4fbf-ab19-af676f588229\",\n \"description\": \"Cheque Account\"\n }\n ],\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\",\n \"durationMs\": 154\n}"}],"_postman_id":"910b1b43-8ed5-2425-9a07-8a0d4fafda2a"},{"name":"/token/v1/updateAustralianBankAccount","id":"86af8919-616b-3357-2463-8e12d3d5f656","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accountNumber\": \"6279059700010827\",\n \"description\": \"Savings Account\",\n \"tokenToUpdate\": \"9395ddef-69cb-4f38-8836-3c6502c72182\",\n \"bankAccountName\": \"Test Bank Account\",\n \"bankAccountNumber\": \"123456789\",\n \"bsb\": \"012-366\"\n}"},"url":"https://api.m-pay.com.au/token/v1/updateAustralianBankAccount","description":"

This API allows the Sign-In Account to change their Sign-In password.

The new password must be passed in twice in fields password1 and password2.

This API provides the ability to update the payload associated with an existing token. For this API, the payload to update is a TokenBPAYPayload class.

This API creates a token representing BPAY details by passing a TokenBPAYPayload class in the body.

==TODO== check this, the endpoint was listed as /get in the old docs (there was already a /get call)

==TODO== Ensure this is the correct description

Overview

A token is used to obfuscate (Credit-Cards, BPAY & Australian Bank Account) Debit/Credit details. The details of token (called its payload) are stored encrypted on the Platform servers.

It is a measure to provide a secure mechanism for storage of financially secure information. If the security of the system is compromised a tokening system will protect the sensitive financial information.

The tokening system has been designed such the generated token has no mathematical or algorithmic connection to the secret data held as the payload. The token is a random number that is manifested as a GUID.

Currently three types of payloads can be held within the tokening System. These are:

Credit-Card
Australian Bank Account
BPAY

Other payload types can be added if required.

If you are on a web page and you have asked the user to enter their Credit-Card details (for example), you can use the security/v1/createOneShotSecurityToken API to embed an OneShotSecurityToken in your page. Using this OneShotSecurityToken you can call the appropriate token/v1/create API passing the payload details. Using this approach, the customer’s payload details are never passed through your server.

Objects

TokenPayloadBase

{\n  \"accountNumber\":   string,\n  \"tokenToUpdate\":   string, // Used for updates only\n  \"description\":     string\n}\n

Used to store Australian Bank Account details as a payload within the tokenisation system.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
accountNumber	string	16	The mWallet or mAccount 16-Digit number that owns the payload.
tokenToUpdate	string	36	On update and some query commands this is the token that needs updating or querying. The Token is in the form of a GUID
description	string	256	A simple text description that is associated with the token. For example “Monthly Electricity Bill BPAY”.

TokenAustralianBankAccountPayload

{\n  \"accountNumber\":     string, // TokenPayloadBase\n  \"tokenToUpdate\":     string, // TokenPayloadBase\n  \"description\":       string, // TokenPayloadBase\n  \"bankAccountName\":   string,\n  \"bsb\":               string,\n  \"bankAccountNumber\": number\n}\n

Used to store BPAY details as a payload within the tokenisation system.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
bankAccountName	string	Name associated with the bank account. Minimum length is 5.
bsb	string	Bank-State-Branch number. Format is 3-3 digits. Eg. '000-000'
bankAccountNumber	number	Bank account number. Minimum length is 4 characters

TokenBPAYPayload

{\n  \"accountNumber\":       string, // TokenPayloadBase\n  \"tokenToUpdate\":       string, // TokenPayloadBase\n  \"description\":         string, // TokenPayloadBase\n  \"billerCode\":         number,\n  \"customerReferenceNumber\":  string,\n  \"amount\":           number\n}\n

Used to store BPAY details as a payload within the tokenisation system.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
billerCode	number	Biller Code as shown on the Bill. Must be a valid BPAY Biller on token creation.
customerReferenceNumber	string	Customer Reference Number as shown on the Bill. Must be a valid BPAY Customer Reference Number on token creation
amount	number	Amount as shown on the Bill. Must be a valid amount on token creation.

TokenCreditCardPayload

{\n  \"accountNumber\":  string, // TokenPayloadBase\n  \"tokenToUpdate\":  string, // TokenPayloadBase\n  \"description\":    string, // TokenPayloadBase\n  \"creditCardNumber\":  string,\n  \"expiryMonth\":    number,\n  \"expiryYear\":    number,\n  \"cvn\":        string,\n  \"name\":        string\n}\n

Used to store BPAY details as a payload within the tokenisation system.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
creditCardNumber	string	16	Credit-Card Number. Card is LUN checked to ensure accuracy.
expiryMonth	number		Expiry month of the card. 1 = January and 12 = December. Upon creation expiryMonth is combined with expiryYear to ensure Credit-Card payload has not expired.
expiryYear	number		4 digit Expiry year of the card eg 2016. expiryMonth is combined with expiryYear to ensure Credit-Card payload has not expired.
cvn	string	4	Card validation number that is tested for correct length depending upon the Credit-Card type. Visa, Mastercard and Diners cards have a cvn length of 3, whereas Amex cards have a CVN length of 4.
name	string	100	Name appearing on the card. Must not be blank or empty.

TokenDetails

{\n  \"token\":     string,\n  \"hint\":     string,\n  \"payloadType\":   string,\n  \"description\":   string\n}\n

Used to store BPAY details as a payload within the tokenisation system.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
token	string	The text (GUID) that identifies the token
hint	string	Text that gives sufficient information to allow the token to be selected but does not compromise security.
payloadType	string	CreditCard, BPAY or AustralianBankAccount
description	string	Text supplied when the token was created.

","_postman_id":"43405174-d1ec-58ec-da70-d86865c59e99","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]},"isInherited":true,"source":{"_postman_id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","name":"Moneytech Payments Platform","type":"collection"}}},{"name":"Tools","item":[{"name":"/tools/v1/abnValidate","id":"ae522a32-ea7e-2fc0-bf7d-89649c11d754","request":{"method":"GET","header":[],"url":"https://api.m-pay.com.au/tools/v1/abnValidate/{abnNumber}","description":"

The purpose of this API is to validate that an ABN (Australian Business Number) is correct and determine if it’s valid. This API makes a call to the Australian Business Registry returning current details about the company.

An ABN is defined as a string of eleven numeric digits. Spaces are allowed but no other characters.

If the resulting status property contains ‘Ok’ then examine the property isAbnValid. The property isCharity will be true if the entity is an active registered charity. A list of codes and more information is available at http://abr.business.gov.au/Documentation/ReferenceData

The purpose of this API is to return details about a BSB (Bank-State-Branch) number. The format is a string in the following format ‘999-999’.

This is the name on the Credit-Card.

\n","type":"text"},{"key":"*cardNumber","value":"string","description":"

This is the Credit-Cards number. This field must be numeric only.

\n","type":"text"},{"key":"*expiryMonth","value":"number","description":"

This is the expiry month of the Credit-Card. Must be between 1 and 12

\n","type":"text"},{"key":"*expiryYear","value":"number","description":"

This is the expiry year of the Credit-Card. Can be either a 2 or 4 digit year

\n","type":"text"},{"key":"*cardValidationNumber","value":"string","description":"

This is the Credit-Cards validation number. Must be a 4 or 3 digit number depending on the card type.

\n","type":"text"},{"key":"*returnFee","value":"boolean","description":"

Set to true if you want the fee that will be debited from your Sign-In mAccount returned. Default is false

\n","type":"text"},{"key":"usage","value":"string","description":"

This field indicates how you intend to use the Credit-Card. Options are to either debit the Credit-Card for some funds or apply a refund to the card. This field must be one of either debit or refund. Required if returnFee is true.

\n","type":"text"},{"key":"amount","value":"number","description":"

The amount you intend to either debit the Credit-Card or refund back on the card. Required if returnFee is true

\n","type":"text"}]},"url":"https://api.m-pay.com.au/tools/v1/creditCardValidate","description":"

The purpose of this API is to return details about a BSB (Bank-State-Branch) number. The format is a string in the following format ‘999-999’.

The primary purpose of the ping API is to validate your credentials as well validate that the Platform servers are up and running.

This is the emails subject

\n","type":"text"},{"key":"isBodyHtml","value":"boolean","description":"

Set to true if the body contains HTML

\n","type":"text"},{"key":"body","value":"string","description":"

Email body. Can be HTML or plain text

\n","type":"text"}]},"url":"https://api.m-pay.com.au/tools/v1/sendEmailToIssuer","description":"

The purpose of this API is to provide email functionality for your application to send emails to the Sign-In Accounts Issuer.

Overview

The APIs in the tools/v1/ section represent utilities that you may find useful while consuming the other APIs offered as part of the Platform other APIs.

Objects

CreditCardFee

{\n    \"feeAmountExcludingGst\":        number,\n    \"feeAmountGstComponent\":        number,\n    \"feeAmountIncludingGst\":         number,\n    \"recommendedMinimumSurchargeAmount\":   number\n}\n

Contains the Fee that will be applied to your Sign-In mAccount to process a specified Credit-Card. Returned as part of the tools/v1/creditCardValidate API.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
feeAmountExcludingGst	number	The fee amount excluding GST
feeAmountGstComponent	number	The GST associated with the fee
feeAmountIncludingGst	number	The fee amount including GST
recommendedMinimumSurchargeAmount	number	This is the recommended minimum amount that should be added to the Credit-Card amount to cover just the Moneytech Payments Credit-Card fee. The amount is rounded up to the nearest cent, calculated using the following formula: (BaseAmount+FixedFeeIncludingGST)/(1-(PercentageFeeIncludingGST/100))

EmailBodyDetail

{\n    \"subject\":     string,\n     \"isBodyHtml\":   boolean,\n    \"body\":     string\n}\n

Provides details about a Credit-Card to be validated. Used by the tools/v1/creditCardValidate API.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
*subject	string	256	This is the emails subject
isBodyHtml	boolean		Set to true if the body contains HTML
body	string		Email body. Can be HTML or plain text
*Required Field

ValidateCreditCardDetail

{\n  \"nameOnCard\":         string,\n  \"cardNumber\":         string,\n  \"expiryMonth\":         number,\n  \"expiryYear\":         number,\n  \"cardValidationNumber\":   string,\n  \"returnFee\":         boolean\n  \"usage\":           string,\n  \"amount\":           number\n}\n

Provides details about a Credit-Card to be validated. Used by the tools/v1/creditCardValidate API.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
*nameOnCard	string	100	This is the name on the Credit-Card.
*cardNumber	string	16	This is the Credit-Cards number. This field must be numeric only.
*expiryMonth	number		This is the expiry month of the Credit-Card. Must be between 1 and 12
*expiryYear	number		This is the expiry year of the Credit-Card. Can be either a 2 or 4 digit year
*cardValidationNumber	string	4	This is the Credit-Cards validation number. Must be a 4 or 3 digit number depending on the card type.
*returnFee	boolean		Set to true if you want the fee that will be debited from your Sign-In mAccount returned. Default is false
usage	string		This field indicates how you intend to use the Credit-Card. Options are to either debit the Credit-Card for some funds or apply a refund to the card. This field must be one of either debit or refund. Required if returnFee is true.
amount	number		The amount you intend to either debit the Credit-Card or refund back on the card. Required if returnFee is true
*Required Field

","_postman_id":"5cc49fea-423e-83b4-4543-1dd589a1be95","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]},"isInherited":true,"source":{"_postman_id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","name":"Moneytech Payments Platform","type":"collection"}}},{"name":"mAccount","item":[{"name":"/mAccount/v1/charities","id":"569c8e4e-2669-fe51-0551-ec3177b549e8","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.m-pay.com.au/mAccount/v1/charities","description":"

This API returns a list of charities that you are authorised to make donations too. The list includes both public and private charities you have asked Moneytech Payments to configure.

This API closes an mAccount.

This API creates an mAccount.

This API will return the current financials for an mAccount.

This API gets details of an mAccount.

Property details.options will contain ALL options and their current values.

Returns a list of 16-Digit mAccounts that you own. These mAccounts can be used by the security/v1/createImpersonationTokenAsIssuer API.

The 16-Digit account number that uniquely identifies the mWallet.

\n","type":"text"},{"key":"*frequency ","value":"string","description":"

An enumeration of fixed selection types. \nAll, \nThisMonth, \nLastMonth, \nThisFinancialYear, \nLastFinancialYear, \nCustom

\n","type":"text"},{"key":"startDate","value":"string","description":"

Start date of statement when the frequency is set to custom. In ISO 8601 date format. Note that Timezone is suppressed. The default Timezone is Sydney local time. Required field when frequency is set to custom.

\n","type":"text"},{"key":"endDate","value":"string","description":"

End date of statement when the frequency is set to custom. In ISO 8601 date format. Note that Timezone is suppressed. The default Timezone is Sydney local time. Required field when frequency is set to custom.

\n","type":"text"}]},"url":"https://api.m-pay.com.au/mAccount/v1/sendStatement","description":"

This API generates a detailed pdf statement for delivery via email.

16-Digit account number that uniquely identifies the mAccount.

\n","type":"text"},{"key":"startDate","value":"string","description":"

Start date of transaction range to retrieve. In ISO 8601 date format. Note that Timezone is suppressed. The default Timezone is Sydney local time. If not set to a valid date then the 1 Jan 2013 is used. The Time component is ignored unless useTime is set to true.

\n","type":"text"},{"key":"endDate","value":"string","description":"

End date of transaction range to retrieve. In ISO 8601 date format. Note that Timezone is suppressed. The default Timezone is Sydney local time. If not set the todays date is used. The Time component is ignored unless useTime is set to true.

\n","type":"text"},{"key":"skip","value":"number","description":"

Number of records to skip. 0 is the first record.

\n","type":"text"},{"key":"take","value":"number","description":"

Number of records to take. If take is 0 then all records will be returned.

\n","type":"text"},{"key":"descending","value":"boolean","description":"

Sort the returned transaction list in ascending or descending.

\n","type":"text"},{"key":"useTime","value":"boolean","description":"

Use the time component of startDate and endDate in the selection.

\n","type":"text"}]},"url":"https://api.m-pay.com.au/mAccount/v1/transactions","description":"

This API generates a detailed pdf statement for delivery via email.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]},"isInherited":true,"source":{"_postman_id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","name":"Moneytech Payments Platform","type":"collection"}},"urlObject":{"protocol":"https","path":["mAccount","v1","transactions"],"host":["api","m-pay","com","au"],"query":[],"variable":[]}},"response":[{"id":"b8e14bc4-9e70-5102-49cb-cb595d93cc5e","name":"Basic Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accountNumber\": \"6279059700023317\",\n \"frequency\": \"LastFinancialQuarter\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}"},"url":"https://api.m-pay.com.au/mAccount/v1/transactions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":"0","body":"{\n \"closingBalance\": -1.1,\n \"openingBalance\": 0.0,\n \"totalCredits\": 25.0,\n \"totalDebits\": 26.1,\n \"items\": [\n {\n \"dateTime\": \"2016-11-18T19:06:09\",\n \"credit\": 25.0,\n \"debit\": 0.0,\n \"description\": \"0bbae2f1-428a-4843-8993-0b3e4bc - test description\",\n \"mPaymentsId\": 2303202,\n \"mWalletAccountNumber\": null,\n \"rowOrder\": 0,\n \"runningBalance\": 25.0,\n \"subTransactionType\": \"GatewayCreditCardDebit\",\n \"transactionDescription\": \"Credit-Card Debit\",\n \"transactionId\": 4958475,\n \"transactionType\": \"Payment\"\n },\n {\n \"credit\": 0,\n \"dateTime\": \"2016-11-18T19:06:09\",\n \"debit\": 25.0,\n \"description\": \"0bbae2f1-428a-4843-8993-0b3e4bc - test description\",\n \"mPaymentsId\": 2303203,\n \"mWalletAccountNumber\": \"6279059600062340\",\n \"rowOrder\": 1,\n \"runningBalance\": 0.0,\n \"subTransactionType\": \"GatewayMWalletCredit\",\n \"transactionDescription\": \"Payment To mWallet\",\n \"transactionId\": 4958475,\n \"transactionType\": \"LoadFunds\"\n },\n {\n \"credit\": 0,\n \"dateTime\": \"2016-11-18T19:06:09\",\n \"debit\": 1.1,\n \"description\": \"0bbae2f1-428a-4843-8993-0b3e4bc - test description\",\n \"mPaymentsId\": 2303204,\n \"mWalletAccountNumber\": null,\n \"rowOrder\": 2,\n \"runningBalance\": -1.1,\n \"subTransactionType\": \"MoapiPaymentGatewayMerchantFee\",\n \"transactionDescription\": \"Processing Fee\",\n \"transactionId\": 4958475,\n \"transactionType\": \"LoadFunds\"\n }\n ],\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\",\n \"durationMs\": 847\n}"}],"_postman_id":"db51a233-4671-031c-16b0-6dbe8300408d"},{"name":"/mAccount/v1/update","id":"712d6358-2999-96fe-8e70-5c9e833b67b0","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accountNumber\": \"6279059700023317\",\n \"name\": \"Moneytech Ltd\",\n \"abn\": \"77 106 249 852\",\n \"contactName\": \"Kelly Royal\",\n \"contactNumber\": \"02 9555 5555\",\n \"email\": \"kelly.royal@moneytech.com.au\",\n \"addressLine1\": \"Level 6\",\n \"addressLine2\": \"97 Pacific Highway\",\n \"suburb\": \"North Sydney\",\n \"state\": \"NSW\",\n \"postCode\": \"2060\",\n \"bsb\": \"012-366\",\n \"bankAccountNumber\": \"123456789\",\n \"bankAccountTitle\": \"Test Bank Account\",\n \"financials\": null,\n \"options\": [\n {\n \"key\": \"DebitTplusXDays\",\n \"value\": \"1\"\n },\n {\n \"key\": \"CreditTplusXDays\",\n \"value\": \"1\"\n }\n ]\n}"},"url":"https://api.m-pay.com.au/mAccount/v1/update","description":"

This API creates an mAccount.

Overview

These APIs do not perform any financial transactions. They are used to manage mAccount information used by the Platform. The /financial/v1/transaction API verifies mAccount information in this subsystem before performing the transaction.

The mAccount/v1/ API support’s the following services:

mAccount/v1/charities
mAccount/v1/close
mAccount/v1/create
mAccount/v1/financials
mAccount/v1/get
mAccount/v1/listAsIssuer
mAccount/v1/sendStatement
mAccount/v1/transactions

Objects

mAccountActivatePasswordReset

{\n  \"encryptedCreds\": string\n}\n

This supplies the encrypted Base64 data encoded in the email generated by mAccountPasswordResetRequest.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
encryptedCreds	string	The encrypted credentials passed to the landing page that should be used to activate the password. Note that these credentials will expire after 2 days.

mAccountCharityItem

{\n  \"mAccountNumber\": string,\n  \"name\":           string\n}\n

An mAccountCharityItem represents an mAccountNumber and the name of each charity that you may make a donate to. Returned by the API mAccount/v1/charities call.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
mAccountNumber	string	This is the 16-Digit mAccount number representing the charity
name	string	This is the formal name of the charity

mAccountDetails

{\n  \"accountNumber\":      string,  // This field is ignored in create\n  \"allowDuplicates\":    boolean, // This field is only used in create\n  \"name\":               string,\n  \"abn\":                string,\n  \"contactName\":        string,\n  \"contactNumber\":      string,\n  \"email\":              string,\n  \"addressLine1\":       string,\n  \"addressLine2\":       string,\n  \"suburb\":             string,\n  \"state\":              string,\n  \"postCode\":           string,\n  \"bsb\":                string,\n  \"bankAccountNumber\":  string,\n  \"bankAccountTitle\":   string,\n  \"financials\":         mAccountFinancials,\n  \"options\":            [\n                          mAccountOptionItem\n                        ]\n}\n

Provides mAccount detail information.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
accountNumber	string	16	16-Digit account number that uniquely identifies the mAccount. This field is ignored in create. Required (in update).
*name	string	50	Company name of the mAccount.
allowDuplicates	boolean		If true, allow the creation of a new mAccount even though an existing mAccount with the same ABN exists.
*abn	string	15	Company ABN of the mAccount. All non numbers are stripped. See allowDuplicates
*contactName	string	30	Contact name. Spaces are stripped.
*contactNumber	string	15	Contact number. All non numbers are striped.
*email	string	300	Contact email. Converted to lowercase.
addressLine1	string	40	An optional postal address line such as a Building, section or unit
*addressLine2	string	40	An address line is the main postal address of the Company.
*suburb	string	30	Postal address suburb.
*state	string	10	Postal address state.
postCode	string	10	Postal address post code.
bsb	string	7	BSB number of associated bank account. BSB format is ‘000-000’.
bankAccountNumber	string	9	Bank account number of associated bank account.
bankAccountTitle	string	32	Bank account title or name of associated bank account.
financials	mAccountFinancials		See mAccountFinancials class This property is ignored when calling mAccount/v1/create and mAccount/v1/upate. This property only contains valid values when calling mAccount/v1/get
options	[mAccountOptionItem]		See mAccountOptionItem class
*Required Field

mAccountFinancials

{\n  \"actualBalance\": number\n}\n

When returned, contains the mAccounts current financial values.

Note

The returned field actualBalance is the current balance on the Platform. The Platform has several sub-systems that keep their own transactions separate until the transactions are authorised. During settlement these authorised transactions are moved onto the Platform as a single transaction amount.

If the mAccount is only transacting through the financial/v1 APIs, then the actualBalance returned will be accurate except for any settlement fees or charges that may be applied.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
actualBalance	number	Balance of the mAccount

mAccountOptionItem

{\n  \"key\":    string,\n  \"value\":  string\n}\n\n

An mAccountOptionItem represents a key/value pair of configuration options that apply to a particular mAccount.

Note

If value is an empty string, the option represented by the key is set to its default value.
If the key is omitted from the array, the option represented by the key is left as is.
An invalid key or value will result in an error.
key is case insensitive

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
key	string	Unique identifier of the value. See Key Definitions table below
value	string	The actual value represented by the Key

Key Definitions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Range	Description
DebitTplusXDays	“0” -> “5”	days Number of days between lodgement and settlement of debits
CreditTplusXDays	“0” -> “30”	days Number of days between lodgement and settlement of credits
SettlementFrequency		“None” No Settlement “Daily” Every Business Day - EOD “BeginningOfMonth” First Business Day of Month - EOD “EndOfMonth” Last Business Day of Month - EOD “MidMonth” First Business Day on or after the 15th of month - EOD “OnDemand” Only when manually initiated by Moneytech Payments “OnDemandWithCatch” Manually initiated and also Every Business Day - EOD “OncePerDay” Will not run at EOD if a manual settlement prior for same day
MobileForSms	“0414111111”	The mobile number to use when sending an SMS to the mAccount
MinimumSettlementAmount	“0.02” -> “100.00”	The mAccounts minimum balance to trigger a EOD settlement.
SendSettlementStatement	“true” or “false”	Set to “true” if you would like a settlement statement automatically sent to the Email address of the mAccount. If no settlement occurred, no statement is sent.
SendDailyStatement	“true” or “false”	Set to “true” if you would like a daily statement automatically sent to the Email address of the mAccount. If the mAccount has no transactions for the period, no statement is sent.
SendMonthlyStatement	“true” or “false”	Set to “true” if you would like a Monthly statement automatically sent to the Email address of the mAccount. Sent on the 1st of each month for the previous month. If the mAccount has no transactions for the period, no statement is sent.

mAccountPasswordResetRequest

{\n  \"accountNumber\":        string,\n  \"resetUrlLandingPage\":  string\n}\n

Supplies the account number whose password is to be reset and landing page that the generated email uses to activate the new password.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
*accountNumber	string	16	16-Digit account number that uniquely identifies the mAccount.
resetUrlLandingPage	string	500	The email generated contains a hyperlink to this page that allows the user to activate the auto-generated password. This URL will have a query param auth appended for use in activation. If this parameter is empty then the default page used is the default mAccount activation web page.
*Required Field

mAccountSelectionFilter

{\n  \"accountNumber\":  string,\n  \"frequency\":      string,\n  \"startDate\":      string,\n  \"endDate\":        string\n}\n

Supplies the account number whose password is to be reset and landing page that the generated email uses to activate the new password.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
*accountNumber	string	16	16-Digit account number that uniquely identifies the mAccount.
*frequency	string		An enumeration of fixed selection types. All, Today, Yesterday, ThisWeek, LastWeek, ThisMonth, LastMonth, LastFinancialQuarter, ThisFinancialQuarter, ThisFinancialYear, LastFinancialYear, LastDailySettlement, Custom
startDate	string		Start date of statement when the frequency is set to Custom in ISO 8601 date format. Note that Timezone is suppressed. The default Timezone is Sydney local time. Required field when frequency is set to custom.
endDate	string		End date of statement when the frequency is set to Custom in ISO 8601 date format. Note that Timezone is suppressed. The default Timezone is Sydney local time. Required field when frequency is set to custom.
*Required Field

mAccountTransactionRequestDetails

{\n  \"accountNumber\":  string,\n  \"startDate\":      string,\n  \"endDate\":        string,\n  \"skip\":           number,\n  \"take\":           number,\n  \"descending\":     boolean,\n  \"useTime\":        boolean\n}\n

Supplies the account number whose password is to be reset and landing page that the generated email uses to activate the new password.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
*accountNumber	string	16	16-Digit account number that uniquely identifies the mAccount.
startDate	string		Start date of transaction range to retrieve. In ISO 8601 date format. Note that Timezone is suppressed. The default Timezone is Sydney local time. If not set to a valid date then the 1 Jan 2013 is used. The Time component is ignored unless useTime is set to true.
endDate	string		End date of transaction range to retrieve. In ISO 8601 date format. Note that Timezone is suppressed. The default Timezone is Sydney local time. If not set the todays date is used. The Time component is ignored unless useTime is set to true.
skip	number		Number of records to skip. 0 is the first record.
take	number		Number of records to take. If take is 0 then all records will be returned.
descending	boolean		Sort the returned transaction list in ascending or descending.
useTime	boolean		Use the time component of startDate and endDate in the selection.
*Required Field

mAccountTransactionLineItem

{\n  \"transactionId\":          number,\n  \"rowOrder\":               number,\n  \"dateTime\":               string,\n  \"description\":            string,\n  \"transactionDescription\": string,\n  \"debit\":                  number,\n  \"credit\":                 number,\n  \"runningBalance\":         number,\n  \"mWalletAccountNumber\":   string,\n  \"transactionType\":        string,\n  \"subTransactionType\":     string,\n  \"mPaymentsId\":            number\n}\n

Represents a single line item or row on an mAccount statement. See mAccount/v1/transactions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
*transactionId	number	This is the transactionId that was returned from a financial transaction
*dateTime	string	The time the transaction occurred in ISO 8601 date format. Note that Timezone is suppressed. The default Timezone is Sydney local time.
*description	string	This is the description that was provided by the caller to the financial API with your unique reference prepended.
*transactionDescription	string	A small description describing the financial action
*debit	number	The amount of funds debited from the mAccount
*credit	number	The amount of funds credited from the mAccount
*runningBalance	number	The current balance of the mAccount at the end of this single row transaction
rowOrder	number	If you need to sort the results, only use this field. If you sort the results on any other field, the runningBalance won’t make sense. rowOrder start at 0.
mWalletAccountNumber	string	If funds were being moved to/from an mWallet, then this is the mWallets 16-Digit account number
transactionType	string	Major keyword describing the transaction. E.g. include Payment, LoadFunds, DailySettlement
subTransactionType	string	Minor keyword describing the transaction. E.g. GatewayMWalletCredit
mPaymentsId	number	This is the Platform internal Id for the row returned.
*Required Field

","event":[{"listen":"prerequest","script":{"id":"5c9f7ffd-ac9e-452a-bdff-8b8b7ed69160","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7eb4292a-f1ca-4ac1-bbf5-ab1be72e0311","type":"text/javascript","exec":[""]}}],"_postman_id":"bfe85ad1-22a5-3b7f-0533-26c310c26bcb","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]},"isInherited":true,"source":{"_postman_id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","name":"Moneytech Payments Platform","type":"collection"}}},{"name":"mWallet","item":[{"name":"/mWallet/v1/close","id":"6eda3a1c-f3e9-d453-8273-bf4606108510","request":{"method":"GET","header":[],"url":"https://api.m-pay.com.au/mWallet/v1/close/{accountNumber}/{pin}","description":"

This API will set an account to be closed and no further financial transactions can be performed upon it via the gateway.

300

\n","type":"text"},{"key":"*pin","value":"string","description":"

\n","type":"text"},{"key":"*name","value":"string","description":"

\n","type":"text"},{"key":"nickName","value":"string","description":"

\n","type":"text"},{"key":"*dateOfBirth","value":"string","type":"text"},{"key":"phone","value":"string","description":"

\n","type":"text"},{"key":"email","value":"string","description":"

300

\n","type":"text"},{"key":"allowDuplicates","value":"boolean","type":"text"},{"key":"options","value":" [mWalletOptionItem] ","type":"text"}]},"url":"{{url}}/mWallet/v1/create","description":"

This API creates a new mWallet.

This creation process has been mandated by BPAY Pty Ltd as part of the license to use BPAY as a payment method.

Ideally client software should mask the pin from the merchant and get the customer to key in the pin number twice to ensure accuracy and to maintain privacy. The pin and the Date of Birth Fields are the ultimate authentication fields that a customer has to allow the payment.

If the customer forgets their pin it can be reset using the ResetPin function. The customer must supply a birth date (or any other significant date) that matches the one that is registered. This is the only reason for asking the customer for this information.

Note: Though specified as a birth date any date of significance would be appropriate. There is no date range checking to check for age etc. The date is used to allow changes to the pin only.

This API will return the current financials for an mWallet.

This API returns an array of mWallets whose authentication fields match the search criteria specified by the identifier.

Mobile phone, land line and 16-Digit mWallet account numbers have all non-numbers stripped and email address is converted to lower case.

This is the first function to call when trying to identify a customer with an mWallet. The key piece of information returned for each mWallet is the unique accountNumber that is used in later calls and in the payment gateway.

This API will reopen an account that was closed

The 16-Digit mWallet account number to reset.

\n","type":"text"},{"key":"*pin","value":"string","description":"

4 digit numerical pin.

\n","type":"text"},{"key":"*dateOfBirth","value":"string","description":"

Birth date of customer or require field in ISO 8601 date format. Note that Timezone is suppressed. The default Timezone is Sydney local time.

\n","type":"text"}]},"url":"https://api.m-pay.com.au/mWallet/v1/resetPin","description":"

This API resets a customer accounts PIN. The Date of Birth is used to authenticate the user.

This API should be used when a customer has forgotten their pin.

The 16-Digit account number that uniquely identifies the mWallet.

\n","type":"text"},{"key":"*frequency","value":"string","description":"

An enumeration of fixed selection types. \nAll, \nThisMonth, \nLastMonth, \nThisFinancialYear, \nLastFinancialYear, \nCustom

\n","type":"text"},{"key":"startDate","value":"string","description":"

\n","type":"text"},{"key":"endDate","value":"string","description":"

\n","type":"text"}]},"url":"https://api.m-pay.com.au/mWallet/v1/sendStatement","description":"

This API generates a detailed pdf statement for delivery via email. An error code is returned if the mWallet does not have an associated email address.

16-Digit account number that uniquely identifies the mWallet.

\n","type":"text"},{"key":"*pin","value":"string","description":"

4 digit numerical pin.

\n","type":"text"},{"key":"startDate","value":"string","description":"

Start date of transaction range to retrieve. In ISO 8601 date format. Note that Timezone is suppressed. The default Timezone is Sydney local time. If not set to a valid date then the 1 Jan 2013 is used. The time component is ignored unless useTime is set to true.

\n","type":"text"},{"key":"endDate","value":"string","description":"

End date of transaction range to retrieve. In ISO 8601 date format. Note that Timezone is suppressed. The default Timezone is Sydney local time. If not set today’s date is used. The time component is ignored unless useTime is set to true.

\n","type":"text"},{"key":"skip","value":"number","description":"

Number of records to skip. 0 is the first record.

\n","type":"text"},{"key":"take","value":"number","description":"

Number of records to take. If take is 0 the all records will be returned.

\n","type":"text"},{"key":"descending","value":"boolean","description":"

Sort the returned transaction list ascending or descending.

\n","type":"text"},{"key":"useTime","value":"boolean","description":"

Use the time component of startDate and endDate in the selection.

\n","type":"text"}]},"url":"https://api.m-pay.com.au/mWallet/v1/transactions","description":"

This API will return an array of transactions for an mWallet between two dates. Paging is supported by using the skip and take properties of the mWalletTransactionRequestDetails class.

The information retrieved is in real-time and represents the same details as displayed on an mAccounts financial statement.

16-Digit mWallet account number to update.

\n","type":"text"},{"key":"*pin","value":"string","description":"

4 digit numerical pin.

\n","type":"text"},{"key":"*name","value":"string","description":"

Full name of customer.

\n","type":"text"},{"key":"nickName","value":"string","description":"

This is a short form name of the customer. Can be empty

\n","type":"text"},{"key":"phone","value":"string","description":"

Contact phone number. This is not used for authentication. Required field in conjunction with email address that must start with 0. All non-numbers are stripped.

\n","type":"text"},{"key":"email","value":"string","description":"

Contact email. This is not used for authentication. Limited to 300 characters. Required field in conjunction with phone and should contain @ and follow normal email format conventions. Converted to lowercase.

\n","type":"text"},{"key":"options","value":"[mWalletOptionItem]","description":"

See mWalletOptionItem class

\n","type":"text"}]},"url":"https://api.m-pay.com.au/mWallet/v1/update","description":"

This API updates an mWallet.

This update process has been mandated by BPAY Pty Ltd as part of the license to use BPAY as a payment method.

The pin or dateOfBirth Dates are not updateable.

This API will validate that an mWallet’s PIN is valid.

If the returned value of status is “OK” then the PIN is valid. If the value of status is “InvalidCustomerPin” the PIN is not valid.

Overview

These APIs do not perform any financial transactions. They are used manage mWallet information used by the Platform. The /financial/v1/transaction API verifies mAccount information using this subsystem before performing the transaction.

The mWallet/v1/ API support’s the following services:

mWallet/v1/close
mWallet/v1/create
mWallet/v1/financials
mWallet/v1/search
mWallet/v1/reopen
mWallet/v1/resetPin
mWallet/v1/sendStatement
mWallet/v1/transactions
mWallet/v1/update
mWallet/v1/validatePin

The following APIs require an mWallet holders 4 digit PIN for authorisation:

mWallet/v1/close
mWallet/v1/financials
mWallet/v1/reopen
mWallet/v1/transactions
mWallet/v1/update
mWallet/v1/validatePin

Objects

mWalletCreate

{\n  \"identfier\":     string,\n  \"pin\":         string,\n  \"name\":       string,\n  \"nickName\":     string,\n  \"dateOfBirth\":     string,\n  \"phone\":       string,\n  \"email\":       string,\n  \"allowDuplicates\":  boolean,\n  \"options\":       [\n              WalletOptionItem\n               ]\n}\n

Provides information to create an mWallet.

Note:

 Either a phone number, or an email, are required. If a phone number is used then an email is not required and vice versa.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
*identifier	string	300
*pin	string	4
*name	String	50
nickName	string	20
*dateOfBirth	string
phone	string	11
email	string	300
allowDuplicates	boolean
options	[mWalletOptionItem]
*Required Field

mWalletDetails

{\n  \"createdDateTime\":         string,\n  \"accountNumber\":         string,\n  \"allowDuplicates\":         boolean,\n  \"name\":             string,\n  \"nickName\":           string,\n  \"email\":             string,\n  \"mobile\":             string,\n  \"lastTransactionDate\":       string,\n  \"contactPhone\":         string,\n  \"authenticationEmail\":       string,\n  \"authenticationMobile\":     string,\n  \"authenticationLandLine\":     string,\n  \"registeredByMAccountNumber\":   string,\n  \"isOnHold\":           boolean,\n  \"isClosed\":           boolean,\n  \"isStolen\":           boolean,\n  \"isLockedToMerMAccountNumber\":   string,\n  \"isRegistered\":         boolean,\n  \"financials\":           mWalletFinancials,\n  \"options\":             [\n                    mWalletOptionItem\n                    ]\n}\n

Provides customer detail information as the result of the search operation.

Field Name	Type	Description
createdDateTime	string
accountNumber	string	16
name	string	50
nickName	string	20
email	string	300
mobile	string	15
lastTransactionDate	string
contactPhone	string	15
authenticationEmail	string	300
authenticationMobile	string	15
authenticationLandLine	string	15
registeredByMAccountNumber	string	16
isOnHold	boolean	The customer’s account has been put on hold
isClosed	boolean	The customer’s account has been closed
isRegistered	boolean
financials	mWalletFinancials
options	[mWalletOptionItem]
*Required Field

mWalletFinancials

{\n  \"actualBalance\":  number,\n  \"availableSpend\":  number,\n  \"availableLoad\":  number\n}\n

Provides current mWallet financial values

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
actualBalance	number	Current remaining balance on the mWallet account
availableSpend	number	The amount of funds that can be debited from the mWallet at this time before exceeding ASIC daily limit
availableLoad	number	The amount of funds that can be credited to the mWallet before exceeding ASIC limit

mWalletOptionItem

{\n  \"key\":    string,\n  \"value\":  string\n}\n\n

An mWalletOptionItem represents a key/value pair of configuration options that apply to a particular mWallet.

Note

If value is an empty string, the option represented by the key is set to its default value.
If the key is omitted from the array, the option represented by the key is left as is.
An invalid key or value will result in an error.
key is case insensitive

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
key	string	Unique identifier of the value. See Key Definitions table below
value	string	The actual value represented by the Key

Key Definitions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Range	Description
SendDailyStatement	“true” or “false”	Set to “true” if you would like a daily statement automatically sent to the Email address of the mAccount. If the mAccount has no transactions for the period, no statement is sent.
SendMonthlyStatement	“true” or “false”	Set to “true” if you would like a Monthly statement automatically sent to the Email address of the mAccount. Sent on the 1st of each month for the previous month. If the mAccount has no transactions for the period, no statement is sent.
MobileForSms	“0414111111”	Mobile number to use for receiving SMS notifications

mWalletSelectionFilter

{\n  \"accountNumber\":  string,\n  \"frequency\":     string,\n  \"startDate\":     string,\n  \"endDate\":       string\n}\n

Provides current mWallet financial values

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
*accountNumber	string	The 16-Digit account number that uniquely identifies the mWallet.
*frequency	string	An enumeration of fixed selection types. All, ThisMonth, LastMonth, ThisFinancialYear, LastFinancialYear, Custom
startDate	string	Start date of statement when the frequency is set to custom. In ISO 8601 date format. Note that Timezone is suppressed. The default Timezone is Sydney local time. Required field when frequency is set to custom.
endDate	string	End date of statement when the frequency is set to custom. In ISO 8601 date format. Note that Timezone is suppressed. The default Timezone is Sydney local time. Required field when frequency is set to custom.
*Required Field

mWalletResetPin

{\n  \"accountNumber\":  string,\n  \"pin\":         string,\n  \"dateOfBirth\":    string\n}\n

Provides customer information for mWallet creation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
*accountNumber	string	16	The 16-Digit mWallet account number to reset.
*pin	string	4	4 digit numerical pin.
*dateOfBirth	string		Birth date of customer or require field in ISO 8601 date format. Note that Timezone is suppressed. The default Timezone is Sydney local time.
*Required Field

mWalletUpdate

{\n  \"accountNumber\":  string,\n  \"pin\":         string,\n  \"name\":       string,\n  \"nickName\":     string,\n  \"phone\":       string,\n  \"email\":       string,\n  \"options\":       [\n              mWalletOptionItem\n              ]\n}\n

Provides customer information for mWalletupdate

Note:

Either a phone number, or an email, is required. If a phone number is used an email is not required and vice versa.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
*accountNumber	string	16	16-Digit mWallet account number to update.
*pin	string	4	4 digit numerical pin.
*name	string	50	Full name of customer.
nickName	string	20	This is a short form name of the customer. Can be empty
phone	string	11	Contact phone number. This is not used for authentication. Required field in conjunction with email address that must start with 0. All non-numbers are stripped.
email	string	300	Contact email. This is not used for authentication. Limited to 300 characters. Required field in conjunction with phone and should contain @ and follow normal email format conventions. Converted to lowercase.
options	[mWalletOptionItem]		See mWalletOptionItem class

mWalletTransactionLineItem

{\n  \"transactionId\":    number,\n  \"rowOrder\":        number,\n  \"dateTime\":        string,\n  \"description\":      string,\n  \"debit\":        number,\n  \"credit\":        number,\n  \"runningBalance\":    number,\n  \"mAccountName\":      string,\n  \"transactionType\":    string,\n  \"subTransactionType\":  string,\n  \"mPaymentsId\":      number\n}\n

Represents a single line item or row on an mWallet statement. See mWallet/v1/transactions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
transactionId	number	This is the transactionId that was returned from a financial transaction
*dateTime	string	The time the transaction occurred in ISO 8601 date format. Note that Timezone is suppressed. The default Timezone is Sydney local time.
*description	string	This is the description that was passed in by the calling financial API call
*debit	number	The amount of funds debited from the mWallet
*credit	number	The amount of funds credited to the mWallet
*runningBalance	number	The current balance of the mAccount at the end of this single row transaction
rowOrder	number	If you need to sort the results, only use this field. If you sort the results on any other field, the runningBalance won’t make sense. rowOrder start at 0.
*mAccountName	string	Name of the mAccount that conducted the transaction
transactionType	string	Major keyword describing the transaction. E.g. include Payment, LoadFunds
subTransactionType	string	Minor keyword describing the transaction. E.g. GatewayMWalletCredit
mPaymentsId	number	This is the Platform internal Id for the row returned.
*Required Fields

mWalletTransactionRequestDetails

{\n  \"accountNumber\":   string,\n  \"pin\":         string,\n  \"startDate\":     string,\n  \"endDate\":       string,\n  \"skip\":       number,\n  \"take\":       number,\n  \"descending\":     boolean,\n  \"useTime\":       boolean\n}\n

Represents a single line item or row on an mWallet statement. See mWallet/v1/transactions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Max Size	Description
*accountNumber	string	16	16-Digit account number that uniquely identifies the mWallet.
*pin	string	4	4 digit numerical pin.
startDate	string		Start date of transaction range to retrieve. In ISO 8601 date format. Note that Timezone is suppressed. The default Timezone is Sydney local time. If not set to a valid date then the 1 Jan 2013 is used. The time component is ignored unless useTime is set to true.
endDate	string		End date of transaction range to retrieve. In ISO 8601 date format. Note that Timezone is suppressed. The default Timezone is Sydney local time. If not set today's date is used. The time component is ignored unless useTime is set to true.
skip	number		Number of records to skip. 0 is the first record.
take	number		Number of records to take. If take is 0 the all records will be returned.
descending	boolean		Sort the returned transaction list ascending or descending.
useTime	boolean		Use the time component of startDate and endDate in the selection.
*Required Fields

","event":[{"listen":"prerequest","script":{"id":"143fcc96-e5cc-4f1c-8f9e-ffb6dac0d787","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b291a579-fed6-4444-baa7-b5f54531fcb3","type":"text/javascript","exec":[""]}}],"_postman_id":"805471ad-1acc-e9eb-add1-cd92fdf8f2b4","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]},"isInherited":true,"source":{"_postman_id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","id":"49b57ee7-7e16-12d2-98d5-9a49d4a5e118","name":"Moneytech Payments Platform","type":"collection"}}}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"6efc65b3-4e4b-4adc-8f87-c332bdbd10ae","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"663b8a1c-6b10-4f86-878b-8b1591db5ebe","type":"text/javascript","exec":[""]}}]}

Overview

What is an mWallet and mAccount?

mWallet

mAccount

Direct Debit and Direct Credit

Settlement

Settlement Frequency

Deferred Settlement - T+n

Settlement Notifications

Sample Settlement Email

Sample PDF Settlement Statement

Sample Excel Settlement Spreadsheet

Financial Statements

Example – mAccount Month To Date Financial Statement

Tokens

Relationship Between Sign-In Account, mAccount, mWallet & Tokens

A Practical Example

Scenario

Solution

Sign-In Account Liability

Debiting via Direct Debit or mAccount

Debiting via Credit-Card

Debiting via an mWallet

Why are the Sign-In Accounts liable and what other options are there?

Legal Requirements

Authentication

UserName/Password

SecurityToken

OneShotSecurityToken

Testing

Staging Authentication Credentials

Staging Test Credit-Cards

Direct Debit Authorisation Forms

Example 1 - Credit-Card -> mWallet

Statement

Example 2 – Credit-Card -> mAccount

Statement

Example 3 – Credit-Card -> Direct Credit

Statement

Example 4 – Credit-Card -> BPAY

Statement

Example 5 – mWallet -> mWallet

Statement

Example 6 – Direct Debit -> mWallet & mAccount

Statement

Example 7 – directDebit -> directCredit

Overview

Objects

AustralianBankAccount

BpayDetails

BpayDisbursementItem

BpayReceiptItem

CreditCardDetails

DirectCreditDisbursementItem

DisbursementFeeItem

FeeBreakdownDetail

FeeDetailItem

MAccountDetails

Overview

Objects

BPAYBiller

BPAYBillerList

BPAYHistoryItem

BPAYValidation

Bank Account Ownership Verification

Overview

Objects

SettlementItem

TransactionItem

Overview

Overview

Objects

TokenPayloadBase

TokenAustralianBankAccountPayload

TokenBPAYPayload

TokenCreditCardPayload

TokenDetails

Overview

Objects

CreditCardFee