--- title: Process a NPP IPS Transaction slug: api/process-a-npp-ips-transaction docTags: createdAt: 2025-04-15T23:58:07.855Z --- { "id": "tU8X5sNYo4O6gAiBtX0mc", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.mpay.com.au/financial/v1/transaction/internationalPayment", "servers": [ { "url": "https://api.mpay.com.au/financial/v1/transaction/internationalPayment", "description": "Production URL" }, { "url": "https://api.m-pay.com.au/financial/v1/transaction/internationalPayment", "description": "Sandbox URL" } ], "name": "Process a NPP IPS Transaction", "description": "Make a NPP IPS Payment.\n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "customType": "financialInternationalPaymentBody_V1", "schema": [ { "name": "uniqueReference", "kind": "optional", "type": "string", "example": "" }, { "name": "paymentSource", "kind": "optional", "type": "object", "description": "Source of funds.", "modelRef": "#/components/schemas/paymentSourceInternationalPaymentClass", "customType": "paymentSourceInternationalPaymentClass", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Disbursement source, e.g. mAccount.", "example": "" }, { "name": "token", "kind": "optional", "type": "string", "description": "16 digit mAccount number.", "example": "" }, { "name": "pin", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "printUniqueReferenceOnStatement", "kind": "optional", "type": "boolean", "example": "" }, { "name": "amount", "kind": "optional", "type": "number", "description": "The amount to be paid in AUD.", "example": "" }, { "name": "disbursement", "kind": "optional", "type": "object", "description": "The details of the recipients account. Note either a PayID or BSB/account can be used, but are mutually exclusive, and at least one must be populated.", "modelRef": "#/components/schemas/paymentDisbursementInternationalPaymentClass", "customType": "paymentDisbursementInternationalPaymentClass", "schema": [ { "name": "bsb", "kind": "optional", "type": "string", "description": "BSB (Bank-State-Branch) number. The format is a string in the following format: '999-999'.", "example": "" }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "This is the bank account number.", "example": "" }, { "name": "accountName", "kind": "optional", "type": "string", "description": "This is the name of the account.", "example": "" }, { "name": "payId", "kind": "optional", "type": "string", "description": "PayId Identifier of the Payee.", "example": "" }, { "name": "payIdType", "kind": "optional", "type": "string", "description": "PayId Type.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Description for the transaction.", "example": "" }, { "name": "lodgementReference", "kind": "optional", "type": "string", "description": "This reference will appear on payees statement. Refer to the disbursement object, May be overwritten for some account configurations, contact us for more details.", "example": "" }, { "name": "endToEndId", "kind": "optional", "type": "string", "description": "End to End identifier submitted by the debtor.", "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": "ultimateCreditorName", "kind": "optional", "type": "string", "description": "The name of the individual or entity receiving the payment.", "example": "" }, { "name": "ultimateDebtorName", "kind": "optional", "type": "string", "description": "The name of the individual or entity initiating the payment.", "example": "" }, { "name": "iftiInformation", "kind": "optional", "type": "object", "description": "Required IFTI information for the payment.", "modelRef": "#/components/schemas/iftiInformation", "customType": "iftiInformation", "schema": [ { "name": "chargeBearer", "kind": "required", "type": "string", "description": "Specifies which party will bear the charges of processing payment transaction.", "example": "" }, { "name": "chargesInformation", "kind": "optional", "type": "array", "description": "Information related to the charges.", "modelRef": "#/components/schemas/chargesInformation", "customType": "chargesInformation[]", "schema": [ { "name": "agentBic", "kind": "required", "type": "string", "description": "The agent’s BIC.", "example": "" }, { "name": "amount", "kind": "required", "type": "object", "description": "The charge amount.", "modelRef": "#/components/schemas/amountAndCurrency", "customType": "amountAndCurrency", "schema": [ { "name": "amount", "kind": "required", "type": "string", "description": "The charge amount.", "example": "" }, { "name": "currency", "kind": "required", "type": "string", "description": "ISO 4217 currency code.", "example": "" } ] }, { "name": "currency", "kind": "required", "type": "string", "description": "ISO 4217 currency code.", "example": "" } ] }, { "name": "clsTime", "kind": "optional", "type": "string", "description": "Transaction execution or cut-off time.", "example": "" }, { "name": "creditDateTime", "kind": "optional", "type": "string", "description": "ISO 8601 timestamp for the credit.", "example": "" }, { "name": "creditorAddress", "kind": "optional", "type": "object", "description": "Address of the creditor.", "modelRef": "#/components/schemas/address", "customType": "address", "schema": [ { "name": "addressLine", "kind": "optional", "type": "array", "description": "Address of the creditor.", "example": "\"- Level 4\",\n\"- 1 Margaret\",\n\"- Street\",\n\"- Corner\",\n\"- Sydney\",\n\"- NSW\",\n\"- 2000\".\n", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "addressType", "kind": "optional", "type": "string", "description": "ADDR - Postal Address is the complete postal address\nBIZZ - Business Address is the business address\nDLVY - Delivery To Address is the address to which delivery is to take place\nHOME - Residential Address is the home address\nMLTO - Mail To Address is the address to which mail is sent\nPBOX - POBox Address is a postal office (PO) box.\n", "example": "" }, { "name": "bldgName", "kind": "optional", "type": "string", "description": "Building name or number.", "example": "" }, { "name": "countryCode", "kind": "optional", "type": "string", "description": "ISO 3166 country code.", "example": "" }, { "name": "ctrySubDivision", "kind": "optional", "type": "string", "description": "The state, region, or territory.", "example": "" }, { "name": "department", "kind": "optional", "type": "string", "description": "Organisation department.", "example": "" }, { "name": "postcode", "kind": "optional", "type": "string", "description": "Postal or ZIP code.", "example": "" }, { "name": "streetName", "kind": "optional", "type": "string", "description": "Street name and type.", "example": "" }, { "name": "subDepartment", "kind": "optional", "type": "string", "description": "Organisation sub-department.", "example": "" }, { "name": "townName", "kind": "optional", "type": "string", "description": "Town, suburb, or city name.", "example": "" } ] }, { "name": "creditorAgentInstruction", "kind": "optional", "type": "array", "description": "Instruction information for the creditor.", "modelRef": "#/components/schemas/creditorAgentInstruction", "customType": "creditorAgentInstruction[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "Instruction type code. Allowed values CHQB, HOLD, PHOB, TELB.", "example": "" }, { "name": "instructionInformation", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "creditorOrganisationBic", "kind": "optional", "type": "string", "description": "The creditors BIC.", "example": "" }, { "name": "debitDateTime", "kind": "optional", "type": "string", "description": "ISO 8601 timestamp for the debit.", "example": "" }, { "name": "exchangeRate", "kind": "optional", "type": "string", "description": "Exchange rate if a non AUD currency is used.", "example": "" }, { "name": "initiatingPartyInformation", "kind": "optional", "type": "object", "description": "Details of the party initiating the payment.", "modelRef": "#/components/schemas/iftiPartyInformation", "customType": "iftiPartyInformation", "schema": [ { "name": "address", "kind": "optional", "type": "object", "description": "Address of the entity initiating the payment.", "modelRef": "#/components/schemas/address", "customType": "address", "schema": [ { "name": "addressLine", "kind": "optional", "type": "array", "description": "Address of the creditor.", "example": "\"- Level 4\",\n\"- 1 Margaret\",\n\"- Street\",\n\"- Corner\",\n\"- Sydney\",\n\"- NSW\",\n\"- 2000\".\n", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "addressType", "kind": "optional", "type": "string", "description": "ADDR - Postal Address is the complete postal address\nBIZZ - Business Address is the business address\nDLVY - Delivery To Address is the address to which delivery is to take place\nHOME - Residential Address is the home address\nMLTO - Mail To Address is the address to which mail is sent\nPBOX - POBox Address is a postal office (PO) box.\n", "example": "" }, { "name": "bldgName", "kind": "optional", "type": "string", "description": "Building name or number.", "example": "" }, { "name": "countryCode", "kind": "optional", "type": "string", "description": "ISO 3166 country code.", "example": "" }, { "name": "ctrySubDivision", "kind": "optional", "type": "string", "description": "The state, region, or territory.", "example": "" }, { "name": "department", "kind": "optional", "type": "string", "description": "Organisation department.", "example": "" }, { "name": "postcode", "kind": "optional", "type": "string", "description": "Postal or ZIP code.", "example": "" }, { "name": "streetName", "kind": "optional", "type": "string", "description": "Street name and type.", "example": "" }, { "name": "subDepartment", "kind": "optional", "type": "string", "description": "Organisation sub-department.", "example": "" }, { "name": "townName", "kind": "optional", "type": "string", "description": "Town, suburb, or city name.", "example": "" } ] }, { "name": "contactDetails", "kind": "optional", "type": "object", "description": "Contact details of the entity initiating the payment.", "modelRef": "#/components/schemas/contactDetails", "customType": "contactDetails", "schema": [ { "name": "emailAddress", "kind": "optional", "type": "string", "description": "Email address.", "example": "" }, { "name": "faxNumber", "kind": "optional", "type": "string", "description": "Fax number including country and area code.", "example": "" }, { "name": "mobileNumber", "kind": "optional", "type": "string", "description": "Mobile number including country and area code.", "example": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of the entity.", "example": "" }, { "name": "namePrefix", "kind": "optional", "type": "string", "description": "Salutation.", "example": "" }, { "name": "other", "kind": "optional", "type": "string", "description": "Unstructured contact information.", "example": "" }, { "name": "phoneNumber", "kind": "optional", "type": "string", "description": "Phone number including country and area code.", "example": "" } ] }, { "name": "countryOfResidence", "kind": "optional", "type": "string", "description": "Primary country of residence. Not required if the entity is an organisation.", "example": "" }, { "name": "datePlaceOfBirth", "kind": "optional", "type": "object", "description": "Date and place of birth if the entity is an individual. If this object is passed all child parameters included in the object must be supplied.", "modelRef": "#/components/schemas/datePlaceOfBirth", "customType": "datePlaceOfBirth", "schema": [ { "name": "birthDate", "kind": "optional", "type": "string", "example": "" }, { "name": "cityOfBirth", "kind": "optional", "type": "string", "example": "" }, { "name": "countryOfBirth", "kind": "optional", "type": "string", "example": "" }, { "name": "placeOfBirth", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of the entity.", "example": "" }, { "name": "organisationBic", "kind": "optional", "type": "string", "description": "Organisation BIC.", "example": "" }, { "name": "organisationIdentification", "kind": "optional", "type": "array", "description": "Organisation identifier. Only required if the entity is an organisation.", "modelRef": "#/components/schemas/identificationInformation", "customType": "identificationInformation[]", "schema": [ { "name": "identification", "kind": "optional", "type": "string", "description": "Identification number.", "example": "" }, { "name": "identificationIssuer", "kind": "optional", "type": "string", "description": "Issuing agency or country.", "example": "" }, { "name": "identificationTypeCode", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" }, { "name": "identificationTypeProprietary", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" } ] }, { "name": "privateIdentification", "kind": "optional", "type": "array", "description": "Identification details. Only required if the entity is an individual.", "modelRef": "#/components/schemas/identificationInformation", "customType": "identificationInformation[]", "schema": [ { "name": "identification", "kind": "optional", "type": "string", "description": "Identification number.", "example": "" }, { "name": "identificationIssuer", "kind": "optional", "type": "string", "description": "Issuing agency or country.", "example": "" }, { "name": "identificationTypeCode", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" }, { "name": "identificationTypeProprietary", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" } ] } ] }, { "name": "instructedAmount", "kind": "optional", "type": "object", "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges.", "modelRef": "#/components/schemas/amountAndCurrency", "customType": "amountAndCurrency", "schema": [ { "name": "amount", "kind": "required", "type": "string", "description": "The charge amount.", "example": "" }, { "name": "currency", "kind": "required", "type": "string", "description": "ISO 4217 currency code.", "example": "" } ] }, { "name": "instructionIdentification", "kind": "required", "type": "string", "description": "Instruction identification assigned to the instruction by the sender. You may copy the sender’s reference if available, or generate your own reference.", "example": "" }, { "name": "localClearingOption", "kind": "optional", "type": "string", "description": "Specify a local instrument, local clearing option and/or further qualify the service.", "example": "" }, { "name": "nextAgentInstruction", "kind": "optional", "type": "array", "description": "Unstructured information intended for the next agent in the transaction.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "paymentPurposeProprietary", "kind": "optional", "type": "string", "description": "Underlying reason for the payment transaction.", "example": "" }, { "name": "previousInstructingAgent", "kind": "required", "type": "object", "description": "Details of the previous instructing agent.", "modelRef": "#/components/schemas/previousInstructingAgent", "customType": "previousInstructingAgent", "schema": [ { "name": "agentBic", "kind": "optional", "type": "string", "example": "" }, { "name": "clearingSystemIdentification", "kind": "optional", "type": "string", "description": "Identification code for the clearing system.", "example": "" }, { "name": "clearingSystemMemberIdentification", "kind": "optional", "type": "string", "description": "Identification number used by the previous instructing agent in their local clearing system, such as BSB or bank branch code.", "example": "" } ] }, { "name": "regulatoryReporting", "kind": "required", "type": "array", "description": "Information needed due to regulatory and statutory requirements.", "modelRef": "#/components/schemas/regulatoryReporting", "customType": "regulatoryReporting[]", "schema": [ { "name": "authorityCountry", "kind": "optional", "type": "string", "description": "Regulatory authority ISO 3166 country code.", "example": "" }, { "name": "authorityName", "kind": "optional", "type": "string", "description": "Name of regulatory authority.", "example": "" }, { "name": "details", "kind": "optional", "type": "array", "description": "Details of regulatory report.", "modelRef": "#/components/schemas/regulatoryReportingDetail", "customType": "regulatoryReportingDetail[]", "schema": [ { "name": "amount", "kind": "optional", "type": "object", "description": "Details of transaction amount.", "modelRef": "#/components/schemas/amountAndCurrency", "customType": "amountAndCurrency", "schema": [ { "name": "amount", "kind": "required", "type": "string", "description": "The charge amount.", "example": "" }, { "name": "currency", "kind": "required", "type": "string", "description": "ISO 4217 currency code.", "example": "" } ] }, { "name": "code", "kind": "optional", "type": "string", "description": "Report code.", "example": "" }, { "name": "country", "kind": "optional", "type": "string", "description": "Country name.", "example": "" }, { "name": "date", "kind": "optional", "type": "string", "description": "Date of report.", "example": "" }, { "name": "information", "kind": "optional", "type": "array", "description": "Information included in regulatory report.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Type of report.", "example": "" } ] }, { "name": "reportingType", "kind": "optional", "type": "string", "description": "Report type identifier.", "example": "" } ] }, { "name": "relatedRemittanceInformation", "kind": "optional", "type": "array", "description": "Remittance information for the transaction.", "modelRef": "#/components/schemas/relatedRemittanceInformation", "customType": "relatedRemittanceInformation[]", "schema": [ { "name": "identification", "kind": "optional", "type": "string", "description": "Unique identification, as assigned by the initiating party, to unambiguously identify the remittance information sent separately from the payment instruction, such as a remittance advice.", "example": "" }, { "name": "locationDetails", "kind": "optional", "type": "array", "description": "Physical and electronic addressing information.", "modelRef": "#/components/schemas/locationDetail", "customType": "locationDetail[]", "schema": [ { "name": "electronicAddress", "kind": "optional", "type": "string", "description": "Electronic address.", "example": "" }, { "name": "method", "kind": "required", "type": "string", "description": "Addressing method (FAXI, EDIC, URID, EMAL, POST, SMSM).", "example": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of location.", "example": "" }, { "name": "postalAddress", "kind": "optional", "type": "object", "description": "Postal address.", "modelRef": "#/components/schemas/address", "customType": "address", "schema": [ { "name": "addressLine", "kind": "optional", "type": "array", "description": "Address of the creditor.", "example": "\"- Level 4\",\n\"- 1 Margaret\",\n\"- Street\",\n\"- Corner\",\n\"- Sydney\",\n\"- NSW\",\n\"- 2000\".\n", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "addressType", "kind": "optional", "type": "string", "description": "ADDR - Postal Address is the complete postal address\nBIZZ - Business Address is the business address\nDLVY - Delivery To Address is the address to which delivery is to take place\nHOME - Residential Address is the home address\nMLTO - Mail To Address is the address to which mail is sent\nPBOX - POBox Address is a postal office (PO) box.\n", "example": "" }, { "name": "bldgName", "kind": "optional", "type": "string", "description": "Building name or number.", "example": "" }, { "name": "countryCode", "kind": "optional", "type": "string", "description": "ISO 3166 country code.", "example": "" }, { "name": "ctrySubDivision", "kind": "optional", "type": "string", "description": "The state, region, or territory.", "example": "" }, { "name": "department", "kind": "optional", "type": "string", "description": "Organisation department.", "example": "" }, { "name": "postcode", "kind": "optional", "type": "string", "description": "Postal or ZIP code.", "example": "" }, { "name": "streetName", "kind": "optional", "type": "string", "description": "Street name and type.", "example": "" }, { "name": "subDepartment", "kind": "optional", "type": "string", "description": "Organisation sub-department.", "example": "" }, { "name": "townName", "kind": "optional", "type": "string", "description": "Town, suburb, or city name.", "example": "" } ] } ] } ] }, { "name": "remittanceInformationStructured", "kind": "optional", "type": "object", "description": "Structured remittance information for the transaction.", "modelRef": "#/components/schemas/remittanceInformationStructured", "customType": "remittanceInformationStructured", "schema": [ { "name": "additionalRemittanceInformation", "kind": "optional", "type": "array", "description": "Unstructured free text for any information which does not fit into the structured information parameters.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "creditorReferenceInformation", "kind": "optional", "type": "object", "description": "Unique reference issued by the creditor.", "modelRef": "#/components/schemas/creditorReferenceInformation", "customType": "creditorReferenceInformation", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "Specifies the type of creditor reference.", "example": "" }, { "name": "issuer", "kind": "optional", "type": "string", "description": "Identifies the type of creditor reference supplied.", "example": "" }, { "name": "proprietary", "kind": "optional", "type": "string", "description": "Specifies the type of creditor reference.", "example": "" }, { "name": "reference", "kind": "optional", "type": "string", "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.", "example": "" } ] }, { "name": "garnishmentRemittance", "kind": "optional", "type": "object", "description": "Information related to court ordered garnishments.", "modelRef": "#/components/schemas/garnishmentRemittance", "customType": "garnishmentRemittance", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "Specifies the type of garnishment.", "example": "" }, { "name": "date", "kind": "optional", "type": "string", "description": "Date of payment which garnishment was taken from.", "example": "" }, { "name": "employeeTerminationIndicator", "kind": "optional", "type": "boolean", "description": "Employee termination indicator.", "example": "" }, { "name": "familyMedicalInsuranceIndicator", "kind": "optional", "type": "boolean", "description": "Indicates if the person to whom the garnishment applies (that is, the ultimate debtor) has family medical insurance coverage available.", "example": "" }, { "name": "garnishee", "kind": "optional", "type": "object", "description": "Ultimate party that owes an amount of money to the ultimate creditor.", "modelRef": "#/components/schemas/iftiPartyInformation", "customType": "iftiPartyInformation", "schema": [ { "name": "address", "kind": "optional", "type": "object", "description": "Address of the entity initiating the payment.", "modelRef": "#/components/schemas/address", "customType": "address", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "contactDetails", "kind": "optional", "type": "object", "description": "Contact details of the entity initiating the payment.", "modelRef": "#/components/schemas/contactDetails", "customType": "contactDetails", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "countryOfResidence", "kind": "optional", "type": "string", "description": "Primary country of residence. Not required if the entity is an organisation.", "example": "" }, { "name": "datePlaceOfBirth", "kind": "optional", "type": "object", "description": "Date and place of birth if the entity is an individual. If this object is passed all child parameters included in the object must be supplied.", "modelRef": "#/components/schemas/datePlaceOfBirth", "customType": "datePlaceOfBirth", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of the entity.", "example": "" }, { "name": "organisationBic", "kind": "optional", "type": "string", "description": "Organisation BIC.", "example": "" }, { "name": "organisationIdentification", "kind": "optional", "type": "array", "description": "Organisation identifier. Only required if the entity is an organisation.", "modelRef": "#/components/schemas/identificationInformation", "customType": "identificationInformation[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "privateIdentification", "kind": "optional", "type": "array", "description": "Identification details. Only required if the entity is an individual.", "modelRef": "#/components/schemas/identificationInformation", "customType": "identificationInformation[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "garnishmentAdministrator", "kind": "optional", "type": "object", "description": "Party on the credit side of the transaction who administers the garnishment on behalf of the ultimate beneficiary.", "modelRef": "#/components/schemas/iftiPartyInformation", "customType": "iftiPartyInformation", "schema": [ { "name": "address", "kind": "optional", "type": "object", "description": "Address of the entity initiating the payment.", "modelRef": "#/components/schemas/address", "customType": "address", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "contactDetails", "kind": "optional", "type": "object", "description": "Contact details of the entity initiating the payment.", "modelRef": "#/components/schemas/contactDetails", "customType": "contactDetails", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "countryOfResidence", "kind": "optional", "type": "string", "description": "Primary country of residence. Not required if the entity is an organisation.", "example": "" }, { "name": "datePlaceOfBirth", "kind": "optional", "type": "object", "description": "Date and place of birth if the entity is an individual. If this object is passed all child parameters included in the object must be supplied.", "modelRef": "#/components/schemas/datePlaceOfBirth", "customType": "datePlaceOfBirth", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of the entity.", "example": "" }, { "name": "organisationBic", "kind": "optional", "type": "string", "description": "Organisation BIC.", "example": "" }, { "name": "organisationIdentification", "kind": "optional", "type": "array", "description": "Organisation identifier. Only required if the entity is an organisation.", "modelRef": "#/components/schemas/identificationInformation", "customType": "identificationInformation[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "privateIdentification", "kind": "optional", "type": "array", "description": "Identification details. Only required if the entity is an individual.", "modelRef": "#/components/schemas/identificationInformation", "customType": "identificationInformation[]", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "issuer", "kind": "optional", "type": "string", "description": "Issuer of garnishment.", "example": "" }, { "name": "proprietary", "kind": "optional", "type": "string", "description": "Specifies the type of garnishment.", "example": "" }, { "name": "referenceNumber", "kind": "optional", "type": "string", "description": "Reference information that is specific to the agency receiving the garnishment.", "example": "" }, { "name": "remittedAmount", "kind": "optional", "type": "object", "description": "Amount of money remitted for Garnishment.", "modelRef": "#/components/schemas/amountAndCurrency", "customType": "amountAndCurrency", "schema": [ { "name": "amount", "kind": "required", "type": "string", "description": "The charge amount.", "example": "" }, { "name": "currency", "kind": "required", "type": "string", "description": "ISO 4217 currency code.", "example": "" } ] } ] }, { "name": "invoicee", "kind": "optional", "type": "object", "description": "Identification of the party to whom an invoice is issued.", "modelRef": "#/components/schemas/iftiPartyInformation", "customType": "iftiPartyInformation", "schema": [ { "name": "address", "kind": "optional", "type": "object", "description": "Address of the entity initiating the payment.", "modelRef": "#/components/schemas/address", "customType": "address", "schema": [ { "name": "addressLine", "kind": "optional", "type": "array", "description": "Address of the creditor.", "example": "\"- Level 4\",\n\"- 1 Margaret\",\n\"- Street\",\n\"- Corner\",\n\"- Sydney\",\n\"- NSW\",\n\"- 2000\".\n", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "addressType", "kind": "optional", "type": "string", "description": "ADDR - Postal Address is the complete postal address\nBIZZ - Business Address is the business address\nDLVY - Delivery To Address is the address to which delivery is to take place\nHOME - Residential Address is the home address\nMLTO - Mail To Address is the address to which mail is sent\nPBOX - POBox Address is a postal office (PO) box.\n", "example": "" }, { "name": "bldgName", "kind": "optional", "type": "string", "description": "Building name or number.", "example": "" }, { "name": "countryCode", "kind": "optional", "type": "string", "description": "ISO 3166 country code.", "example": "" }, { "name": "ctrySubDivision", "kind": "optional", "type": "string", "description": "The state, region, or territory.", "example": "" }, { "name": "department", "kind": "optional", "type": "string", "description": "Organisation department.", "example": "" }, { "name": "postcode", "kind": "optional", "type": "string", "description": "Postal or ZIP code.", "example": "" }, { "name": "streetName", "kind": "optional", "type": "string", "description": "Street name and type.", "example": "" }, { "name": "subDepartment", "kind": "optional", "type": "string", "description": "Organisation sub-department.", "example": "" }, { "name": "townName", "kind": "optional", "type": "string", "description": "Town, suburb, or city name.", "example": "" } ] }, { "name": "contactDetails", "kind": "optional", "type": "object", "description": "Contact details of the entity initiating the payment.", "modelRef": "#/components/schemas/contactDetails", "customType": "contactDetails", "schema": [ { "name": "emailAddress", "kind": "optional", "type": "string", "description": "Email address.", "example": "" }, { "name": "faxNumber", "kind": "optional", "type": "string", "description": "Fax number including country and area code.", "example": "" }, { "name": "mobileNumber", "kind": "optional", "type": "string", "description": "Mobile number including country and area code.", "example": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of the entity.", "example": "" }, { "name": "namePrefix", "kind": "optional", "type": "string", "description": "Salutation.", "example": "" }, { "name": "other", "kind": "optional", "type": "string", "description": "Unstructured contact information.", "example": "" }, { "name": "phoneNumber", "kind": "optional", "type": "string", "description": "Phone number including country and area code.", "example": "" } ] }, { "name": "countryOfResidence", "kind": "optional", "type": "string", "description": "Primary country of residence. Not required if the entity is an organisation.", "example": "" }, { "name": "datePlaceOfBirth", "kind": "optional", "type": "object", "description": "Date and place of birth if the entity is an individual. If this object is passed all child parameters included in the object must be supplied.", "modelRef": "#/components/schemas/datePlaceOfBirth", "customType": "datePlaceOfBirth", "schema": [ { "name": "birthDate", "kind": "optional", "type": "string", "example": "" }, { "name": "cityOfBirth", "kind": "optional", "type": "string", "example": "" }, { "name": "countryOfBirth", "kind": "optional", "type": "string", "example": "" }, { "name": "placeOfBirth", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of the entity.", "example": "" }, { "name": "organisationBic", "kind": "optional", "type": "string", "description": "Organisation BIC.", "example": "" }, { "name": "organisationIdentification", "kind": "optional", "type": "array", "description": "Organisation identifier. Only required if the entity is an organisation.", "modelRef": "#/components/schemas/identificationInformation", "customType": "identificationInformation[]", "schema": [ { "name": "identification", "kind": "optional", "type": "string", "description": "Identification number.", "example": "" }, { "name": "identificationIssuer", "kind": "optional", "type": "string", "description": "Issuing agency or country.", "example": "" }, { "name": "identificationTypeCode", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" }, { "name": "identificationTypeProprietary", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" } ] }, { "name": "privateIdentification", "kind": "optional", "type": "array", "description": "Identification details. Only required if the entity is an individual.", "modelRef": "#/components/schemas/identificationInformation", "customType": "identificationInformation[]", "schema": [ { "name": "identification", "kind": "optional", "type": "string", "description": "Identification number.", "example": "" }, { "name": "identificationIssuer", "kind": "optional", "type": "string", "description": "Issuing agency or country.", "example": "" }, { "name": "identificationTypeCode", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" }, { "name": "identificationTypeProprietary", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" } ] } ] }, { "name": "invoicer", "kind": "optional", "type": "object", "description": "Identification of the organisation issuing the invoice.", "modelRef": "#/components/schemas/iftiPartyInformation", "customType": "iftiPartyInformation", "schema": [ { "name": "address", "kind": "optional", "type": "object", "description": "Address of the entity initiating the payment.", "modelRef": "#/components/schemas/address", "customType": "address", "schema": [ { "name": "addressLine", "kind": "optional", "type": "array", "description": "Address of the creditor.", "example": "\"- Level 4\",\n\"- 1 Margaret\",\n\"- Street\",\n\"- Corner\",\n\"- Sydney\",\n\"- NSW\",\n\"- 2000\".\n", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "addressType", "kind": "optional", "type": "string", "description": "ADDR - Postal Address is the complete postal address\nBIZZ - Business Address is the business address\nDLVY - Delivery To Address is the address to which delivery is to take place\nHOME - Residential Address is the home address\nMLTO - Mail To Address is the address to which mail is sent\nPBOX - POBox Address is a postal office (PO) box.\n", "example": "" }, { "name": "bldgName", "kind": "optional", "type": "string", "description": "Building name or number.", "example": "" }, { "name": "countryCode", "kind": "optional", "type": "string", "description": "ISO 3166 country code.", "example": "" }, { "name": "ctrySubDivision", "kind": "optional", "type": "string", "description": "The state, region, or territory.", "example": "" }, { "name": "department", "kind": "optional", "type": "string", "description": "Organisation department.", "example": "" }, { "name": "postcode", "kind": "optional", "type": "string", "description": "Postal or ZIP code.", "example": "" }, { "name": "streetName", "kind": "optional", "type": "string", "description": "Street name and type.", "example": "" }, { "name": "subDepartment", "kind": "optional", "type": "string", "description": "Organisation sub-department.", "example": "" }, { "name": "townName", "kind": "optional", "type": "string", "description": "Town, suburb, or city name.", "example": "" } ] }, { "name": "contactDetails", "kind": "optional", "type": "object", "description": "Contact details of the entity initiating the payment.", "modelRef": "#/components/schemas/contactDetails", "customType": "contactDetails", "schema": [ { "name": "emailAddress", "kind": "optional", "type": "string", "description": "Email address.", "example": "" }, { "name": "faxNumber", "kind": "optional", "type": "string", "description": "Fax number including country and area code.", "example": "" }, { "name": "mobileNumber", "kind": "optional", "type": "string", "description": "Mobile number including country and area code.", "example": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of the entity.", "example": "" }, { "name": "namePrefix", "kind": "optional", "type": "string", "description": "Salutation.", "example": "" }, { "name": "other", "kind": "optional", "type": "string", "description": "Unstructured contact information.", "example": "" }, { "name": "phoneNumber", "kind": "optional", "type": "string", "description": "Phone number including country and area code.", "example": "" } ] }, { "name": "countryOfResidence", "kind": "optional", "type": "string", "description": "Primary country of residence. Not required if the entity is an organisation.", "example": "" }, { "name": "datePlaceOfBirth", "kind": "optional", "type": "object", "description": "Date and place of birth if the entity is an individual. If this object is passed all child parameters included in the object must be supplied.", "modelRef": "#/components/schemas/datePlaceOfBirth", "customType": "datePlaceOfBirth", "schema": [ { "name": "birthDate", "kind": "optional", "type": "string", "example": "" }, { "name": "cityOfBirth", "kind": "optional", "type": "string", "example": "" }, { "name": "countryOfBirth", "kind": "optional", "type": "string", "example": "" }, { "name": "placeOfBirth", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of the entity.", "example": "" }, { "name": "organisationBic", "kind": "optional", "type": "string", "description": "Organisation BIC.", "example": "" }, { "name": "organisationIdentification", "kind": "optional", "type": "array", "description": "Organisation identifier. Only required if the entity is an organisation.", "modelRef": "#/components/schemas/identificationInformation", "customType": "identificationInformation[]", "schema": [ { "name": "identification", "kind": "optional", "type": "string", "description": "Identification number.", "example": "" }, { "name": "identificationIssuer", "kind": "optional", "type": "string", "description": "Issuing agency or country.", "example": "" }, { "name": "identificationTypeCode", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" }, { "name": "identificationTypeProprietary", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" } ] }, { "name": "privateIdentification", "kind": "optional", "type": "array", "description": "Identification details. Only required if the entity is an individual.", "modelRef": "#/components/schemas/identificationInformation", "customType": "identificationInformation[]", "schema": [ { "name": "identification", "kind": "optional", "type": "string", "description": "Identification number.", "example": "" }, { "name": "identificationIssuer", "kind": "optional", "type": "string", "description": "Issuing agency or country.", "example": "" }, { "name": "identificationTypeCode", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" }, { "name": "identificationTypeProprietary", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" } ] } ] }, { "name": "referredDocumentAmount", "kind": "optional", "type": "object", "description": "Details about the amounts in the referred document.", "modelRef": "#/components/schemas/referredDocumentAmount", "customType": "referredDocumentAmount", "schema": [ { "name": "adjustmentAmountAndReason", "kind": "optional", "type": "array", "description": "Specifies detailed information on the amount and reason for an adjustment to the amount paid for the referred document.", "modelRef": "#/components/schemas/adjustmentAmountAndReason", "customType": "adjustmentAmountAndReason[]", "schema": [ { "name": "additionalInformation", "kind": "optional", "type": "string", "description": "Additional information related to the adjustment.", "example": "" }, { "name": "amount", "kind": "optional", "type": "object", "description": "Adjustment amount.", "modelRef": "#/components/schemas/amountAndCurrency", "customType": "amountAndCurrency", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "creditDebitCode", "kind": "optional", "type": "string", "description": "Credit or debit identifier.", "example": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "Adjustment reason.", "example": "" } ] }, { "name": "creditNoteAmount", "kind": "optional", "type": "object", "description": "Credit note amount included in the referred document.", "modelRef": "#/components/schemas/amountAndCurrency", "customType": "amountAndCurrency", "schema": [ { "name": "amount", "kind": "required", "type": "string", "description": "The charge amount.", "example": "" }, { "name": "currency", "kind": "required", "type": "string", "description": "ISO 4217 currency code.", "example": "" } ] }, { "name": "discountAppliedAmount", "kind": "optional", "type": "array", "description": "Discount amount applied against the document amount.", "modelRef": "#/components/schemas/discountAppliedAmount", "customType": "discountAppliedAmount[]", "schema": [ { "name": "amount", "kind": "optional", "type": "object", "description": "Discount amount.", "modelRef": "#/components/schemas/amountAndCurrency", "customType": "amountAndCurrency", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "code", "kind": "optional", "type": "string", "description": "Discount applied type.", "example": "" }, { "name": "proprietary", "kind": "optional", "type": "string", "description": "Discount applied type.", "example": "" } ] }, { "name": "duePayableAmount", "kind": "optional", "type": "object", "description": "Due payable amount included in the referred document.", "modelRef": "#/components/schemas/amountAndCurrency", "customType": "amountAndCurrency", "schema": [ { "name": "amount", "kind": "required", "type": "string", "description": "The charge amount.", "example": "" }, { "name": "currency", "kind": "required", "type": "string", "description": "ISO 4217 currency code.", "example": "" } ] }, { "name": "remittedAmount", "kind": "optional", "type": "object", "description": "Remitted amount included in the referred document.", "modelRef": "#/components/schemas/amountAndCurrency", "customType": "amountAndCurrency", "schema": [ { "name": "amount", "kind": "required", "type": "string", "description": "The charge amount.", "example": "" }, { "name": "currency", "kind": "required", "type": "string", "description": "ISO 4217 currency code.", "example": "" } ] }, { "name": "taxAmount", "kind": "optional", "type": "array", "description": "The amount of the tax record.", "modelRef": "#/components/schemas/referredDocumentTaxAmount", "customType": "referredDocumentTaxAmount[]", "schema": [ { "name": "additionalInformation", "kind": "optional", "type": "string", "description": "Additional information as free text.", "example": "" }, { "name": "amount", "kind": "optional", "type": "object", "description": "Tax amount.", "modelRef": "#/components/schemas/amountAndCurrency", "customType": "amountAndCurrency", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "code", "kind": "optional", "type": "string", "description": "Referred tax document type.", "example": "" }, { "name": "proprietary", "kind": "optional", "type": "string", "description": "Referred tax document type.", "example": "" } ] } ] }, { "name": "referredDocumentInformation", "kind": "optional", "type": "array", "description": "Identification and the content of the referred document.", "modelRef": "#/components/schemas/referredDocumentInformation", "customType": "referredDocumentInformation[]", "schema": [ { "name": "number", "kind": "optional", "type": "string", "example": "" }, { "name": "relatedDate", "kind": "optional", "type": "string", "description": "Date in in ISO 8601 format.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Identifies the type of referred document.", "example": "" }, { "name": "code", "kind": "optional", "type": "string", "description": "Identifies the type of referred document.", "example": "" }, { "name": "proprietary", "kind": "optional", "type": "string", "description": "Identifies the type of referred document.", "example": "" }, { "name": "issuer", "kind": "optional", "type": "string", "description": "Name of the agency that issued the referred document.", "example": "" } ] }, { "name": "taxRemittance", "kind": "optional", "type": "object", "description": "Remittance information about a payment made for tax-related purposes.", "modelRef": "#/components/schemas/taxRemittance", "customType": "taxRemittance", "schema": [ { "name": "administrationZone", "kind": "optional", "type": "string", "description": "Territorial part of a country to which the tax payment is related.", "example": "" }, { "name": "creditor", "kind": "optional", "type": "object", "description": "Party on the credit side of the transaction to which the tax applies.", "modelRef": "#/components/schemas/creditorDebtorInformation", "customType": "creditorDebtorInformation", "schema": [ { "name": "authorisationName", "kind": "optional", "type": "string", "description": "Name of the party.", "example": "" }, { "name": "authorisationTitle", "kind": "optional", "type": "string", "description": "Title or position of the party.", "example": "" }, { "name": "registrationIdentification", "kind": "optional", "type": "string", "description": "Unique identification, as assigned by an organisation, to unambiguously identify a party.", "example": "" }, { "name": "taxIdentification", "kind": "optional", "type": "string", "description": "The tax identification Number of the party.", "example": "" }, { "name": "taxType", "kind": "optional", "type": "string", "description": "Type of tax payer.", "example": "" } ] }, { "name": "date", "kind": "optional", "type": "string", "description": "Date by which the tax is due.", "example": "" }, { "name": "debtor", "kind": "optional", "type": "object", "description": "Party on the debit side of the transaction to which the tax applies.", "modelRef": "#/components/schemas/creditorDebtorInformation", "customType": "creditorDebtorInformation", "schema": [ { "name": "authorisationName", "kind": "optional", "type": "string", "description": "Name of the party.", "example": "" }, { "name": "authorisationTitle", "kind": "optional", "type": "string", "description": "Title or position of the party.", "example": "" }, { "name": "registrationIdentification", "kind": "optional", "type": "string", "description": "Unique identification, as assigned by an organisation, to unambiguously identify a party.", "example": "" }, { "name": "taxIdentification", "kind": "optional", "type": "string", "description": "The tax identification Number of the party.", "example": "" }, { "name": "taxType", "kind": "optional", "type": "string", "description": "Type of tax payer.", "example": "" } ] }, { "name": "method", "kind": "optional", "type": "string", "description": "Method used to pay the tax.", "example": "" }, { "name": "record", "kind": "optional", "type": "array", "description": "Record allows a more granular breakdown of the tax.", "modelRef": "#/components/schemas/taxRemittanceRecord", "customType": "taxRemittanceRecord[]", "schema": [ { "name": "additionalInformation", "kind": "optional", "type": "string", "description": "Additional information to be provided about the Record level tax details.", "example": "" }, { "name": "category", "kind": "optional", "type": "string", "description": "Tax code as published by the tax authority.", "example": "" }, { "name": "categoryDetails", "kind": "optional", "type": "string", "description": "Provides further details of the category tax code.", "example": "" }, { "name": "certificateIdentification", "kind": "optional", "type": "string", "description": "Identification number of the tax report as assigned by the taxing authority.", "example": "" }, { "name": "debtorStatus", "kind": "optional", "type": "string", "description": "Code provided by local authority to identify the status of the party that has drawn up the settlement document.", "example": "" }, { "name": "formsCode", "kind": "optional", "type": "string", "description": "Identifies the template the tax report is to be provided on.", "example": "" }, { "name": "period", "kind": "optional", "type": "object", "description": "Set of elements used to provide details on the period of time related to the tax payment.", "modelRef": "#/components/schemas/period", "customType": "period", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "taxAmount", "kind": "optional", "type": "object", "description": "The amount of the tax record.", "modelRef": "#/components/schemas/taxRemittanceRecordTaxAmount", "customType": "taxRemittanceRecordTaxAmount", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "type", "kind": "optional", "type": "string", "description": "Code to identify the type of tax.", "example": "" } ] }, { "name": "referenceNumber", "kind": "optional", "type": "string", "description": "Tax reference information issued by the taxing authority.", "example": "" }, { "name": "sequenceNumber", "kind": "optional", "type": "integer", "description": "Sequential number of the tax report.", "example": 0 }, { "name": "totalTaxAmount", "kind": "optional", "type": "object", "description": "Total amount of money as result of the calculation of the tax.", "modelRef": "#/components/schemas/amountAndCurrency", "customType": "amountAndCurrency", "schema": [ { "name": "amount", "kind": "required", "type": "string", "description": "The charge amount.", "example": "" }, { "name": "currency", "kind": "required", "type": "string", "description": "ISO 4217 currency code.", "example": "" } ] }, { "name": "totalTaxableBaseAmount", "kind": "optional", "type": "object", "description": "Total amount of money on which the tax is based.", "modelRef": "#/components/schemas/amountAndCurrency", "customType": "amountAndCurrency", "schema": [ { "name": "amount", "kind": "required", "type": "string", "description": "The charge amount.", "example": "" }, { "name": "currency", "kind": "required", "type": "string", "description": "ISO 4217 currency code.", "example": "" } ] }, { "name": "ultimateDebtor", "kind": "optional", "type": "object", "description": "Ultimate party that owes an amount of money to the taxing authority.", "modelRef": "#/components/schemas/creditorDebtorInformation", "customType": "creditorDebtorInformation", "schema": [ { "name": "authorisationName", "kind": "optional", "type": "string", "description": "Name of the party.", "example": "" }, { "name": "authorisationTitle", "kind": "optional", "type": "string", "description": "Title or position of the party.", "example": "" }, { "name": "registrationIdentification", "kind": "optional", "type": "string", "description": "Unique identification, as assigned by an organisation, to unambiguously identify a party.", "example": "" }, { "name": "taxIdentification", "kind": "optional", "type": "string", "description": "The tax identification Number of the party.", "example": "" }, { "name": "taxType", "kind": "optional", "type": "string", "description": "Type of tax payer.", "example": "" } ] } ] } ] }, { "name": "ultimateCreditorInformation", "kind": "optional", "type": "object", "description": "Information relating to the ultimate debtor.", "modelRef": "#/components/schemas/iftiPartyInformation", "customType": "iftiPartyInformation", "schema": [ { "name": "address", "kind": "optional", "type": "object", "description": "Address of the entity initiating the payment.", "modelRef": "#/components/schemas/address", "customType": "address", "schema": [ { "name": "addressLine", "kind": "optional", "type": "array", "description": "Address of the creditor.", "example": "\"- Level 4\",\n\"- 1 Margaret\",\n\"- Street\",\n\"- Corner\",\n\"- Sydney\",\n\"- NSW\",\n\"- 2000\".\n", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "addressType", "kind": "optional", "type": "string", "description": "ADDR - Postal Address is the complete postal address\nBIZZ - Business Address is the business address\nDLVY - Delivery To Address is the address to which delivery is to take place\nHOME - Residential Address is the home address\nMLTO - Mail To Address is the address to which mail is sent\nPBOX - POBox Address is a postal office (PO) box.\n", "example": "" }, { "name": "bldgName", "kind": "optional", "type": "string", "description": "Building name or number.", "example": "" }, { "name": "countryCode", "kind": "optional", "type": "string", "description": "ISO 3166 country code.", "example": "" }, { "name": "ctrySubDivision", "kind": "optional", "type": "string", "description": "The state, region, or territory.", "example": "" }, { "name": "department", "kind": "optional", "type": "string", "description": "Organisation department.", "example": "" }, { "name": "postcode", "kind": "optional", "type": "string", "description": "Postal or ZIP code.", "example": "" }, { "name": "streetName", "kind": "optional", "type": "string", "description": "Street name and type.", "example": "" }, { "name": "subDepartment", "kind": "optional", "type": "string", "description": "Organisation sub-department.", "example": "" }, { "name": "townName", "kind": "optional", "type": "string", "description": "Town, suburb, or city name.", "example": "" } ] }, { "name": "contactDetails", "kind": "optional", "type": "object", "description": "Contact details of the entity initiating the payment.", "modelRef": "#/components/schemas/contactDetails", "customType": "contactDetails", "schema": [ { "name": "emailAddress", "kind": "optional", "type": "string", "description": "Email address.", "example": "" }, { "name": "faxNumber", "kind": "optional", "type": "string", "description": "Fax number including country and area code.", "example": "" }, { "name": "mobileNumber", "kind": "optional", "type": "string", "description": "Mobile number including country and area code.", "example": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of the entity.", "example": "" }, { "name": "namePrefix", "kind": "optional", "type": "string", "description": "Salutation.", "example": "" }, { "name": "other", "kind": "optional", "type": "string", "description": "Unstructured contact information.", "example": "" }, { "name": "phoneNumber", "kind": "optional", "type": "string", "description": "Phone number including country and area code.", "example": "" } ] }, { "name": "countryOfResidence", "kind": "optional", "type": "string", "description": "Primary country of residence. Not required if the entity is an organisation.", "example": "" }, { "name": "datePlaceOfBirth", "kind": "optional", "type": "object", "description": "Date and place of birth if the entity is an individual. If this object is passed all child parameters included in the object must be supplied.", "modelRef": "#/components/schemas/datePlaceOfBirth", "customType": "datePlaceOfBirth", "schema": [ { "name": "birthDate", "kind": "optional", "type": "string", "example": "" }, { "name": "cityOfBirth", "kind": "optional", "type": "string", "example": "" }, { "name": "countryOfBirth", "kind": "optional", "type": "string", "example": "" }, { "name": "placeOfBirth", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of the entity.", "example": "" }, { "name": "organisationBic", "kind": "optional", "type": "string", "description": "Organisation BIC.", "example": "" }, { "name": "organisationIdentification", "kind": "optional", "type": "array", "description": "Organisation identifier. Only required if the entity is an organisation.", "modelRef": "#/components/schemas/identificationInformation", "customType": "identificationInformation[]", "schema": [ { "name": "identification", "kind": "optional", "type": "string", "description": "Identification number.", "example": "" }, { "name": "identificationIssuer", "kind": "optional", "type": "string", "description": "Issuing agency or country.", "example": "" }, { "name": "identificationTypeCode", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" }, { "name": "identificationTypeProprietary", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" } ] }, { "name": "privateIdentification", "kind": "optional", "type": "array", "description": "Identification details. Only required if the entity is an individual.", "modelRef": "#/components/schemas/identificationInformation", "customType": "identificationInformation[]", "schema": [ { "name": "identification", "kind": "optional", "type": "string", "description": "Identification number.", "example": "" }, { "name": "identificationIssuer", "kind": "optional", "type": "string", "description": "Issuing agency or country.", "example": "" }, { "name": "identificationTypeCode", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" }, { "name": "identificationTypeProprietary", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" } ] } ] }, { "name": "ultimateDebtorInformation", "kind": "optional", "type": "object", "description": "Information relating to the ultimate debtor.", "modelRef": "#/components/schemas/iftiPartyInformation", "customType": "iftiPartyInformation", "schema": [ { "name": "address", "kind": "optional", "type": "object", "description": "Address of the entity initiating the payment.", "modelRef": "#/components/schemas/address", "customType": "address", "schema": [ { "name": "addressLine", "kind": "optional", "type": "array", "description": "Address of the creditor.", "example": "\"- Level 4\",\n\"- 1 Margaret\",\n\"- Street\",\n\"- Corner\",\n\"- Sydney\",\n\"- NSW\",\n\"- 2000\".\n", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "addressType", "kind": "optional", "type": "string", "description": "ADDR - Postal Address is the complete postal address\nBIZZ - Business Address is the business address\nDLVY - Delivery To Address is the address to which delivery is to take place\nHOME - Residential Address is the home address\nMLTO - Mail To Address is the address to which mail is sent\nPBOX - POBox Address is a postal office (PO) box.\n", "example": "" }, { "name": "bldgName", "kind": "optional", "type": "string", "description": "Building name or number.", "example": "" }, { "name": "countryCode", "kind": "optional", "type": "string", "description": "ISO 3166 country code.", "example": "" }, { "name": "ctrySubDivision", "kind": "optional", "type": "string", "description": "The state, region, or territory.", "example": "" }, { "name": "department", "kind": "optional", "type": "string", "description": "Organisation department.", "example": "" }, { "name": "postcode", "kind": "optional", "type": "string", "description": "Postal or ZIP code.", "example": "" }, { "name": "streetName", "kind": "optional", "type": "string", "description": "Street name and type.", "example": "" }, { "name": "subDepartment", "kind": "optional", "type": "string", "description": "Organisation sub-department.", "example": "" }, { "name": "townName", "kind": "optional", "type": "string", "description": "Town, suburb, or city name.", "example": "" } ] }, { "name": "contactDetails", "kind": "optional", "type": "object", "description": "Contact details of the entity initiating the payment.", "modelRef": "#/components/schemas/contactDetails", "customType": "contactDetails", "schema": [ { "name": "emailAddress", "kind": "optional", "type": "string", "description": "Email address.", "example": "" }, { "name": "faxNumber", "kind": "optional", "type": "string", "description": "Fax number including country and area code.", "example": "" }, { "name": "mobileNumber", "kind": "optional", "type": "string", "description": "Mobile number including country and area code.", "example": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of the entity.", "example": "" }, { "name": "namePrefix", "kind": "optional", "type": "string", "description": "Salutation.", "example": "" }, { "name": "other", "kind": "optional", "type": "string", "description": "Unstructured contact information.", "example": "" }, { "name": "phoneNumber", "kind": "optional", "type": "string", "description": "Phone number including country and area code.", "example": "" } ] }, { "name": "countryOfResidence", "kind": "optional", "type": "string", "description": "Primary country of residence. Not required if the entity is an organisation.", "example": "" }, { "name": "datePlaceOfBirth", "kind": "optional", "type": "object", "description": "Date and place of birth if the entity is an individual. If this object is passed all child parameters included in the object must be supplied.", "modelRef": "#/components/schemas/datePlaceOfBirth", "customType": "datePlaceOfBirth", "schema": [ { "name": "birthDate", "kind": "optional", "type": "string", "example": "" }, { "name": "cityOfBirth", "kind": "optional", "type": "string", "example": "" }, { "name": "countryOfBirth", "kind": "optional", "type": "string", "example": "" }, { "name": "placeOfBirth", "kind": "optional", "type": "string", "example": "" } ] }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of the entity.", "example": "" }, { "name": "organisationBic", "kind": "optional", "type": "string", "description": "Organisation BIC.", "example": "" }, { "name": "organisationIdentification", "kind": "optional", "type": "array", "description": "Organisation identifier. Only required if the entity is an organisation.", "modelRef": "#/components/schemas/identificationInformation", "customType": "identificationInformation[]", "schema": [ { "name": "identification", "kind": "optional", "type": "string", "description": "Identification number.", "example": "" }, { "name": "identificationIssuer", "kind": "optional", "type": "string", "description": "Issuing agency or country.", "example": "" }, { "name": "identificationTypeCode", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" }, { "name": "identificationTypeProprietary", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" } ] }, { "name": "privateIdentification", "kind": "optional", "type": "array", "description": "Identification details. Only required if the entity is an individual.", "modelRef": "#/components/schemas/identificationInformation", "customType": "identificationInformation[]", "schema": [ { "name": "identification", "kind": "optional", "type": "string", "description": "Identification number.", "example": "" }, { "name": "identificationIssuer", "kind": "optional", "type": "string", "description": "Issuing agency or country.", "example": "" }, { "name": "identificationTypeCode", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" }, { "name": "identificationTypeProprietary", "kind": "optional", "type": "string", "description": "Type of identification.", "example": "" } ] } ] } ] } ] } ], "modelRef": "#/components/schemas/financialInternationalPaymentBody_V1", "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": "financialTransactionInternationalPaymentResponse_V1", "schema": [ { "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": "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": "status", "kind": "optional", "type": "string", "description": "This is the status of the request. A code of 'Ok' indicates no errors.", "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": "" } ], "modelRef": "#/components/schemas/financialTransactionInternationalPaymentResponse_V1", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "bN7JjRPRPtjCPI-CxvyUe", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.mpay.com.au/financial/v1/transaction/internationalPayment \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"disbursement\": {\n \"iftiInformation\": {\n \"chargeBearer\": \"\",\n \"chargesInformation\": [\n {\n \"agentBic\": \"\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"currency\": \"\"\n }\n ],\n \"instructedAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"instructionIdentification\": \"\",\n \"previousInstructingAgent\": {},\n \"regulatoryReporting\": [\n {\n \"details\": [\n {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n }\n ],\n \"relatedRemittanceInformation\": [\n {\n \"locationDetails\": [\n {\n \"method\": \"\"\n }\n ]\n }\n ],\n \"remittanceInformationStructured\": {\n \"garnishmentRemittance\": {\n \"remittedAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"referredDocumentAmount\": {\n \"creditNoteAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"duePayableAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"remittedAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"taxRemittance\": {\n \"totalTaxAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"totalTaxableBaseAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n }\n }\n }\n }'" }, { "id": "63nXicYUzbGuNxLfFTKxQ", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"disbursement\": {\n \"iftiInformation\": {\n \"chargeBearer\": \"\",\n \"chargesInformation\": [\n {\n \"agentBic\": \"\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"currency\": \"\"\n }\n ],\n \"instructedAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"instructionIdentification\": \"\",\n \"previousInstructingAgent\": {},\n \"regulatoryReporting\": [\n {\n \"details\": [\n {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n }\n ],\n \"relatedRemittanceInformation\": [\n {\n \"locationDetails\": [\n {\n \"method\": \"\"\n }\n ]\n }\n ],\n \"remittanceInformationStructured\": {\n \"garnishmentRemittance\": {\n \"remittedAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"referredDocumentAmount\": {\n \"creditNoteAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"duePayableAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"remittedAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"taxRemittance\": {\n \"totalTaxAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"totalTaxableBaseAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n }\n }\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.mpay.com.au/financial/v1/transaction/internationalPayment\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "EkXvMSCBTXsVgWjiorAvi", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/financial/v1/transaction/internationalPayment\")\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\"\nrequest.body = JSON.dump({\n \"disbursement\": {\n \"iftiInformation\": {\n \"chargeBearer\": \"\",\n \"chargesInformation\": [\n {\n \"agentBic\": \"\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"currency\": \"\"\n }\n ],\n \"instructedAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"instructionIdentification\": \"\",\n \"previousInstructingAgent\": {},\n \"regulatoryReporting\": [\n {\n \"details\": [\n {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n }\n ],\n \"relatedRemittanceInformation\": [\n {\n \"locationDetails\": [\n {\n \"method\": \"\"\n }\n ]\n }\n ],\n \"remittanceInformationStructured\": {\n \"garnishmentRemittance\": {\n \"remittedAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"referredDocumentAmount\": {\n \"creditNoteAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"duePayableAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"remittedAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"taxRemittance\": {\n \"totalTaxAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"totalTaxableBaseAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n }\n }\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "9Yn1BduloCGKkcEJScqkM", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/financial/v1/transaction/internationalPayment\"\n\npayload = json.dumps({\n \"disbursement\": {\n \"iftiInformation\": {\n \"chargeBearer\": \"\",\n \"chargesInformation\": [\n {\n \"agentBic\": \"\",\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"currency\": \"\"\n }\n ],\n \"instructedAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"instructionIdentification\": \"\",\n \"previousInstructingAgent\": {},\n \"regulatoryReporting\": [\n {\n \"details\": [\n {\n \"amount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n ]\n }\n ],\n \"relatedRemittanceInformation\": [\n {\n \"locationDetails\": [\n {\n \"method\": \"\"\n }\n ]\n }\n ],\n \"remittanceInformationStructured\": {\n \"garnishmentRemittance\": {\n \"remittedAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"referredDocumentAmount\": {\n \"creditNoteAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"duePayableAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"remittedAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n },\n \"taxRemittance\": {\n \"totalTaxAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"totalTaxableBaseAmount\": {\n \"amount\": \"\",\n \"currency\": \"\"\n }\n }\n }\n }\n }\n})\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" } ], "selectedLanguageId": "bN7JjRPRPtjCPI-CxvyUe" }, "results": { "languages": [ { "id": "ZMoQh4UdbtYaSntnJmSlz", "language": "200", "code": "// successful validation\n{\n \"transactionId\": \"\",\n \"callerUniqueReference\": \"\",\n \"durationMs\": \"\",\n \"status\": \"\",\n \"statusDescription\": \"\"\n}" } ], "selectedLanguageId": "ZMoQh4UdbtYaSntnJmSlz" } }, "children": [ { "id": "lV98u3YMvJKwVKuEGmiH6", "type": "paragraph", "children": [ { "text": "Make a NPP IPS Payment." } ] } ] }