\n Monoova has developed a powerful payments engine which allows you to receive, manage and pay funds in AUD in Australia automatically.\n This service is made available to Monoova’s clients through a set of easy-to-use RESTful APIs with JSON payloads described in this document.\n The central idea is to reduce the cost, risk and effort normally associated with managing complex money movements so that you can focus on growing your business.\n
\n\n Our clients can receive and reconcile funds via Realtime transfers (NPP), direct credits/debits, BPAY and cards. \n They can then manage those funds by building virtual account/wallet hierarchies to get bespoke reporting, reconciliation and much more. \n And finally, our clients can pay funds via Realtime transfers (NPP) direct credits and BPAY. \n As new technologies become available (e.g. NPP Mandated payments) we will make additional methods of receiving, managing and paying available.\n
\n\n All information flows are real-time.\n Moving money between various Monoova accounts is also real time.\n All money flows in and out of the Engine are as fast as the banking system allows.\n
\n\n The sandbox environment is open to everyone who signs up on our Sandbox Portal at no cost.\n The sandbox environment allows you to test out the functionality of our API in a consequence free development environment.\n Access to the live environment is granted once you have (1) gone through our compliance process and (2) had formal sign-off on your sandbox integration.\n
\n\n Monoova regularly releases additive changes to our API, as well as new versions of the API when a breaking change would occur. \n To ensure your integration does not break due to these additive changes, we recommend not validating the entire schema, or the position of a parameter within the schema.\n
\nNote: Please note we do not accept TLS 1.0 or 1.1 connections
\n\n# Getting started\n>\n - Sign on to our Sandbox Portal\n - Get your sandbox API key under **MANAGE > ACCOUNTS** in the Sandbox Portal\n - [Authenticate](#section/Authentication)\n - Browse this document to find the functions you need\n - Begin experimenting with your first API calls by sending HTTP requests to the endpoints described in this document\n - Use the provided examples in the document as guidance\n\n# Authentication\n All RESTful APIs in this document use BASIC Authentication (except those in public/v1) in two scenarios either\n - API KEY \n - OneShotSecurityToken| Field | \nValue | \n
|---|---|
| Username | \nAPI Key (obtained from the Sandbox Portal) | \n
| Password | \nleave blank when using API key; Monoova will provide password for OneShotSecurityToken | \n
| Base URL | \nhttps://api.m-pay.com.au/ | \n
| Field | \nValue | \n
|---|---|
| Username | \nAPI Key (obtained from the Production Portal; Production credentials will be supplied by Monoova) | \n
| Password | \nleave blank when using API key; Monoova will provide password for OneShotSecurityToken | \n
| Base URL | \nhttps://api.mpay.com.au/ | \n
Having customers paying you by bank transfer might be easy for your customers but contains a reconciliation risk for you. If your customer mistypes or forgets the reference to go with the payment, you might not know whom the payment is from. Orphaned transactions can be challenging and costly to handle. The solution is our receivables API. We allow you to assign a specific account number to each payer so you know for a fact where the received funds originated, regardless of whether they remembered to type the reference.
Specifically, the bank-account receivables APIs allow the creation and maintenance of bank account numbers for the purpose of receiving and reconciling funds via direct credit. Once an account number is created, payments may be made via any banking institution in Australia to the BSB and account number provided by us to you. These account numbers can be toggled active/inactive and linked to a client provided unique ID. Once a transaction is received, Monoova provides reporting on the details of each item, and makes the funds available for disbursement in your Sign-in mAccount. Authentication is the same as for the rest of Monoova’s APIs.
paths: /receivables/v1/create: post: tags: - Automatcher (Bank Account Receivables) summary: Create an Automatcher (Receivables) Account description: Creates a new bank-account number. For the creation of batches of account numbers, please see /receivables/v1/batchCreate These account numbers can be used along with the returned BSB to receive payments from any bank in Australia. Payments to an invalid bank-account number, i.e. one that has not been created, will be returned by Monoova to the remitting institution. Each account number has a check digit to minimize common payer errors such as adjacent transposition errors or single-digit typos. An optional unique ID can be linked to each account number for your reference. If a unique ID is not provided, Monoova will generate and return one automatically. If isActive is omitted, it will default to false. This can be changed to true via the /receivables/v1/status endpoint. operationId: ReceivablesCreate requestBody: content: application/json: schema: $ref: '#/components/schemas/receivables.create' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/receivablesCreateResponse_V1' '400': description: Bad request '500': description: Internal Server Error /receivables/v1/status: post: tags: - Automatcher (Bank Account Receivables) summary: Set Account Status description: Bank accounts can be active or inactive. Inactive accounts will have all payments rejected and returned to the payer. Status can be called using either bank account number or clientuniqueId. operationId: ReceivablesStatus requestBody: content: application/json: schema: $ref: '#/components/schemas/receivables.status' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/receivablesStatusSetResponse_V1' '400': description: Bad request '500': description: Internal Server Error /receivables/v1/statusByBankAccount/{bankAccountNumber}: get: tags: - Automatcher (Bank Account Receivables) summary: Get Account Status By BankAccount description: Returns the status of a bank account number. Without changing the status, this API is used for checking the status of a bank account. Status can be called using either bankaccount number or clientUniqueId. operationId: ReceivablesStatusByBank parameters: - name: bankAccountNumber in: path required: true description: The bank account number generated. schema: example: '153884104' type: string - name: bsb in: query required: false description: Optional BSB parameter specifying the branch identifier for Australian banks. Accepts either 6 digits or with a hyphen as "XXX-XXX". If not specified, the service will use the MAccount’s configured ‘Default BSB’. If a ‘Default BSB’ has not been configured, then the Monoova ‘Default BSB’ will be used. schema: type: string maxLength: 7 example: 802-985 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/receivablesStatusGetResponse_V1' '400': description: Bad request '500': description: Internal Server Error /receivables/v1/statusByClientID/{clientUniqueId}: get: tags: - Automatcher (Bank Account Receivables) summary: Get Account Status By ClientUniqueId description: 'Returns the status of a bank account number. Without changing the status, this API is used for checking the status of a bank account. Status can be called using either bankAccount number or clientUniqueId. ' operationId: ReceivablesStatusByClientID parameters: - name: clientUniqueId in: path required: true description: An identifier assigned to the account. schema: example: 862944d057FC408B9B04541C2BA12 type: string - name: bsb in: query required: false description: Optional BSB parameter specifying the branch identifier for Australian banks. Accepts either 6 digits or with a hyphen as "XXX-XXX". If not specified, the service will use the MAccount’s configured ‘Default BSB’. If a ‘Default BSB’ has not been configured, then the Monoova ‘Default BSB’ will be used. schema: type: string maxLength: 7 example: 802-985 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/receivablesStatusGetResponse_V1' '400': description: Bad request '500': description: Internal Server Error /receivables/v6/report/{date}: get: tags: - Automatcher (Bank Account Receivables) summary: Report description: Returns a report of all received transactions for the day with associated details, this includes Direct Entry and NPP Receivables. If requested multiple times on the current date (calendar day, AEDT), the report is cumulative. E.g. if, on the same day, a report is requested at 10am and another one at 1pm, the report at 1pm will contain all the transactions already contained in the 10am report, in addition to any new transactions. Direct Entry transactions arrive in batches 7 times throughout the day, 8.30am, 11.30am, 14.30pm, 17.30pm, 19.45pm, 21.45pm and 22.50pm (emergency), business days only. NPP Transactions may arrive at anytime, we recommend subscribing to a webhook to receive new transaction notifications.| Transaction ID | Batch ID | Datetime | BSB | AccountNumber | AccountName | PayId | PayId Name | TransactionCode | TransactionType | Amount | LodgementRef | RemitterName | Indicator | WithholdingTaxAmount (if applicable) | EndToEndId | RespondBeforeDateTime | NameOfUserSupplyingFile | NumberOfUserSupplyingFile | DescriptionOfEntriesOnFile | SourceBsb | SourceAccountNumber | SourceAccountName | CategoryPurposeCode | CreditorReferenceInformation | USINumber | USIScheme | UltimateCreditorName | ReconciliationRuleReference |
| Monoova generated Unique ID. Max 12 chars. | Payment Batch ID. Payments come in batches throughout the day. Max 12 chars. Blank if NPP. | AEDT, Sydney. Max 27 chars. | Payee BSB. Max 7 Chars. | Payee Bank Account Number. Max 34 chars. | Payer submitted Account Name. Max 32 chars. | Email address for the PayID. Max 256 chars. | Name displayed to the payers Max 140 chars. | Industry standard transaction code. “50” for credit. Refer to Direct entry standard for definitions 51-57. Max 5 chars. | Possible Values: 'DE' or 'NPP' | Payment amount, 2 decimal places for cents. Max 11 chars. | Payer submitted reference. Max 280 chars. | Remitting Entity. Max 140 chars. | Blank; OR 'W' dividend paid to a resident of a country where a double tax agreement is in force. 'X' dividend paid to a resident of any other country. 'Y' interest paid to all non-resident. Max 1 chars. | Blank OR Payment amount, 2 decimal places for cents. Max 9 chars. | Osko End to End identifier submitted by Payer. Max 35 chars. | Time by when you have to respond to the Inbound Direct Debit request. | Preferred name of the User supplying the Direct Entry file. | This is the User Identification Number which is assigned by APCA and User Financial Institutions. | Direct Entry file description. | Payer BSB. Max 7 Chars. | Payer Bank Account Number. Max 34 chars. | This field appears for NPP transactions only and is the payers bank account name. For DE transactions please refer to the RemitterName Field. Max 140 Chars. | NPP payment purpose code, max 4 chars. Possible values: Blank, SALA = Salary, PENS = SuperAnnuation, SUPP = E-Invoice, TAXS = Tax | Used for SALA, PENS, SUPP and TAXS transactions only. Reference related to payment type. Max 35 chars. | Used for PENS code payments only. Unique Superannuation ID (USI) Max 35 chars. | Used for PENS code payments only. USI scheme. Max 35 chars. | Used for PENS code payments only. Name of the Ultimate Creditor. Max 140 chars. | If Allow Reconciliation Rules is turned on for merchant. Example RR22348 string <= 35 characters ^[A-Za-z0-9-_]{1,35}$ |
Note: Source account details do not appear by default, please contact Monoova for further information. Also note, we will only retrieve 1 month transaction at a time
| Code | Transaction Description |
|---|---|
| 13 | Externally initiated debit items |
| 50 | Externally initiated credit items with the exception of those bearing Transaction Codes |
| 51 | Australian Government Security Interest |
| 52 | Family Allowance |
| 53 | Pay |
| 54 | Pension |
| 55 | Allotment |
| 56 | Dividend |
| 57 | Debenture/Note Interest |
| Transaction ID | Batch ID | Datetime | BSB | AccountNumber | AccountName | PayId | PayId Name | TransactionCode | TransactionType | Amount | LodgementRef | RemitterName | Indicator | WithholdingTaxAmount (if applicable) | EndToEndId | RespondBeforeDateTime | NameOfUserSupplyingFile | NumberOfUserSupplyingFile | DescriptionOfEntriesOnFile | SourceBsb | SourceAccountNumber | SourceAccountName | CategoryPurposeCode | CreditorReferenceInformation | USINumber | USIScheme | UltimateCreditorName | MMSId | InitiatingPartyName | NPPInstructionId | ReceiptNumber |
| Monoova generated Unique ID. Max 12 chars. | Payment Batch ID. Payments come in batches throughout the day. Max 12 chars. Blank if NPP. | AEDT, Sydney. Max 27 chars. | Payee BSB. Max 7 Chars. | Payee Bank Account Number. Max 34 chars. | Payer submitted Account Name. Max 32 chars. | Email address for the PayID. Max 256 chars. | Name displayed to the payers Max 140 chars. | Industry standard transaction code. “50” for credit. Refer to Direct entry standard for definitions 51-57. Max 5 chars. | Possible Values: ''DE'' or ''NPP'' | Payment amount, 2 decimal places for cents. Max 11 chars. | Payer submitted reference. Max 500 chars. | Remitting Entity. Max 140 chars. | Blank; OR ''W'' dividend paid to a resident of a country where a double tax agreement is in force. ''X'' dividend paid to a resident of any other country. ''Y'' interest paid to all non-resident. Max 1 chars. | Blank OR Payment amount, 2 decimal places for cents. Max 9 chars. | Osko End to End identifier submitted by Payer. | Time by when you have to respond to the Inbound Direct Debit request. | Preferred name of the User supplying the Direct Entry file. | This is the User Identification Number which is assigned by APCA and User Financial Institutions. | Direct Entry file description. | Payer BSB. Max 7 Chars. | Payer Bank Account Number. Max 34 chars. | This field appears for NPP transactions only and is the payers bank account name. For DE transactions please refer to the RemitterName Field. Max 140 Chars. | NPP payment purpose code, max 4 chars. Possible values: Blank, SALA = Salary, PENS = SuperAnnuation, SUPP = E-Invoice, TAXS = Tax | Used for SALA, PENS, SUPP and TAXS transactions only. Reference related to payment type. Max 35 chars. | Used for PENS code payments only. Unique Superannuation ID (USI) Max 35 chars. | Used for PENS code payments only. USI scheme. Max 35 chars. | Used for PENS code payments only. Name of the Ultimate Creditor. Max 140 chars. | Id assigned by NPPA for payment agreement | Iniation Party name. | Unique identifier for the NPP instruction. Max 35 chars. | Unique identifier for the transaction log. Max 12 chars. |
Note: Source account details do not appear by default, please contact Monoova for further information. Also note, we will only retrieve 1 month transaction at a time
| Code | Transaction Description |
|---|---|
| 13 | Externally initiated debit items |
| 50 | Externally initiated credit items with the exception of those bearing Transaction Codes |
| 51 | Australian Government Security Interest |
| 52 | Family Allowance |
| 53 | Pay |
| 54 | Pension |
| 55 | Allotment |
| 56 | Dividend |
| 57 | Debenture/Note Interest |
| bankAccountName | \nclientUniqueId | \nisActive | \nbsb | \n
| \n \nThe name of the account to be paid into. \nThis will be defaulted to your registered Trading Name. \n \n | \n\nAn identifier assigned to the account. \nMust be unique. \nIf not provided Monoova will generate and \nreturn a value automatically. \n | \n\nUsed to open and close account numbers. \nClosed account numbers will return all payments \nmade to that account number. \nIf not provided this value defaults to false. \n | \n\nOptional. If this column is added, please provide a valid value.\n | \n
| bankAccountName | \ncount | \nbsb | \n
| \n \nThe name of the account to be paid into. \nThis will be defaulted to your registered Trading Name. \n \n | \n\nNumeric, number of accounts you wish to create with this name. \n | \n\nOptional. If this column is added, please provide a valid value.\n | \n
| clientUniqueId | bankAccountNumber | isActive | bsb |
|
The unique identifier for the account to open or close. `at least one of clientUniqueId or bankAccountNumber` `required` |
The bank account number for the account to open or close. `at least one of clientUniqueId or bankAccountNumber` `required` |
Used to open and close account numbers. Closed account numbers will return all payments made to that account number. |
Optional BSB parameter. If not specified, default BSB logic applies. |
| Transaction ID | Batch ID | DateTime | Status | RejectionReason | BSB | AccountNumber | AccountName | Amount | LodgementRef | RemitterName | RespondBeforeDateTime | NameOfUserSupplyingFile | NumberOfUserSupplyingFile | DescriptionOfEntriesOnFile | Indicator | WithholdingTaxAmount (if applicable) | SourceBsb (if applicable) | SourceAccountNumber (if applicable) |
| Monoova generated Unique ID. Max 12 chars. | Payment Batch ID. Payments come in batches throughout the day. Max 12 chars. Blank if NPP. | AEDT, Sydney. Max 27 chars. | Transaction status, possible values: Pending, Accept, Reject | Text supplied when rejecting a direct debit. Max 250 Chars | Payee BSB. Max 7 Chars. | Payee Bank Account Number. Max 34 chars. | Payer submitted Account Name. Max 32 chars. | Payment amount, 2 decimal places for cents. Max 11 chars. | Payer submitted reference. Max 280 chars. | Remitting Entity. Max 140 chars. | Time by when you have to respond to the Inbound Direct Debit request. | Preferred name of the User supplying the Direct Entry file. | This is the User Identification Number which is assigned by APCA and User Financial Institutions. | Direct Entry file description. | Blank; OR 'W' dividend paid to a resident of a country where a double tax agreement is in force. 'X' dividend paid to a resident of any other country. 'Y' interest paid to all non-resident. Max 1 chars. | Blank OR Payment amount, 2 decimal places for cents. Max 9 chars. | Payee BSB. Max 7 Chars. | Payee Bank Account Number. Max 34 chars. |
| Transaction ID | AccountNumber | BSB | AccountName | TransactionReferenceNumber | Amount | Status | LodgementRef | Date | SourceAccountDetails | RespondBeforeDateTime | RejectReasonDescription | ProcessedDate | SendingOrganisation | ReceivingOrganisation | OrderingInstitution | OriginatingAddress |
| Monoova generated Unique ID. Max 12 chars. | Payee Bank Account Number. Max 34 chars. | Payee BSB. Max 7 Chars. | Payer submitted Account Name. Max 32 chars. | TransactionReferenceNumber. Max 21 chars. | Payment amount, 2 decimal places for cents. Max 11 chars. | Transaction status, possible values: Pending, Confirmed and Rejected. | Payer submitted reference. Max 280 chars. | AEDT, Sydney. Max 27 chars. | Source Account Name address and account number | The time user has to Confirm/Reject a transaction. AEDT, Sydney. Max 27 chars. | Reason why transaction was rejected. Max 500 chars. | The time when transaction was Confirmed/Rejected. AEDT, Sydney. Max 27 chars. | Sending Organisation. Max 100 chars. | Receiving Organisation. Max 100 chars. | Ordering Institution. Max 100 chars. | Originating Address. Max 100 chars. |