Overview mWallet is the name we have given to the digital wallet required for our BPAY payments. For any other digital-wallet uses, we recommend our mAccount. The APIs in this section do not perform any financial transactions. They are used to manage mWallet information used by the Engine. The /financial/v2/transaction API verifies mWallet information using this subsystem before performing the transaction.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/monoova-mwallet-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
description: '# Introduction
Monoova has developed a powerful payments engine which allows you to receive, manage and pay funds in AUD in Australia automatically.'
version: v5.29
title: Monoova Payments M Wallet API
contact:
name: Monoova Support
email: support@monoova.com
url: https://www.monoova.com
x-logo:
url: https://movdpwebsiteprodae.blob.core.windows.net/images/Monoova-Primary-Logo-Black-RGB.png
altText: Monoova logo
servers:
- url: https://api.mpay.com.au
description: Production URL
- url: https://api.m-pay.com.au
description: Sandbox URL
security:
- BasicAuth: []
tags:
- name: mWallet
description: 'Overview
mWallet is the name we have given to the digital wallet required for our BPAY payments. For any other digital-wallet uses, we recommend our mAccount. The APIs in this section do not perform any financial transactions. They are used to manage mWallet information used by the Engine. The /financial/v2/transaction API verifies mWallet information using this subsystem before performing the transaction.'
paths:
/mWallet/v1/create:
post:
tags:
- mWallet
summary: Create an mWallet
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 then 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. If a customer queries why a birth date is needed as part of the registration process then it is for this reason. 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.'
operationId: MWalletCreate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/mWallet.create'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DTO.mWalletCreateResponse_V1'
'400':
description: Bad request
'500':
description: Internal Server Error
/mWallet/v1/close/{accountNumber}/{pin}:
get:
tags:
- mWallet
summary: Close an mWallet
description: This API will set an account to be closed and no further financial transactions can be performed in the Engine.
operationId: MWalletClose_V1
parameters:
- name: accountNumber
in: path
required: true
description: 16-Digit account number that uniquely identifies the mWallet
schema:
type: integer
example: 6279059700011434
maxLength: 16
minLength: 16
- name: pin
in: path
required: true
description: 4 digit numerical pin.
schema:
type: integer
example: 6666
maxLength: 4
minLength: 4
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DTO.mWalletCloseResponse_V1'
'400':
description: Bad request
'500':
description: Internal Server Error
/mWallet/v1/financials/{accountNumber}/{pin}:
get:
tags:
- mWallet
summary: Get mWallet Balance
description: This API will return the current financials for an mWallet.
operationId: MWalletGetFinancials
parameters:
- name: accountNumber
in: path
required: true
description: 16-Digit account number that uniquely identifies the mWallet
schema:
type: integer
example: 6279059700011434
maxLength: 16
minLength: 16
- name: pin
in: path
required: true
description: 4 digit numerical pin.
schema:
type: integer
example: 6666
maxLength: 4
minLength: 4
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DTO.mWalletGetFinancialsResponse_V1'
'400':
description: Bad request
'500':
description: Internal Server Error
/mWallet/v1/reopen/{accountNumber}/{pin}:
get:
tags:
- mWallet
summary: Reopen a closed mWallet
description: This API will reopen an mWallet that was closed.
operationId: MWalletReopen
parameters:
- name: accountNumber
in: path
required: true
description: 16-Digit account number that uniquely identifies the mWallet
schema:
type: string
example: 6279059700011434
maxLength: 16
minLength: 16
- name: pin
in: path
required: true
description: 4 digit numerical pin.
schema:
type: integer
example: 6666
maxLength: 4
minLength: 4
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DTO.mWalletReopenResponse_V1'
'400':
description: Bad request
'500':
description: Internal Server Error
/mWallet/v1/resetPin:
post:
tags:
- mWallet
summary: Reset an mWallet PIN
description: This API resets a customer's mWallet PIN. The Date of Birth is used to authenticate the user. This API should be used when a customer has forgotten their pin.
operationId: MWalletResetPin
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/mWallet.resetPin'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DTO.mWalletResetPinResponse_V1'
'400':
description: Bad request
'500':
description: Internal Server Error
/mWallet/v1/search:
get:
tags:
- mWallet
summary: mWallet search
description: 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.
operationId: MWalletSearch
parameters:
- name: identifier
in: query
required: false
description: Mobile phone number, email address, landline number or the 16-Digit mWallet account number
schema:
type: string
example: 0414811109
maxLength: 300
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DTO.mWalletSearchResponse_V1'
'400':
description: Bad request
'500':
description: Internal Server Error
/mWallet/v1/transactions:
post:
tags:
- mWallet
summary: Get transactions by mWallet
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.
operationId: MWalletTransactions
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/mWallet.transactions'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DTO.mWalletTransactionsResponse_V1'
'400':
description: Bad request
'500':
description: Internal Server Error
/mWallet/v1/update:
post:
tags:
- mWallet
summary: Update mWallet details
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 updatable.
operationId: MWalletUpdate
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/mWallet.update'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DTO.mWalletUpdateResponse_V1'
'400':
description: Bad request
'500':
description: Internal Server Error
components:
schemas:
DTO.mWalletDetails:
properties:
createdDateTime:
description: Date that this customer was created.ISO 8601 date-time format.Note that Timezone is suppressed.The example Timezone is Sydney local time
type: string
example: '2017-01-19T14:26:14'
uniqueItems: false
accountNumber:
description: 16-Digit account number that uniquely identifies the customer
type: string
example: '6279059700022400'
uniqueItems: false
name:
description: Customers full name
type: string
example: Kelly
uniqueItems: false
nickName:
description: This is a short form name of the customer
type: string
example: Kel
uniqueItems: false
email:
description: Email address of the customer
type: string
example: mPayments@monoova.com
uniqueItems: false
mobile:
description: Mobile phone number of the customer
type: string
example: 0414811110
uniqueItems: false
lastTransactionDate:
description: Date of the last transaction that the customer performed. ISO 8601 date format. This is an empty string if no transactions.Note that Timezone is suppressed.The example Timezone is Sydney local time
type: string
uniqueItems: false
contactPhone:
description: Contact phone number for customer. Can be a mobile or landline
type: string
example: 0414 555 555
uniqueItems: false
authenticationEmail:
description: Unique email address used to authenticate customer. Can be null
type: string
example: mPayments@monoova.com
uniqueItems: false
authenticationMobile:
description: Unique mobile number used to authenticate customer. Can be null
type: string
example: 0414811110
uniqueItems: false
authenticationLandLine:
description: Unique telephone number used to authenticate customer. Can be null
type: string
example: 'null'
uniqueItems: false
registeredByMAccountNumber:
description: 16-Digit account number of the mAccount who created the customer
type: string
example: '6279059700000810'
uniqueItems: false
isOnHold:
description: The customer’s account has been put on hold
type: boolean
example: false
uniqueItems: false
isClosed:
description: The customer’s account has been closed
type: boolean
example: false
isStolen:
type: boolean
example: false
isRegistered:
description: The mWallet is registered and is able to purchase restricted itemsfrom the mAccount such as BPAY
type: boolean
example: true
financials:
$ref: '#/components/schemas/DTO.mWalletFinancials'
options:
description: mWalletOptionItem
type: array
items:
$ref: '#/components/schemas/DTO.mWalletOptionItem'
uniqueItems: false
type: object
DTO.mWalletGetFinancialsResponse_V1:
properties:
durationMs:
description: 'This value represents the total time in milliseconds that the Platform took to process the request. '
type: integer
format: int64
example: 20
uniqueItems: false
status:
description: This is the status of executing the request. A code of ‘Ok’ indicates no errors
type: string
example: Ok
uniqueItems: false
statusDescription:
description: This is a plain English description of the status.
type: string
example: Operation completed successfully
uniqueItems: false
financials:
$ref: '#/components/schemas/DTO.mWalletFinancials'
type: object
format: DTO.mWalletGetFinancialsResponse_V1
mWallet.resetPin:
type: object
required:
- accountNumber
- pin
- dateOfBirth
properties:
accountNumber:
type: string
uniqueItems: true
example: '6279059700011434'
minLength: 16
maxLength: 16
description: The 16-Digit mWallet account number to reset.
pin:
type: number
uniqueItems: true
example: '5555'
minLength: 4
maxLength: 4
description: 4 digit numerical pin.
dateOfBirth:
type: string
format: date-time
uniqueItems: false
example: '1990-01-01T12:00:00'
description: Birth date of customer or require field in ISO 8601 date-time format. Note that Timezone is suppressed. The default Timezone is Sydney local time.
DTO.mWalletFinancials:
properties:
actualBalance:
description: Current remaining balance on the mWalletaccount
type: number
format: decimal
example: '0'
uniqueItems: false
availableSpend:
description: The amount of funds that can be debited from the mWallet
type: number
format: decimal
example: '3000'
uniqueItems: false
availableLoad:
description: The amount of funds that can be credited to the mWallet
type: number
format: decimal
example: '3000'
uniqueItems: false
type: object
DTO.mWalletCreateResponse_V1:
properties:
durationMs:
description: 'This value represents the total time in milliseconds that the Platform took to process the request. '
type: integer
format: int64
example: 20
uniqueItems: false
status:
description: This is the status of executing the request. A code of ‘Ok’ indicates no errors
type: string
example: Ok
uniqueItems: false
statusDescription:
description: This is a plain English description of the status.
type: string
example: Operation completed successfully
uniqueItems: false
accountNumber:
description: New 16 character mWallet account number
type: string
example: '6279052236217305'
uniqueItems: false
mWallet:
$ref: '#/components/schemas/DTO.mWalletDetails'
type: object
format: DTO.mWalletCreateResponse_V1
DTO.mWalletTransactionLineItem:
properties:
rowOrder:
description: 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.
type: integer
format: int32
example: '0'
uniqueItems: false
mPaymentsId:
description: This is the Platform internal Id for the row returned
type: integer
format: int32
example: '2303203'
uniqueItems: false
transactionId:
description: This is the transactionId that was returned from a financial transaction
type: integer
format: int32
example: '4958475'
uniqueItems: false
dateTime:
description: The time the transaction occurred in ISO 8601 date-time format. Note that Timezone is suppressed. The example Timezone is Sydney local time
type: string
example: '2017-11-18T19:06:09'
uniqueItems: false
mAccountName:
description: Name of the mAccount that conducted the transaction
type: string
example: '6279059600052340'
uniqueItems: false
transactionType:
description: Major keyword describing the transaction. E.g. include Payment, LoadFunds, DailySettlement
type: string
example: LoadFunds
uniqueItems: false
subTransactionType:
description: Minor keyword describing thetransaction. E.g. GatewayMWalletCredit
type: string
example: GatewayMWalletCredit
uniqueItems: false
credit:
description: The amount of funds credited from the mWallet
type: number
format: decimal
example: '0'
uniqueItems: false
debit:
description: The amount of funds debited from the mWallet
type: number
format: decimal
example: '25'
uniqueItems: false
runningBalance:
description: The current balance of the mAccount at the end of this single row transaction
type: number
format: decimal
example: '0'
uniqueItems: false
description:
description: This is the description that was provided by the caller to the financial API with your unique reference prepended
type: string
example: 0bbae2f1-428a-4843-0b3e4bc. - test description
uniqueItems: false
type: object
format: DTO.mWalletTransactionLineItem
mWallet.update:
type: object
required:
- accountNumber
- pin
- name
properties:
accountNumber:
type: string
uniqueItems: true
example: '6279059736211111'
minLength: 16
maxLength: 16
description: 16-Digit mWallet account number to update.
pin:
type: number
uniqueItems: false
example: '5555'
minLength: 4
maxLength: 4
description: 4 digit numerical pin.
name:
type: string
uniqueItems: false
example: mPayments Retail
description: Full name of customer.
nickName:
type: string
uniqueItems: false
example: mPayments
description: This is a short form name of the customer. Can be empty
phone:
type: number
uniqueItems: false
example: 0414 555 555
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.
email:
type: string
uniqueItems: false
example: mPayments@monoova.com
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.
abn:
description: Company ABN of the mAccount. All non numbers are stripped
type: string
example: '77106249852'
uniqueItems: false
options:
type: array
items:
$ref: '#/components/schemas/mWallet.create.options'
DTO.mWalletUpdateResponse_V1:
properties:
durationMs:
description: 'This value represents the total time in milliseconds that the Platform took to process the request. '
type: integer
format: int64
example: 20
uniqueItems: false
status:
description: This is the status of executing the request. A code of ‘Ok’ indicates no errors
type: string
example: Ok
uniqueItems: false
statusDescription:
description: This is a plain English description of the status.
type: string
example: Operation completed successfully
uniqueItems: false
mWallet:
$ref: '#/components/schemas/DTO.mWalletDetails'
type: object
format: DTO.mWalletUpdateResponse_V1
DTO.mWalletOptionItem:
properties:
key:
description: Unique identifier of the value.
type: string
example: MobileForSms
enum:
- MobileForSms
uniqueItems: false
value:
description: The actual value represented by the Key
type: string
example: '0414123123'
uniqueItems: false
type: object
DTO.mWalletTransactionsResponse_V1:
properties:
durationMs:
description: 'This value represents the total time in milliseconds that the Platform took to process the request. '
type: integer
format: int64
example: 20
uniqueItems: false
status:
description: This is the status of executing the request. A code of ‘Ok’ indicates no errors
type: string
example: Ok
uniqueItems: false
statusDescription:
description: This is a plain English description of the status.
type: string
example: Operation completed successfully
uniqueItems: false
openingBalance:
description: Opening balance of the mWalletfor the returned items
type: number
format: decimal
example: '0'
uniqueItems: false
closingBalance:
description: Closing balance of the mWalletfor the returned items
type: number
format: decimal
example: '0'
uniqueItems: false
totalDebits:
description: Total debits for the returned items
type: number
format: decimal
example: '25'
uniqueItems: false
totalCredits:
description: Total credits for the returned items
type: number
format: decimal
example: '25'
uniqueItems: false
items:
description: mWalletTransactionLineItem
type: array
items:
$ref: '#/components/schemas/DTO.mWalletTransactionLineItem'
uniqueItems: false
type: object
format: DTO.mWalletTransactionsResponse_V1
DTO.mWalletResetPinResponse_V1:
properties:
durationMs:
description: 'This value represents the total time in milliseconds that the Platform took to process the request. '
type: integer
format: int64
example: 20
uniqueItems: false
status:
description: This is the status of executing the request. A code of ‘Ok’ indicates no errors
type: string
example: Ok
uniqueItems: false
statusDescription:
description: This is a plain English description of the status.
type: string
example: Operation completed successfully
uniqueItems: false
type: object
format: DTO.mWalletResetPinResponse_V1
mWallet.create.options:
type: object
title: MobileForSms
properties:
key:
description: Unique identifier of the value. this is to use for receiving SMS notifications.
type: string
example: MobileForSms
enum:
- MobileForSms
value:
description: The actual value represented by the Key.
type: number
example: '0414123123'
enum:
- 70297171
mWallet.transactions:
type: object
required:
- accountNumber
- pin
properties:
accountNumber:
type: string
uniqueItems: true
example: '6279059700022400'
minLength: 16
maxLength: 16
description: The 16-Digit number that uniquely identifies the Ledger Account or mWallet.
pin:
type: number
uniqueItems: true
example: '5555'
minLength: 4
maxLength: 4
description: 4 digit numerical pin.
startDate:
type: string
format: date-time
example: '2018-07-11T00:00:00'
description: Start date of statement when the frequency is set to custom. In ISO 8601 date-time format. Note that Timezone is suppressed. The default Timezone is Sydney local time. Required field when frequency is set to custom.
endDate:
type: string
format: date-time
example: '2018-02-28T00:00:00'
description: End date of statement when the frequency is set to custom. In ISO 8601 date-time format. Note that Timezone is suppressed. The default Timezone is Sydney local time. Required field when frequency is set to custom.
skip:
type: number
uniqueItems: true
example: '0'
description: Number of records to skip. 0 is the first record.
take:
type: number
uniqueItems: true
example: '50'
description: Number of records to take. If take is 0 the all records will be returned.
descending:
type: boolean
example: false
description: Sort the returned transaction list ascending or descending.
useTime:
type: boolean
example: false
description: Use the time component of startDate and endDate in the selection.
DTO.mWalletSearchResponse_V1:
properties:
durationMs:
description: 'This value represents the total time in milliseconds that the Platform took to process the request. '
type: integer
format: int64
example: 20
uniqueItems: false
status:
description: This is the status of executing the request. A code of ‘Ok’ indicates no errors
type: string
example: Ok
uniqueItems: false
statusDescription:
description: This is a plain English description of the status.
type: string
example: Operation completed successfully
uniqueItems: false
mWallets:
description: Array of WalletDetails
type: array
items:
$ref: '#/components/schemas/DTO.mWalletDetails'
uniqueItems: false
type: object
format: DTO.mWalletSearchResponse_V1
mWallet.create:
type: object
required:
- identifier
- pin
- name
- dateOfBirth
properties:
identifier:
type: string
uniqueItems: true
example: '0200000000'
maxLength: 300
description: Email address, Telephone number, landline number or mWallet account number.
pin:
type: number
uniqueItems: false
example: '0000'
minLength: 4
maxLength: 4
description: 4 digit numerical pin.
name:
type: string
uniqueItems: false
example: Sample mWallet Name
maxLength: 50
description: Full name of customer.
nickName:
type: string
uniqueItems: false
example: Your mWallet Nickname
maxLength: 20
description: This is a short form name of the customer. Can be empty.
dateOfBirth:
type: string
format: date-time
uniqueItems: false
example: '1990-01-01T12:00:00'
description: Birth date of customer or require field in ISO 8601 date-time format. Note that Timezone is suppressed. The default Timezone is Sydney local time.
phone:
type: number
uniqueItems: false
example: 0414 555 555
maxLength: 11
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. <br/>Phone numbers are validated with google’s common <a href="https://github.com/google/libphonenumber" target='_blank' rel="noopener noreferrer">library</a>. Numbers that can't be validated as correct cannot be used in mWallet creation. A test tool for the validation routine can be found <a target='_blank' href="https://libphonenumber.appspot.com/" rel="noopener noreferrer">here</a>.
email:
type: string
uniqueItems: false
example: walletuser@monoova.com
maxLength: 300
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. This email address is used to email the customer receipts for BPAY transactions.
allowDuplicates:
type: boolean
uniqueItems: true
example: false
description: If true, allow the creation of a duplicate mWallet of any identifier type.
abn:
description: Company ABN of the mAccount. All non numbers are stripped
type: string
example: '77106249852'
uniqueItems: false
options:
type: array
items:
anyOf:
- $ref: '#/components/schemas/mWallet.create.options'
DTO.mWalletCloseResponse_V1:
properties:
durationMs:
description: 'This value represents the total time in milliseconds that the Platform took to process the request. '
type: integer
format: int64
example: 20
uniqueItems: false
status:
description: This is the status of executing the request. A code of ‘Ok’ indicates no errors
type: string
example: Ok
uniqueItems: false
statusDescription:
description: This is a plain English description of the status.
type: string
example: Operation completed successfully
uniqueItems: false
type: object
format: DTO.mWalletCloseResponse_V1
DTO.mWalletReopenResponse_V1:
properties:
durationMs:
description: 'This value represents the total time in milliseconds that the Platform took to process the request. '
type: integer
format: int64
example: 20
uniqueItems: false
status:
description: This is the status of executing the request. A code of ‘Ok’ indicates no errors
type: string
example: Ok
uniqueItems: false
statusDescription:
description: This is a plain English description of the status.
type: string
example: Operation completed successfully
uniqueItems: false
type: object
format: DTO.mWalletReopenResponse_V1
securitySchemes:
BasicAuth:
type: http
scheme: basic
x-tagGroups:
- name: Receive and Pay
tags:
- Financial
- Verify
- Automatcher (Bank Account Receivables)
- Whitelisting for Automatcher (Bank Account Receivables)
- Ledger Account
- Reconciliation Rules
- PayID
- Tools
- name: BPAY
tags:
- BPAY
- mWallet
- name: Manage
tags:
- Subscriptions
- Webhooks
- mAccount
- Reports
- Security
- Token
- name: Public Endpoints
tags:
- Public Endpoints