This API returns the fees and permissions that have been given to the Sign-In Account. The endpoint takes no parameters; the Sign-In Account is identified by the API key passed as the basic authentication username.
", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "basicAuth", "name": "basicAuth", "kind": "optional", "type": "http", "description": "To authenticate using basic authentication, generate an API key and pass it as the username. No password is required.
", "scheme": "basic" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "successful validation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "The fees, limits and permissions configured for the authenticated Sign-In Account.
", "customType": "settingsResponse_V1", "schema": [ { "name": "disbursementFees", "kind": "required", "type": "array", "description": "Required — The list of disbursement (money out) fees configured for the Sign-In Account, one entry per disbursement method. Returns an empty array when no disbursement fees apply.
", "modelRef": "#/components/schemas/disbursementFeeClass", "customType": "disbursementFeeClass[]", "schema": [ { "name": "method", "kind": "required", "type": "string", "description": "Required — Disbursement method. The payment method the fee applies to when paying funds out of the Sign-In Account.
", "example": "DirectCredit", "default": "DirectCredit", "pattern": "^[A-Za-z0-9 _-]{1,50}$" }, { "name": "feePercentageExGst", "kind": "required", "type": "numberRequired — Fee percentage exclusive of GST. Expressed as a percentage of the transaction amount, so 1.5 means 1.5%.
", "example": 0, "default": 0, "format": "double", "pattern": "^[0-9]{1,10}(\\.[0-9]{1,4})?$" }, { "name": "feeFixedExGst", "kind": "required", "type": "numberRequired — Fixed fee amount exclusive of GST, in AUD, applied per transaction.
", "example": 0.25, "default": 0.25, "format": "double", "pattern": "^[0-9]{1,10}(\\.[0-9]{1,4})?$" } ] }, { "name": "loadFees", "kind": "required", "type": "array", "description": "Required — The list of load (money in) fees configured for the Sign-In Account, one entry per load method and card type. Returns an empty array when no load fees apply.
", "modelRef": "#/components/schemas/loadFeeClass", "customType": "loadFeeClass[]", "schema": [ { "name": "method", "kind": "required", "type": "string", "description": "Required — Fee method. The payment method the fee applies to, for example the card or transfer method used to load funds.
", "example": "CreditCard", "default": "CreditCard", "pattern": "^[A-Za-z0-9 _-]{1,50}$" }, { "name": "cardType", "kind": "optional", "type": "string", "description": "Conditional — Card type. Returned only for card based load methods; otherwise an empty string is returned.
", "example": "Visa", "default": "Visa", "pattern": "^[A-Za-z0-9 _-]{0,50}$" }, { "name": "debitFromMAccount", "kind": "required", "type": "string", "description": "Required — True if fees are debited from the Sign-In Account.
", "example": "true", "default": "true", "pattern": "^(true|false)$" }, { "name": "feePercentageExGst", "kind": "required", "type": "numberRequired — Fee percentage exclusive of GST. Expressed as a percentage of the transaction amount, so 1.5 means 1.5%.
", "example": 1.5, "default": 1.5, "format": "double", "pattern": "^[0-9]{1,10}(\\.[0-9]{1,4})?$" }, { "name": "feeFixedExGst", "kind": "required", "type": "numberRequired — Fixed fee amount exclusive of GST, in AUD, applied per transaction.
", "example": 0.3, "default": 0.3, "format": "double", "pattern": "^[0-9]{1,10}(\\.[0-9]{1,4})?$" } ] }, { "name": "canDebitCreditCards", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account has permission to debit/Refund credit cards.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "canPayBpay", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account has permission to make outbound BPAY payments.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "canImpersonate", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account has permission to use the security/v1/createImpersonationTokenAsIssuer endpoint.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "canDirectDebit", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account has permission to Direct Debit an ABA.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "canDirectCredit", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account has permission to Direct Credit an ABA.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "canCreateMAccounts", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account has permission to create mAccounts.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "canCreateMWallets", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account has permission to create mWallets.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "canAccessUserDatabase", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account has permission to access the User Database.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "isIssuer", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account is an issuer.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "issuerMAccountNumber", "kind": "optional", "type": "string", "description": "Conditional — 16-digit Account number of Issuer. Returned only when isIssuer is true; otherwise an empty string is returned.
", "example": "1234567890123456", "default": "1234567890123456", "pattern": "^([0-9]{16})?$" }, { "name": "monthlyFeeExGst", "kind": "optional", "type": "numberOptional — The monthly fee(ExGst) for the Sign-In Account (deprecated). Returns null when no monthly fee is configured. This field is deprecated and should not be relied on.
", "example": 0, "default": 0, "format": "double", "pattern": "^[0-9]{1,10}(\\.[0-9]{1,4})?$" }, { "name": "clearingMAccountNumber", "kind": "required", "type": "string", "description": "Required — 16-digit Account number of Sign-In Clearing Account.
", "example": "1234567890123456", "default": "1234567890123456", "pattern": "^[0-9]{16}$" }, { "name": "feeMAccountNumber", "kind": "optional", "type": "string", "description": "Conditional — 16-Digit Account number of Fee Account if there is one. Returned only when a separate fee account is configured; otherwise an empty string is returned.
", "example": "1234567890123456", "default": "1234567890123456", "pattern": "^([0-9]{16})?$" }, { "name": "feeMAccountMonthlyFeeExGst", "kind": "optional", "type": "numberOptional — Monthly fee (ExGST) of the Sign-In Fee Account (deprecated). Returns null when no fee account monthly fee is configured. This field is deprecated and should not be relied on.
", "example": 0, "default": 0, "format": "double", "pattern": "^[0-9]{1,10}(\\.[0-9]{1,4})?$" }, { "name": "childMAccountSetUpFeeExGst", "kind": "optional", "type": "numberOptional — Set-up fee (ExGST) for each mAccount created via mAccount/v1/create (deprecated). Returns null when no set-up fee is configured. This field is deprecated and should not be relied on.
", "example": 0, "default": 0, "format": "double", "pattern": "^[0-9]{1,10}(\\.[0-9]{1,4})?$" }, { "name": "childMAccountMonthlyFeeExGst", "kind": "optional", "type": "numberOptional — Monthly fee (ExGST) for each mAccount created via mAccount/v1/create (deprecated). Returns null when no monthly fee is configured. This field is deprecated and should not be relied on.
", "example": 0, "default": 0, "format": "double", "pattern": "^[0-9]{1,10}(\\.[0-9]{1,4})?$" }, { "name": "requiresClearedFundsOnly", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account is set up as ClearedFunds.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "canOnlyDebitSignInMAccount", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account can only debit itself.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForCuscalReceivables", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account is approved to receive payments via Cuscal.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForCuscalReceivablesReturns", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account approved to return receivables via Cuscal.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForCuscalReceivablesRefunds", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account approved to refunds receivables via Cuscal.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForDomesticNppPayouts", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account is authorised for domestic NPP payments.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForIftiNppPayouts", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account is authorised for international NPP payments.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForReconciliationRules", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account can use reconciliation rules.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForCuscalReceivablesWhiteListing", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account can create whitelists.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForInboundDirectDebits", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account can recieve Direct Debits from a third party.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForLedgerAccounts", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account is authorised to create ledger accounts.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedToUseCustomLodgementReference", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account is authorised to use custom lodgement references on outbound payments.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedToUseDynamicRemitterName", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account is authorised to use dynamic remitter naming.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForDynamicSourceAccount", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account is authorised to use dynamic source accounts.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForBulkDirectDebit", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account is authorised to submit bulk (batched) Direct Debit requests.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForDirectCredit", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account is authorised to make Direct Credit payments.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForRealTimeDirectDebit", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account is authorised to initiate real-time Direct Debits.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedToOnlyDirectDebitWhiteListedAba", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account may only Direct Debit BSB and account numbers that appear on its whitelist.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedToOnlyDirectCreditWhiteListedAba", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account may only Direct Credit BSB and account numbers that appear on its whitelist.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForRealTimeOnDemand", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account is authorised to use real-time on-demand payments.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedToDisplayTraceAccount", "kind": "required", "type": "boolean", "description": "Required — True if the trace account behind an outbound transaction is displayed to the Sign-In Account.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedToDisplayTraceAccountForInboundDebit", "kind": "required", "type": "boolean", "description": "Required — True if the trace account behind an inbound Direct Debit is displayed to the Sign-In Account.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedNppPayable", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account is authorised to be paid via the New Payments Platform (NPP).
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "acceptInboundDirectDebit", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account accepts inbound Direct Debits initiated by a third party.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForMAccountTransfer", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account is authorised to transfer funds between mAccounts.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedToAcceptRtgs", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account is authorised to accept RTGS (Real Time Gross Settlement) payments.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedToAcceptInternationalPayments", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account is authorised to accept international payments.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForReconciliationRulesAllowPartialRefund", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account may configure reconciliation rules that allow partial refunds.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForReconciliationRulesAllowRange", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account may configure reconciliation rules that match on an amount range.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedToRejectRtgsImtTransactionsPastServiceLevelAgreement", "kind": "required", "type": "boolean", "description": "Required — True if RTGS and IMT transactions received after the agreed service level window are automatically rejected for the Sign-In Account.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedToIgnoreCreditLimitForRtgsIncoming", "kind": "required", "type": "boolean", "description": "Required — True if incoming RTGS payments bypass the credit limit configured on the Sign-In Account.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForInternationalReceivable", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account is authorised to receive international receivables.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForSourceBsbBlacklistingForDeReceivables", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account can blacklist source BSBs for Direct Entry receivables.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedSourceBsbBlacklistingForNppReceivables", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account can blacklist source BSBs for NPP receivables.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForDynamicAkaNamesForVirtualAccounts", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account can set dynamic AKA (also known as) names on virtual accounts.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForDynamicBankAccountNameForVirtualAccounts", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account can set dynamic bank account names on virtual accounts.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedToCreateVirtualAccountsForSubMerchantsUnderReview", "kind": "required", "type": "boolean", "description": "Required — True if the Sign-In Account can create virtual accounts for sub-merchants that are still under review.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "authorisedForConfirmationOfPayeeLookupRequired", "kind": "required", "type": "boolean", "description": "Required — True if a Confirmation of Payee lookup is required before the Sign-In Account can make a payment.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "webhookPermissions", "kind": "required", "type": "object", "description": "Required — The set of webhooks the Sign-In Account is permitted to subscribe to. Each flag is true when a subscription to that webhook is allowed.
", "example": "", "schema": [ { "name": "nppReceivePaymentWebhook", "kind": "required", "type": "boolean", "description": "Required — Can subscribe to nppReceivePayment webhook.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "payToReceivePaymentWebhook", "kind": "required", "type": "boolean", "description": "Required — Can subscribe to payToReceivePayment webhook.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "nppPaymentStatusWebhook", "kind": "required", "type": "boolean", "description": "Required — Can subscribe to nppPaymentStatus webhook.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "nppPaymentReturnWebhook", "kind": "required", "type": "boolean", "description": "Required — Can subscribe to nppPaymentReturn webhook.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "directDebitDishonourWebhook", "kind": "required", "type": "boolean", "description": "Required — Can subscribe to directDebitDishonour webhook.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "inboundDirectDebitWebhook", "kind": "required", "type": "boolean", "description": "Required — Can subscribe to inboundDirectDebit webhook.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "inboundDirectCreditWebhook", "kind": "required", "type": "boolean", "description": "Required — Can subscribe to inboundDirectCredit webhook.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "inboundRtgsImtPaymentWebhook", "kind": "required", "type": "boolean", "description": "Required — Can subscribe to inboundRtgsImtPayment webhook.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "rtgsImtPaymentStatusWebhook", "kind": "required", "type": "boolean", "description": "Required — Can subscribe to rtgsImtPaymentStatus webhook.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "nppCreditRejectionsWebhook", "kind": "required", "type": "boolean", "description": "Required — Can subscribe to nppCreditRejections webhook.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "inboundDirectCreditRejectionsWebhook", "kind": "required", "type": "boolean", "description": "Required — Can subscribe to inboundDirectCreditRejections webhook.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "iftiNppReceivePaymentWebhook", "kind": "required", "type": "boolean", "description": "Required — Can subscribe to iftiNppReceivePayment webhook.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "directDebitClearanceWebhook", "kind": "required", "type": "boolean", "description": "Required — Can subscribe to directDebitClearance webhook.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "iftiNppPaymentReturnWebhook", "kind": "required", "type": "boolean", "description": "Required — Can subscribe to iftiNppPaymentReturn webhook.
", "example": true, "default": true, "pattern": "^(true|false)$" }, { "name": "iftiNppPaymentStatusWebhook", "kind": "required", "type": "boolean", "description": "Required — Can subscribe to iftiNppPaymentStatus webhook.
", "example": true, "default": true, "pattern": "^(true|false)$" } ] }, { "name": "directDebitLimits", "kind": "optional", "type": "object", "description": "Conditional — The Direct Debit limits applied to the Sign-In Account. Values are returned only when the Sign-In Account is authorised to Direct Debit; each unconfigured limit is returned as null.
", "example": "", "schema": [ { "name": "maximumNumberOfDirectDebitsPerDay", "kind": "optional", "type": "integerOptional — Maximum number of Direct Debits that can be processed per day by the Sign-In Account. Returns null when no daily count limit is configured.
", "example": 100, "default": 100, "format": "int32", "pattern": "^[0-9]{1,19}$" }, { "name": "maximumDirectDebitAmountPerTransaction", "kind": "optional", "type": "numberOptional — Maximum transaction amount allowed for Direct Debit. Returns null when no per-transaction limit is configured.
", "example": 10000, "default": 10000, "format": "double", "pattern": "^[0-9]{1,10}(\\.[0-9]{1,4})?$" }, { "name": "directDebitClearanceDays", "kind": "optional", "type": "integerOptional — Configured days to clear Direct Debit payments. Returns null when no clearance period is configured.
", "example": 3, "default": 3, "format": "int32", "pattern": "^[0-9]{1,19}$" }, { "name": "limit", "kind": "optional", "type": "numberOptional — Direct Debit limit. This is the total value that may be Direct Debited before the limit resets. Returns null when no limit is configured.
", "example": 50000, "default": 50000, "format": "double", "pattern": "^[0-9]{1,10}(\\.[0-9]{1,4})?$" }, { "name": "rollOverDays", "kind": "optional", "type": "integerOptional — Days to reset Direct Debit limit. Returns null when the limit does not roll over.
", "example": 30, "default": 30, "format": "int32", "pattern": "^[0-9]{1,19}$" } ] }, { "name": "durationMs", "kind": "required", "type": "integerRequired — This value represents the total time in milliseconds that the Platform took to process the request.
", "example": 21, "default": 21, "format": "int64", "pattern": "^[0-9]{1,19}$" }, { "name": "status", "kind": "required", "type": "string", "description": "Required — This is the status of the request. A code of 'Ok' indicates no errors. Any other value indicates that the request was not completed successfully.
", "example": "Ok", "default": "Ok", "pattern": "^[A-Za-z]{1,50}$" }, { "name": "statusDescription", "kind": "required", "type": "string", "description": "Required — This is a description of the status. If an 'Ok' status is returned, then this will be 'Operation completed successfully'.
", "example": "Operation completed successfully", "default": "Operation completed successfully", "pattern": "^.{0,500}$" } ], "modelRef": "#/components/schemas/settingsResponse_V1", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad request — the request could not be validated. Check that every required parameter is supplied and that each value matches the documented pattern.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":12,\"status\":\"Error\",\"statusDescription\":\"The request is invalid. One or more parameters are missing or do not match the expected format.\"}", "description": "Standard error envelope returned by the Security API when a request cannot be completed.", "customType": "ErrorResponse_V1", "schema": [ { "name": "durationMs", "kind": "required", "type": "integerRequired — This value represents the total time in milliseconds that the Platform took to process the request before it failed.
", "example": 12, "default": 12, "format": "int64", "pattern": "^[0-9]{1,19}$" }, { "name": "status", "kind": "required", "type": "string", "description": "Required — The status code of the failed request. Any value other than 'Ok' indicates that the request was not processed.
", "example": "Error", "default": "Error", "pattern": "^[A-Za-z]{1,50}$" }, { "name": "statusDescription", "kind": "required", "type": "string", "description": "Required — A human readable description of why the request failed. Use this value when logging or surfacing the error to an operator.
", "example": "The request could not be processed. See statusDescription for details.", "default": "The request could not be processed. See statusDescription for details.", "pattern": "^.{0,500}$" } ], "modelRef": "#/components/schemas/ErrorResponse_V1", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized — the API key passed as the basic authentication username is missing, invalid, or the Sign-In Account does not have permission to call this endpoint. After five consecutive failures on the live Engine the Sign-In Account is locked for one hour.
", "jsonExample": "", "isExpanded": true, "headers": [ { "kind": "optional", "name": "WWW-Authenticate", "type": "string", "example": "Basic", "description": "Indicates the authentication scheme expected by the Engine." } ], "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":8,\"status\":\"Unauthorized\",\"statusDescription\":\"Authentication failed. Supply a valid API key as the basic authentication username.\"}", "description": "Standard error envelope returned by the Security API when a request cannot be completed.", "customType": "ErrorResponse_V1", "schema": [ { "name": "durationMs", "kind": "required", "type": "integerRequired — This value represents the total time in milliseconds that the Platform took to process the request before it failed.
", "example": 12, "default": 12, "format": "int64", "pattern": "^[0-9]{1,19}$" }, { "name": "status", "kind": "required", "type": "string", "description": "Required — The status code of the failed request. Any value other than 'Ok' indicates that the request was not processed.
", "example": "Error", "default": "Error", "pattern": "^[A-Za-z]{1,50}$" }, { "name": "statusDescription", "kind": "required", "type": "string", "description": "Required — A human readable description of why the request failed. Use this value when logging or surfacing the error to an operator.
", "example": "The request could not be processed. See statusDescription for details.", "default": "The request could not be processed. See statusDescription for details.", "pattern": "^.{0,500}$" } ], "modelRef": "#/components/schemas/ErrorResponse_V1", "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal server error — an unexpected error occurred while the Engine was processing the request. The request should be retried; if the error persists, contact Monoova support.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"durationMs\":35,\"status\":\"Exception\",\"statusDescription\":\"An unexpected error occurred while processing the request. Please retry or contact support.\"}", "description": "Standard error envelope returned by the Security API when a request cannot be completed.", "customType": "ErrorResponse_V1", "schema": [ { "name": "durationMs", "kind": "required", "type": "integerRequired — This value represents the total time in milliseconds that the Platform took to process the request before it failed.
", "example": 12, "default": 12, "format": "int64", "pattern": "^[0-9]{1,19}$" }, { "name": "status", "kind": "required", "type": "string", "description": "Required — The status code of the failed request. Any value other than 'Ok' indicates that the request was not processed.
", "example": "Error", "default": "Error", "pattern": "^[A-Za-z]{1,50}$" }, { "name": "statusDescription", "kind": "required", "type": "string", "description": "Required — A human readable description of why the request failed. Use this value when logging or surfacing the error to an operator.
", "example": "The request could not be processed. See statusDescription for details.", "default": "The request could not be processed. See statusDescription for details.", "pattern": "^.{0,500}$" } ], "modelRef": "#/components/schemas/ErrorResponse_V1", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "tU2eNCR7qlfoiWOUyhoE4", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.mpay.com.au/security/v1/signInAccountSettings \\\n --header 'accept: application/json'" }, { "id": "Wo6ApEGikezALk_sP9ZKc", "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: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.mpay.com.au/security/v1/signInAccountSettings\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "RLF1Gn4h9FrkQWQ1gi804", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/security/v1/signInAccountSettings\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "yG71UKt2rPLN5SnLB3VC9", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/security/v1/signInAccountSettings\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "tU2eNCR7qlfoiWOUyhoE4" }, "results": { "languages": [ { "id": "Ja1e58gKsUZWtSYcUlnh2", "language": "200", "code": "// successful validation\n{\n \"disbursementFees\": [\n {\n \"method\": \"DirectCredit\",\n \"feePercentageExGst\": \"\",\n \"feeFixedExGst\": 0.25\n }\n ],\n \"loadFees\": [\n {\n \"method\": \"CreditCard\",\n \"cardType\": \"Visa\",\n \"debitFromMAccount\": \"true\",\n \"feePercentageExGst\": 1.5,\n \"feeFixedExGst\": 0.3\n }\n ],\n \"canDebitCreditCards\": true,\n \"canPayBpay\": true,\n \"canImpersonate\": true,\n \"canDirectDebit\": true,\n \"canDirectCredit\": true,\n \"canCreateMAccounts\": true,\n \"canCreateMWallets\": true,\n \"canAccessUserDatabase\": true,\n \"isIssuer\": true,\n \"issuerMAccountNumber\": \"1234567890123456\",\n \"monthlyFeeExGst\": \"\",\n \"clearingMAccountNumber\": \"1234567890123456\",\n \"feeMAccountNumber\": \"1234567890123456\",\n \"feeMAccountMonthlyFeeExGst\": \"\",\n \"childMAccountSetUpFeeExGst\": \"\",\n \"childMAccountMonthlyFeeExGst\": \"\",\n \"requiresClearedFundsOnly\": true,\n \"canOnlyDebitSignInMAccount\": true,\n \"authorisedForCuscalReceivables\": true,\n \"authorisedForCuscalReceivablesReturns\": true,\n \"authorisedForCuscalReceivablesRefunds\": true,\n \"authorisedForDomesticNppPayouts\": true,\n \"authorisedForIftiNppPayouts\": true,\n \"authorisedForReconciliationRules\": true,\n \"authorisedForCuscalReceivablesWhiteListing\": true,\n \"authorisedForInboundDirectDebits\": true,\n \"authorisedForLedgerAccounts\": true,\n \"authorisedToUseCustomLodgementReference\": true,\n \"authorisedToUseDynamicRemitterName\": true,\n \"authorisedForDynamicSourceAccount\": true,\n \"authorisedForBulkDirectDebit\": true,\n \"authorisedForDirectCredit\": true,\n \"authorisedForRealTimeDirectDebit\": true,\n \"authorisedToOnlyDirectDebitWhiteListedAba\": true,\n \"authorisedToOnlyDirectCreditWhiteListedAba\": true,\n \"authorisedForRealTimeOnDemand\": true,\n \"authorisedToDisplayTraceAccount\": true,\n \"authorisedToDisplayTraceAccountForInboundDebit\": true,\n \"authorisedNppPayable\": true,\n \"acceptInboundDirectDebit\": true,\n \"authorisedForMAccountTransfer\": true,\n \"authorisedToAcceptRtgs\": true,\n \"authorisedToAcceptInternationalPayments\": true,\n \"authorisedForReconciliationRulesAllowPartialRefund\": true,\n \"authorisedForReconciliationRulesAllowRange\": true,\n \"authorisedToRejectRtgsImtTransactionsPastServiceLevelAgreement\": true,\n \"authorisedToIgnoreCreditLimitForRtgsIncoming\": true,\n \"authorisedForInternationalReceivable\": true,\n \"authorisedForSourceBsbBlacklistingForDeReceivables\": true,\n \"authorisedSourceBsbBlacklistingForNppReceivables\": true,\n \"authorisedForDynamicAkaNamesForVirtualAccounts\": true,\n \"authorisedForDynamicBankAccountNameForVirtualAccounts\": true,\n \"authorisedToCreateVirtualAccountsForSubMerchantsUnderReview\": true,\n \"authorisedForConfirmationOfPayeeLookupRequired\": true,\n \"webhookPermissions\": {\n \"nppReceivePaymentWebhook\": true,\n \"payToReceivePaymentWebhook\": true,\n \"nppPaymentStatusWebhook\": true,\n \"nppPaymentReturnWebhook\": true,\n \"directDebitDishonourWebhook\": true,\n \"inboundDirectDebitWebhook\": true,\n \"inboundDirectCreditWebhook\": true,\n \"inboundRtgsImtPaymentWebhook\": true,\n \"rtgsImtPaymentStatusWebhook\": true,\n \"nppCreditRejectionsWebhook\": true,\n \"inboundDirectCreditRejectionsWebhook\": true,\n \"iftiNppReceivePaymentWebhook\": true,\n \"directDebitClearanceWebhook\": true,\n \"iftiNppPaymentReturnWebhook\": true,\n \"iftiNppPaymentStatusWebhook\": true\n },\n \"directDebitLimits\": {\n \"maximumNumberOfDirectDebitsPerDay\": 100,\n \"maximumDirectDebitAmountPerTransaction\": 10000,\n \"directDebitClearanceDays\": 3,\n \"limit\": 50000,\n \"rollOverDays\": 30\n },\n \"durationMs\": 21,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" }, { "id": "XoEl5EulC7-A3PBwwcdms", "language": "400", "code": "// Bad request — the request could not be validated. Check that every required parameter is supplied and that each value matches the documented pattern.\n{\n \"durationMs\": 12,\n \"status\": \"Error\",\n \"statusDescription\": \"The request could not be processed. See statusDescription for details.\"\n}" }, { "id": "gLwsaDjNLESklR6W-SkMt", "language": "401", "code": "// Unauthorized — the API key passed as the basic authentication username is missing, invalid, or the Sign-In Account does not have permission to call this endpoint. After five consecutive failures on the live Engine the Sign-In Account is locked for one hour.\n{\n \"durationMs\": 12,\n \"status\": \"Error\",\n \"statusDescription\": \"The request could not be processed. See statusDescription for details.\"\n}" }, { "id": "PEkgssEfiVPkvrZchIOii", "language": "500", "code": "// Internal server error — an unexpected error occurred while the Engine was processing the request. The request should be retried; if the error persists, contact Monoova support.\n{\n \"durationMs\": 12,\n \"status\": \"Error\",\n \"statusDescription\": \"The request could not be processed. See statusDescription for details.\"\n}" } ], "selectedLanguageId": "Ja1e58gKsUZWtSYcUlnh2" } }, "children": [ { "text": "" } ] }