--- title: Execute a Transaction slug: api/execute-a-transaction docTags: createdAt: 2025-06-02T00:35:16.657Z --- { "id": "JRC4caqpQlDA2EA5wmJ1F", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.mpay.com.au/financial/v2/transaction/execute", "servers": [ { "url": "https://api.mpay.com.au/financial/v2/transaction/execute", "description": "Production URL" }, { "url": "https://api.m-pay.com.au/financial/v2/transaction/execute", "description": "Sandbox URL" } ], "name": "Execute a Transaction", "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 /financial/v2/transaction/validate endpoint to determine if the parameters are correct.\n\nSelect a body type to view different payment methods.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [], "complexItems": [ { "name": "object", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "This description will be displayed on the mAccount statements. If any disbursement object is present, this description will be overwritten. This description will only display on statements for payments directly into the sign in mAccount. (ie no disbursement object)", "example": "" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "This is the total amount of the transaction. It must match the sum of all disbursement amounts specified in the disbursements array if both are present.", "example": "" }, { "name": "uniqueReference", "kind": "optional", "type": "string", "description": "This is a unique reference generated by the calling service. This is a nonce. Its use is to determine if a request has already been received by the Engine. We strongly recommend sending a uniqueReference in your execution call to avoid duplicate transactions.", "example": "" }, { "name": "remitterName", "kind": "optional", "type": "string", "description": "Original Remitting Entity.", "example": "" }, { "name": "disbursements", "kind": "optional", "type": "array", "description": "Details where the transaction amount will be disbursed. Multiple disbursements across various methods can be specified in a single transaction.", "modelRef": "#/components/schemas/paymentDisbursementItemDirectCredit", "customType": "paymentDisbursementItemDirectCredit[]", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "Description for the transaction.", "example": "" }, { "name": "sourceAccountNumber", "kind": "optional", "type": "string", "description": "Payer Bank Account Number.", "example": "" }, { "name": "toDirectCreditDetails", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/toDirectCreditDetails", "customType": "toDirectCreditDetails", "schema": [ { "name": "accountName", "kind": "optional", "type": "string", "description": "This is the name of the account.", "example": "" }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "Bank account number of associated bank account.", "example": "" }, { "name": "token", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "bsbNumber", "kind": "optional", "type": "string", "description": "BSB (Bank-State-Branch) number. The format is a string in the following format: '999-999'.", "example": "" }, { "name": "remitterName", "kind": "optional", "type": "string", "description": "Original Remitting Entity.", "example": "" } ] }, { "name": "lodgementReference", "kind": "optional", "type": "string", "description": "Reference will appear on payers statement.", "example": "" }, { "name": "sourceAccountBsb", "kind": "optional", "type": "string", "description": "Payer BSB.", "example": "" }, { "name": "amount", "kind": "optional", "type": "number", "description": "This is the amount of funds to be paid.", "example": "" }, { "name": "disbursementMethod", "kind": "optional", "type": "string", "description": "This is the disbursementMethod that was used to make the settlement payment. Must be \"directCredit\".", "example": "" } ] } ], "modelRef": "#/components/schemas/Direct_Credit", "customType": "Direct_Credit" }, { "name": "object", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "This description will be displayed on the mAccount statements. If any disbursement object is present, this description will be overwritten. This description will only display on statements for payments directly into the sign in mAccount. (ie no disbursement object)", "example": "" }, { "name": "paymentSource", "kind": "optional", "type": "string", "description": "Must be \"directDebit\".", "example": "" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "This is the total amount of the transaction. It must match the sum of all disbursement amounts specified in the disbursements array if both are present.", "example": "" }, { "name": "uniqueReference", "kind": "optional", "type": "string", "description": "This is a unique reference generated by the calling service. This is a nonce. Its use is to determine if a request has already been received by the Engine. We strongly recommend sending a uniqueReference in your execution call to avoid duplicate transactions.", "example": "" }, { "name": "lodgementReference", "kind": "optional", "type": "string", "description": "Reference will appear on payers statement.", "example": "" }, { "name": "directDebit", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/paymentSourceDirectDebitDetailsClass", "customType": "paymentSourceDirectDebitDetailsClass", "schema": [ { "name": "accountName", "kind": "optional", "type": "string", "description": "This is the name of the account.", "example": "" }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "Bank account number of associated bank account.", "example": "" }, { "name": "bsbNumber", "kind": "optional", "type": "string", "description": "BSB (Bank-State-Branch) number. The format is a string in the following format: '999-999'.", "example": "" } ] } ], "modelRef": "#/components/schemas/Direct_Debit", "customType": "Direct_Debit" }, { "name": "object", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "This description will be displayed on the mAccount statements. If any disbursement object is present, this description will be overwritten. This description will only display on statements for payments directly into the sign in mAccount. (ie no disbursement object)", "example": "" }, { "name": "paymentSource", "kind": "optional", "type": "string", "description": "Must be \"token\".", "example": "" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "This is the total amount of the transaction. It must match the sum of all disbursement amounts specified in the disbursements array if both are present.", "example": "" }, { "name": "remitterName", "kind": "optional", "type": "string", "description": "Original Remitting Entity.", "example": "" }, { "name": "token", "kind": "optional", "type": "string", "description": "The text (GUID) that identifies the token.", "example": "" }, { "name": "disbursements", "kind": "optional", "type": "array", "description": "Details where the transaction amount will be disbursed. Multiple disbursements across various methods can be specified in a single transaction.", "modelRef": "#/components/schemas/paymentDisbursementItemDirectCreditToken", "customType": "paymentDisbursementItemDirectCreditToken[]", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "Description for the transaction.", "example": "" }, { "name": "toToken", "kind": "optional", "type": "string", "description": "The text (GUID) that identifies the token.", "example": "" }, { "name": "sourceAccountNumber", "kind": "optional", "type": "string", "description": "Payer Bank Account Number.", "example": "" }, { "name": "lodgementReference", "kind": "optional", "type": "stringls'", "description": "Reference will appear on payers statement.", "example": "" }, { "name": "token", "kind": "optional", "type": "string", "description": "The text (GUID) that identifies the token.", "example": "" }, { "name": "sourceAccountBsb", "kind": "optional", "type": "string", "description": "Payer BSB.", "example": "" }, { "name": "amount", "kind": "optional", "type": "number", "description": "This is the amount of funds to be paid.", "example": "" }, { "name": "disbursementMethod", "kind": "optional", "type": "string", "description": "Must be \"token\".", "example": "" } ] } ], "modelRef": "#/components/schemas/Direct_Credit_Token", "customType": "Direct_Credit_Token" }, { "name": "object", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "This description will be displayed on the mAccount statements. If any disbursement object is present, this description will be overwritten. This description will only display on statements for payments directly into the sign in mAccount. (ie no disbursement object)", "example": "" }, { "name": "paymentSource", "kind": "optional", "type": "string", "description": "Must be \"bulkDirectDebit\".", "example": "" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "This is the total amount of the transaction. It must match the sum of all disbursement amounts specified in the disbursements array if both are present.", "example": "" }, { "name": "uniqueReference", "kind": "optional", "type": "string", "description": "This is a unique reference generated by the calling service. This is a nonce. Its use is to determine if a request has already been received by the Engine. We strongly recommend sending a uniqueReference in your execution call to avoid duplicate transactions.", "example": "" }, { "name": "printUniqueReferenceOnStatement", "kind": "optional", "type": "boolean", "description": "If true, the uniqueReference will be printed on the statement. Default is false.", "example": "" }, { "name": "directDebits", "kind": "optional", "type": "array", "description": "Direct debits details.", "modelRef": "#/components/schemas/fromBulkDirectDebitDetails", "customType": "fromBulkDirectDebitDetails[]", "schema": [ { "name": "amount", "kind": "optional", "type": "number", "description": "This is the amount of funds to be paid.", "example": "" }, { "name": "fromDirectDebitDetail", "kind": "optional", "type": "object", "description": "Direct debits details.", "modelRef": "#/components/schemas/bulkDirectDebitItem", "customType": "bulkDirectDebitItem", "schema": [ { "name": "accountName", "kind": "optional", "type": "string", "description": "This is the name of the account.", "example": "" }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "Bank account number of associated bank account.", "example": "" }, { "name": "lodgementReference", "kind": "optional", "type": "string", "description": "Reference will appear on payers statement.", "example": "" }, { "name": "bsbNumber", "kind": "optional", "type": "string", "description": "BSB (Bank-State-Branch) number. The format is a string in the following format: '999-999'.", "example": "" }, { "name": "remitterName", "kind": "optional", "type": "string", "description": "Original Remitting Entity.", "example": "" } ] }, { "name": "description", "kind": "optional", "type": "string", "description": "Description for the transaction.", "example": "" }, { "name": "lodgementReference", "kind": "optional", "type": "string", "description": "Reference will appear on payers statement.", "example": "" } ] } ], "modelRef": "#/components/schemas/Bulk_Direct_Debit", "customType": "Bulk_Direct_Debit" }, { "name": "object", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "This description will be displayed on the mAccount statements. If any disbursement object is present, this description will be overwritten. This description will only display on statements for payments directly into the sign in mAccount. (ie no disbursement object)", "example": "" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "This is the total amount of the transaction. It must match the sum of all disbursement amounts specified in the disbursements array if both are present.", "example": "" }, { "name": "uniqueReference", "kind": "optional", "type": "string", "description": "This is a unique reference generated by the calling service. This is a nonce. Its use is to determine if a request has already been received by the Engine. We strongly recommend sending a uniqueReference in your execution call to avoid duplicate transactions.", "example": "" }, { "name": "disbursements", "kind": "optional", "type": "array", "description": "Details where the transaction amount will be disbursed. Multiple disbursements across various methods can be specified in a single transaction.", "modelRef": "#/components/schemas/paymentDisbursementItemNPPAccount", "customType": "paymentDisbursementItemNPPAccount[]", "schema": [ { "name": "sourceAccountNumber", "kind": "optional", "type": "string", "description": "Payer Bank Account Number.", "example": "" }, { "name": "lodgementReference", "kind": "optional", "type": "string", "description": "Reference will appear on payers statement.", "example": "" }, { "name": "sourceAccountBsb", "kind": "optional", "type": "string", "description": "Payer BSB.", "example": "" }, { "name": "amount", "kind": "optional", "type": "number", "description": "This is the amount of funds to be paid.", "example": "" }, { "name": "disbursementMethod", "kind": "optional", "type": "string", "description": "This is the disbursementMethod that was used to make the settlement payment. Must be \"NppCreditBankAccount\" when paying to a Bank Account via NPP.", "example": "" }, { "name": "ToNppCreditBankAccountDetails", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/toNppCreditBankAccountDetails", "customType": "toNppCreditBankAccountDetails", "schema": [ { "name": "accountName", "kind": "optional", "type": "string", "description": "This is the name of the account.", "example": "" }, { "name": "ultimateDebtorName", "kind": "optional", "type": "string", "description": "The name of the individual or entity initiating the payment.", "example": "" }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "Bank account number of associated bank account.", "example": "" }, { "name": "endToEndId", "kind": "optional", "type": "string", "description": "End to End identifier submitted by Payer.", "example": "" }, { "name": "token", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "ultimateCreditorName", "kind": "optional", "type": "string", "description": "The name of the individual or entity receiving the payment.", "example": "" }, { "name": "bsbNumber", "kind": "optional", "type": "string", "description": "BSB (Bank-State-Branch) number. The format is a string in the following format: '999-999'.", "example": "" }, { "name": "remitterName", "kind": "optional", "type": "string", "description": "Original Remitting Entity.", "example": "" } ] } ] } ], "modelRef": "#/components/schemas/NPP_To_Account", "customType": "NPP_To_Account" }, { "name": "object", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "This description will be displayed on the mAccount statements. If any disbursement object is present, this description will be overwritten. This description will only display on statements for payments directly into the sign in mAccount. (ie no disbursement object)", "example": "" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "This is the total amount of the transaction. It must match the sum of all disbursement amounts specified in the disbursements array if both are present.", "example": "" }, { "name": "uniqueReference", "kind": "optional", "type": "string", "description": "This is a unique reference generated by the calling service. This is a nonce. Its use is to determine if a request has already been received by the Engine. We strongly recommend sending a uniqueReference in your execution call to avoid duplicate transactions.", "example": "" }, { "name": "disbursements", "kind": "optional", "type": "array", "description": "Details where the transaction amount will be disbursed. Multiple disbursements across various methods can be specified in a single transaction.", "modelRef": "#/components/schemas/paymentDisbursementItemNPPPayid", "customType": "paymentDisbursementItemNPPPayid[]", "schema": [ { "name": "sourceAccountNumber", "kind": "optional", "type": "string", "description": "Payer Bank Account Number.", "example": "" }, { "name": "lodgementReference", "kind": "optional", "type": "string", "description": "Reference that will appear on the payers statement.", "example": "" }, { "name": "ToNppCreditPayIdDetails", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/toNppCreditPayIdDetails", "customType": "toNppCreditPayIdDetails", "schema": [ { "name": "accountName", "kind": "optional", "type": "string", "description": "This is the name of the account.", "example": "" }, { "name": "ultimateDebtorName", "kind": "optional", "type": "string", "description": "The name of the individual or entity initiating the payment.", "example": "" }, { "name": "endToEndId", "kind": "optional", "type": "string", "description": "End to End identifier submitted by Payer.", "example": "" }, { "name": "payId", "kind": "optional", "type": "string", "description": "PayId Identifier of the Payee.", "example": "" }, { "name": "token", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "ultimateCreditorName", "kind": "optional", "type": "string", "description": "The name of the individual or entity receiving the payment.", "example": "" }, { "name": "payIdType", "kind": "optional", "type": "string", "description": "PayId Type.", "example": "" }, { "name": "remitterName", "kind": "optional", "type": "string", "description": "Remitting Entity. Note: Remitter name must not be able to be mistaken for another entity (e.g. ATO) and will be validated by Monoova.", "example": "" } ] }, { "name": "sourceAccountBsb", "kind": "optional", "type": "string", "description": "Payer BSB.", "example": "" }, { "name": "amount", "kind": "optional", "type": "number", "description": "This is the amount of funds to be paid.", "example": "" }, { "name": "disbursementMethod", "kind": "optional", "type": "string", "description": "This is the disbursementMethod that was used to make the settlement payment. Must be \"NppCreditPayId\" when paying a PayID.", "example": "" } ] } ], "modelRef": "#/components/schemas/NPP_To_PayID", "customType": "NPP_To_PayID" }, { "name": "object", "schema": [ { "name": "paymentSource", "kind": "optional", "type": "string", "description": "This must always be \"mWallet\" for BPAY payments.", "example": "" }, { "name": "uniqueReference", "kind": "optional", "type": "string", "description": "This is a unique reference generated by the calling service. This is a nonce. Its use is to determine if a request has already been received by the Engine. We strongly recommend sending a uniqueReference in your execution call to avoid duplicate transactions.", "example": "" }, { "name": "mWallet", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/bpayPayerDetails", "customType": "bpayPayerDetails", "schema": [ { "name": "pin", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "token", "kind": "optional", "type": "string", "description": "", "example": "" } ] }, { "name": "disbursements", "kind": "optional", "type": "array", "description": "Details where the transaction amount will be disbursed. Multiple disbursements across various methods can be specified in a single transaction.", "modelRef": "#/components/schemas/paymentDisbursementItem", "customType": "paymentDisbursementItem[]", "schema": [ { "name": "toMWallet", "kind": "optional", "type": "string", "description": "16-Digit account number that uniquely identifies the mWallet.", "example": "" }, { "name": "toMAccount", "kind": "optional", "type": "string", "description": "16-Digit account number that uniquely identifies the mAccount.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Description for the transaction.", "example": "" }, { "name": "toToken", "kind": "optional", "type": "string", "description": "The text (GUID) that identifies the token.", "example": "" }, { "name": "sourceAccountNumber", "kind": "optional", "type": "string", "description": "Payer Bank Account Number.", "example": "" }, { "name": "toDirectCreditDetails", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/toDirectCreditDetails", "customType": "toDirectCreditDetails", "schema": [ { "name": "accountName", "kind": "optional", "type": "string", "description": "This is the name of the account.", "example": "" }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "Bank account number of associated bank account.", "example": "" }, { "name": "token", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "bsbNumber", "kind": "optional", "type": "string", "description": "BSB (Bank-State-Branch) number. The format is a string in the following format: '999-999'.", "example": "" }, { "name": "remitterName", "kind": "optional", "type": "string", "description": "Original Remitting Entity.", "example": "" } ] }, { "name": "lodgementReference", "kind": "optional", "type": "string", "description": "Reference will appear on payers statement.", "example": "" }, { "name": "ToNppCreditPayIdDetails", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/toNppCreditPayIdDetails", "customType": "toNppCreditPayIdDetails", "schema": [ { "name": "accountName", "kind": "optional", "type": "string", "description": "This is the name of the account.", "example": "" }, { "name": "ultimateDebtorName", "kind": "optional", "type": "string", "description": "The name of the individual or entity initiating the payment.", "example": "" }, { "name": "endToEndId", "kind": "optional", "type": "string", "description": "End to End identifier submitted by Payer.", "example": "" }, { "name": "payId", "kind": "optional", "type": "string", "description": "PayId Identifier of the Payee.", "example": "" }, { "name": "token", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "ultimateCreditorName", "kind": "optional", "type": "string", "description": "The name of the individual or entity receiving the payment.", "example": "" }, { "name": "payIdType", "kind": "optional", "type": "string", "description": "PayId Type.", "example": "" }, { "name": "remitterName", "kind": "optional", "type": "string", "description": "Remitting Entity. Note: Remitter name must not be able to be mistaken for another entity (e.g. ATO) and will be validated by Monoova.", "example": "" } ] }, { "name": "token", "kind": "optional", "type": "string", "description": "The text (GUID) that identifies the token.", "example": "" }, { "name": "sourceAccountBsb", "kind": "optional", "type": "string", "description": "Payer BSB.", "example": "" }, { "name": "amount", "kind": "optional", "type": "number", "description": "This is the amount of funds to be paid.", "example": "" }, { "name": "disbursementMethod", "kind": "optional", "type": "string", "description": "This is the disbursementMethod that was used to make the settlement payment.", "example": "" }, { "name": "ToNppCreditBankAccountDetails", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/toNppCreditBankAccountDetails", "customType": "toNppCreditBankAccountDetails", "schema": [ { "name": "accountName", "kind": "optional", "type": "string", "description": "This is the name of the account.", "example": "" }, { "name": "ultimateDebtorName", "kind": "optional", "type": "string", "description": "The name of the individual or entity initiating the payment.", "example": "" }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "Bank account number of associated bank account.", "example": "" }, { "name": "endToEndId", "kind": "optional", "type": "string", "description": "End to End identifier submitted by Payer.", "example": "" }, { "name": "token", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "ultimateCreditorName", "kind": "optional", "type": "string", "description": "The name of the individual or entity receiving the payment.", "example": "" }, { "name": "bsbNumber", "kind": "optional", "type": "string", "description": "BSB (Bank-State-Branch) number. The format is a string in the following format: '999-999'.", "example": "" }, { "name": "remitterName", "kind": "optional", "type": "string", "description": "Original Remitting Entity.", "example": "" } ] }, { "name": "toBpayDetails", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/toBpayDetails", "customType": "toBpayDetails", "schema": [ { "name": "billerCode", "kind": "optional", "type": "integer", "description": "BPAY Biller code.", "example": 0 }, { "name": "referenceNumber", "kind": "optional", "type": "string", "description": "Tax reference information issued by the taxing authority.", "example": "" }, { "name": "token", "kind": "optional", "type": "string", "description": "", "example": "" } ] } ] } ], "modelRef": "#/components/schemas/BPAY", "customType": "BPAY" }, { "name": "object", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "This description will be displayed on the mAccount statements. If any disbursement object is present, this description will be overwritten. This description will only display on statements for payments directly into the sign in mAccount. (ie no disbursement object)", "example": "" }, { "name": "paymentSource", "kind": "optional", "type": "string", "description": "Must be \"mAccount\" when debiting another mAccount.", "example": "" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "This is the total amount of the transaction. It must match the sum of all disbursement amounts specified in the disbursements array if both are present.", "example": "" }, { "name": "uniqueReference", "kind": "optional", "type": "string", "description": "This is a unique reference generated by the calling service. This is a nonce. Its use is to determine if a request has already been received by the Engine. We strongly recommend sending a uniqueReference in your execution call to avoid duplicate transactions.", "example": "" }, { "name": "mAccount", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/paymentSourceMAccountDetailsClass", "customType": "paymentSourceMAccountDetailsClass", "schema": [ { "name": "token", "kind": "optional", "type": "string", "description": "A 16 digit mAccount number.", "example": "" } ] } ], "modelRef": "#/components/schemas/Debit_mAccount", "customType": "Debit_mAccount" }, { "name": "object", "schema": [ { "name": "paymentSource", "kind": "optional", "type": "string", "description": "This is the source of funds for the transaction. Ledger accounts can be credited from an mWallet or mAccount.", "example": "" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "This is the total amount of the transaction. It must match the sum of all disbursement amounts specified in the disbursements array if both are present.", "example": "" }, { "name": "uniqueReference", "kind": "optional", "type": "string", "description": "This is a unique reference generated by the calling service. This is a nonce. Its use is to determine if a request has already been received by the Engine. We strongly recommend sending a uniqueReference in your execution call to avoid duplicate transactions.", "example": "" }, { "name": "disbursements", "kind": "optional", "type": "array", "description": "Details where the transaction amount will be disbursed. Multiple disbursements across various methods can be specified in a single transaction.", "modelRef": "#/components/schemas/paymentDisbursementItemLedger", "customType": "paymentDisbursementItemLedger[]", "schema": [ { "name": "toMWallet", "kind": "optional", "type": "string", "description": "16-Digit account number that uniquely identifies the Ledger Account.", "example": "" }, { "name": "amount", "kind": "optional", "type": "number", "description": "This is the amount of funds to be paid.", "example": "" }, { "name": "disbursementMethod", "kind": "optional", "type": "string", "description": "Must be \"mWallet\" when paying a Ledger Account.", "example": "" } ] } ], "modelRef": "#/components/schemas/Credit_Ledger", "customType": "Credit_Ledger" }, { "name": "object", "schema": [ { "name": "description", "kind": "optional", "type": "string", "description": "This description will be displayed on the mAccount statements. If any disbursement object is present, this description will be overwritten. This description will only display on statements for payments directly into the sign in mAccount. (ie no disbursement object)", "example": "" }, { "name": "paymentSource", "kind": "optional", "type": "string", "description": "This is the type of transaction. The correct type MUST be used as it instructs the Engine to move funds according to established rules. Valid values are mAccount, mWallet, directDebit, token.", "example": "" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "This is the total amount of the transaction. It must match the sum of all disbursement amounts specified in the disbursements array if both are present.", "example": "" }, { "name": "uniqueReference", "kind": "optional", "type": "string", "description": "This is a unique reference generated by the calling service. This is a nonce. Its use is to determine if a request has already been received by the Engine. We strongly recommend sending a uniqueReference in your execution call to avoid duplicate transactions.", "example": "" }, { "name": "remitterName", "kind": "optional", "type": "string", "description": "Original Remitting Entity.", "example": "" }, { "name": "mWallet", "kind": "optional", "type": "object", "description": "Disbursement to mWallet.", "modelRef": "#/components/schemas/bpayPayerDetails", "customType": "bpayPayerDetails", "schema": [ { "name": "pin", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "token", "kind": "optional", "type": "string", "description": "", "example": "" } ] }, { "name": "lodgementReference", "kind": "optional", "type": "string", "description": "Reference will appear on payers statement.", "example": "" }, { "name": "directDebit", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/paymentSourceDirectDebitDetailsClass", "customType": "paymentSourceDirectDebitDetailsClass", "schema": [ { "name": "accountName", "kind": "optional", "type": "string", "description": "This is the name of the account.", "example": "" }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "Bank account number of associated bank account.", "example": "" }, { "name": "bsbNumber", "kind": "optional", "type": "string", "description": "BSB (Bank-State-Branch) number. The format is a string in the following format: '999-999'.", "example": "" } ] }, { "name": "token", "kind": "optional", "type": "string", "description": "The text (GUID) that identifies the token.", "example": "" }, { "name": "disbursements", "kind": "optional", "type": "array", "description": "Details where the transaction amount will be disbursed. Multiple disbursements across various methods can be specified in a single transaction.", "modelRef": "#/components/schemas/paymentDisbursementItem", "customType": "paymentDisbursementItem[]", "schema": [ { "name": "toMWallet", "kind": "optional", "type": "string", "description": "16-Digit account number that uniquely identifies the mWallet.", "example": "" }, { "name": "toMAccount", "kind": "optional", "type": "string", "description": "16-Digit account number that uniquely identifies the mAccount.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Description for the transaction.", "example": "" }, { "name": "toToken", "kind": "optional", "type": "string", "description": "The text (GUID) that identifies the token.", "example": "" }, { "name": "sourceAccountNumber", "kind": "optional", "type": "string", "description": "Payer Bank Account Number.", "example": "" }, { "name": "toDirectCreditDetails", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/toDirectCreditDetails", "customType": "toDirectCreditDetails", "schema": [ { "name": "accountName", "kind": "optional", "type": "string", "description": "This is the name of the account.", "example": "" }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "Bank account number of associated bank account.", "example": "" }, { "name": "token", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "bsbNumber", "kind": "optional", "type": "string", "description": "BSB (Bank-State-Branch) number. The format is a string in the following format: '999-999'.", "example": "" }, { "name": "remitterName", "kind": "optional", "type": "string", "description": "Original Remitting Entity.", "example": "" } ] }, { "name": "lodgementReference", "kind": "optional", "type": "string", "description": "Reference will appear on payers statement.", "example": "" }, { "name": "ToNppCreditPayIdDetails", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/toNppCreditPayIdDetails", "customType": "toNppCreditPayIdDetails", "schema": [ { "name": "accountName", "kind": "optional", "type": "string", "description": "This is the name of the account.", "example": "" }, { "name": "ultimateDebtorName", "kind": "optional", "type": "string", "description": "The name of the individual or entity initiating the payment.", "example": "" }, { "name": "endToEndId", "kind": "optional", "type": "string", "description": "End to End identifier submitted by Payer.", "example": "" }, { "name": "payId", "kind": "optional", "type": "string", "description": "PayId Identifier of the Payee.", "example": "" }, { "name": "token", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "ultimateCreditorName", "kind": "optional", "type": "string", "description": "The name of the individual or entity receiving the payment.", "example": "" }, { "name": "payIdType", "kind": "optional", "type": "string", "description": "PayId Type.", "example": "" }, { "name": "remitterName", "kind": "optional", "type": "string", "description": "Remitting Entity. Note: Remitter name must not be able to be mistaken for another entity (e.g. ATO) and will be validated by Monoova.", "example": "" } ] }, { "name": "token", "kind": "optional", "type": "string", "description": "The text (GUID) that identifies the token.", "example": "" }, { "name": "sourceAccountBsb", "kind": "optional", "type": "string", "description": "Payer BSB.", "example": "" }, { "name": "amount", "kind": "optional", "type": "number", "description": "This is the amount of funds to be paid.", "example": "" }, { "name": "disbursementMethod", "kind": "optional", "type": "string", "description": "This is the disbursementMethod that was used to make the settlement payment.", "example": "" }, { "name": "ToNppCreditBankAccountDetails", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/toNppCreditBankAccountDetails", "customType": "toNppCreditBankAccountDetails", "schema": [ { "name": "accountName", "kind": "optional", "type": "string", "description": "This is the name of the account.", "example": "" }, { "name": "ultimateDebtorName", "kind": "optional", "type": "string", "description": "The name of the individual or entity initiating the payment.", "example": "" }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "Bank account number of associated bank account.", "example": "" }, { "name": "endToEndId", "kind": "optional", "type": "string", "description": "End to End identifier submitted by Payer.", "example": "" }, { "name": "token", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "ultimateCreditorName", "kind": "optional", "type": "string", "description": "The name of the individual or entity receiving the payment.", "example": "" }, { "name": "bsbNumber", "kind": "optional", "type": "string", "description": "BSB (Bank-State-Branch) number. The format is a string in the following format: '999-999'.", "example": "" }, { "name": "remitterName", "kind": "optional", "type": "string", "description": "Original Remitting Entity.", "example": "" } ] }, { "name": "toBpayDetails", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/toBpayDetails", "customType": "toBpayDetails", "schema": [ { "name": "billerCode", "kind": "optional", "type": "integer", "description": "BPAY Biller code.", "example": 0 }, { "name": "referenceNumber", "kind": "optional", "type": "string", "description": "Tax reference information issued by the taxing authority.", "example": "" }, { "name": "token", "kind": "optional", "type": "string", "description": "", "example": "" } ] } ] }, { "name": "mAccount", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/paymentSourceMAccountDetailsClass", "customType": "paymentSourceMAccountDetailsClass", "schema": [ { "name": "token", "kind": "optional", "type": "string", "description": "A 16 digit mAccount number.", "example": "" } ] }, { "name": "printUniqueReferenceOnStatement", "kind": "optional", "type": "boolean", "description": "If true, the uniqueReference will be printed on the statement. Default is false.", "example": "" }, { "name": "directDebits", "kind": "optional", "type": "array", "description": "Direct debits details.", "modelRef": "#/components/schemas/fromBulkDirectDebitDetails", "customType": "fromBulkDirectDebitDetails[]", "schema": [ { "name": "amount", "kind": "optional", "type": "number", "description": "This is the amount of funds to be paid.", "example": "" }, { "name": "fromDirectDebitDetail", "kind": "optional", "type": "object", "description": "Direct debits details.", "modelRef": "#/components/schemas/bulkDirectDebitItem", "customType": "bulkDirectDebitItem", "schema": [ { "name": "accountName", "kind": "optional", "type": "string", "description": "This is the name of the account.", "example": "" }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "Bank account number of associated bank account.", "example": "" }, { "name": "lodgementReference", "kind": "optional", "type": "string", "description": "Reference will appear on payers statement.", "example": "" }, { "name": "bsbNumber", "kind": "optional", "type": "string", "description": "BSB (Bank-State-Branch) number. The format is a string in the following format: '999-999'.", "example": "" }, { "name": "remitterName", "kind": "optional", "type": "string", "description": "Original Remitting Entity.", "example": "" } ] }, { "name": "description", "kind": "optional", "type": "string", "description": "Description for the transaction.", "example": "" }, { "name": "lodgementReference", "kind": "optional", "type": "string", "description": "Reference will appear on payers statement.", "example": "" } ] } ], "modelRef": "#/components/schemas/All_Parameters", "customType": "All_Parameters" } ], "complexType": "oneOf", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "basicAuth", "name": "basicAuth", "kind": "optional", "type": "http", "scheme": "basic" } ] }, "responses": [ { "statusCode": "200", "description": "successful validation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "financialTransactionExecuteResponse_V2", "schema": [ { "name": "expectedDateForClearedFunds", "kind": "optional", "type": "string", "description": "Expected clearance date for funds if applicable.", "example": "" }, { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request.", "example": 0 }, { "name": "feeAmountIncludingGst", "kind": "optional", "type": "number", "description": "This is the total fee amount Including GST that has been debited from your mAccount.", "example": "" }, { "name": "feeAmountExcludingGst", "kind": "optional", "type": "number", "description": "This is the fee amount excluding GST.", "example": "" }, { "name": "transactionId", "kind": "optional", "type": "integer", "description": "This is the transactionId that was returned from a financial transaction.", "example": 0 }, { "name": "callerUniqueReference", "kind": "optional", "type": "string", "description": "This is a unique reference generated by the calling service. This is a nonce. Its use is to determine if a request has already been received by the Engine.", "example": "" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "This is a description of the status. If an 'Ok' status is returned, then this will be 'Operation completed successfully'.", "example": "" }, { "name": "feeAmountGstComponent", "kind": "optional", "type": "number", "description": "This is the GST Component of the fee amount that has been debited from your mAccount.", "example": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "This is the status of the request. A code of 'Ok' indicates no errors.", "example": "" } ], "modelRef": "#/components/schemas/financialTransactionExecuteResponse_V2", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "HgRJJ0x7JZ78Dd6GsHFvx", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.mpay.com.au/financial/v2/transaction/execute \\\n --header 'accept: application/json'" }, { "id": "jDTWEDTyA8hHwFY6jCmQ2", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.mpay.com.au/financial/v2/transaction/execute\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "me5h1Swbf0gkgbvJaNMss", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/financial/v2/transaction/execute\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "L3Wyi2zlrsV6ZP7uLkcm3", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/financial/v2/transaction/execute\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" }, { "id": "9-41IiKwg_iprMolWU9jw", "language": "php", "label": "PHP", "code": " 'https://api.mpay.com.au/financial/v2/transaction/execute',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'POST',\n CURLOPT_HTTPHEADER => array(\n 'accept: application/json',\n 'content-type: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" } ], "selectedLanguageId": "HgRJJ0x7JZ78Dd6GsHFvx" }, "results": { "languages": [ { "id": "qmFY7Eu-pJkcMYbOxFZzF", "language": "200", "code": "// successful validation\n{\n \"expectedDateForClearedFunds\": \"\",\n \"durationMs\": \"\",\n \"feeAmountIncludingGst\": \"\",\n \"feeAmountExcludingGst\": \"\",\n \"transactionId\": \"\",\n \"callerUniqueReference\": \"\",\n \"statusDescription\": \"\",\n \"feeAmountGstComponent\": \"\",\n \"status\": \"\"\n}" } ], "selectedLanguageId": "qmFY7Eu-pJkcMYbOxFZzF" } }, "children": [ { "text": "" } ] }