Download OpenAPI specification:Download
Fileactive PayTo API Webhook provides consumers the ability to receive:
Payloads will be encrypted and signed prior to transmitting. Customers will need to decrypt the payload and verify the signature prior to processing the Processing Outcome or Notification.
Processing Outcomes and Notifications may arrive out of sequence and may be delivered more than once. ANZ will attempt to deliver each Processing Outcome and Notification at least once.
The purpose of this operation is to provide the processing outcome of the following mandate actions initiated by the Biller via the PayTo API - Mandate:
Duplicate checking should be based on the request_id
, i.e. the Biller identifiyer provided in the original mandate request.
X-RequestKey required | string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{... Example: 325ea624-ac19-47e2-94ef-a1ab4e487275 Internal End to End key used for support and reporting purposes. Echoed from the Mandate Request acknowledgement or MPIR acknowledgement |
X-Message-Id required | string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{... Example: 3d003c66-2d00-4092-8d8a-e55ba9bf8b2b Duplicate check using point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message |
X-Correlation-Id | string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{... Example: 71d6fb19-7515-40dc-b045-e17550b67600 Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging. Echoed from the Mandate Request or MPIR |
priority | string (NotificationPriority1Code) Enum: "ATTENDED" "UNATTENDED" Priority (attended/unattended) to be included in any generated notification. This value does not affect the priority for processing within the MMS. It may, depending on topic configuration, influence which topic any generated notification is sent to. |
Secured resource, refer to Model/Schema MandateActionOutcome for unencrypted payload object
secured_payload required | string Encrypted and secured payload |
{- "secured_payload": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpbnN0cnVjdGlvbl9pZGVudGlmaWNhdGlvbiI6IlRDMTIxLzE0NzE4NzM4MjMiLCJlbmRfdG9fZW5kX2lkZW50aWZpY2F0aW9uIjoiTk9UUFJPVklERUQiLCJjcmVhdGlvbl9kYXRlX3RpbWUiOiIyMDE4LTA5LTE3VDA5OjQ1OjQ3WiIsImluaXRpYXRpbmdfcGFydHlfbmFtZSI6IkN1c3RvbWVyQSIsInJlcXVlc3RlZF9leGVjdXRpb25fZGF0ZSI6IjIwMTgtMDktMTciLCJkZWJ0b3JfbmFtZSI6IkJJTEJPIEJBR0dJTlMiLCJkZWJ0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMzQyMTIzNDU2NyIsImRlYnRvcl9hY2NvdW50X3R5cGUiOiJCQkFOIiwiaW5zdHJ1Y3RlZF9hbW91bnQiOnsiY3VycmVuY3kiOiJBVUQiLCJhbW91bnQiOiI1NjIuODkifSwiY3JlZGl0b3JfbmFtZSI6IlNBTVdJU0UgR0FNR0VFIiwiY3JlZGl0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMDE2OTg3NjU0MzIxIiwiY3JlZGl0b3JfYWNjb3VudF90eXBlIjoiQkJBTiIsImNyZWRpdG9yX2FnZW50X2JpYyI6Ik5PVFBST1ZJREVEIiwicmVtaXR0YW5jZV9pbmZvcm1hdGlvbl91bnN0cnVjdHVyZWQiOlsiRklSU1QgTElORSIsIlNFQ09ORCBMSU5FIl19.aR2RMEVTuOOI1YuUCf2Ppo3Bwtf2_91WMvLd3IIA0ToHBDn0II36FumIz2RrwiUNHBMZo41Qmjv_zt9TQbq61csx2lRZcQNNsstAXKZWI4oZjlBaenj3HvY2_ztxS2IPNZNlVUQrw8A51-1dm-EeVTsqwhxs-Ir6d1FCee5SaNBrhtfaDBGAwjtXolPJuyYve0J3F8X-JwKPLBUaQH5LgGlTOSasC0vsKqhfpZOc-3rS39UA7q0jHQyqcJKrhinEyWlTFU9PcOh2W4-0hXiPaLJ_PA-_EkY5kYBnBvUWofVy35ZnB_u0wv0gxvVVDYKLGUpOGblaWRUY09SHx52Njw"
}
{- "id": "a27f873f-663e-49c2-a688-10fd1c5ffe11",
- "status": "RCVD"
}
The purpose of this operation is to provide a notification where the Payer has taken an action on a Mandate. The following notifications are supported:
Duplicate checking should be based on MMS assigined identfier action_identification
X-Message-Id required | string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{... Example: 3d003c66-2d00-4092-8d8a-e55ba9bf8b2b Duplicate check using point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message |
priority | string (NotificationPriority1Code) Enum: "ATTENDED" "UNATTENDED" Priority (attended/unattended) to be included in any generated notification. This value does not affect the priority for processing within the MMS. It may, depending on topic configuration, influence which topic any generated notification is sent to. |
Secured resource, refer to Model/Schema MandateNotification for unencrypted payload object
secured_payload required | string Encrypted and secured payload |
{- "secured_payload": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpbnN0cnVjdGlvbl9pZGVudGlmaWNhdGlvbiI6IlRDMTIxLzE0NzE4NzM4MjMiLCJlbmRfdG9fZW5kX2lkZW50aWZpY2F0aW9uIjoiTk9UUFJPVklERUQiLCJjcmVhdGlvbl9kYXRlX3RpbWUiOiIyMDE4LTA5LTE3VDA5OjQ1OjQ3WiIsImluaXRpYXRpbmdfcGFydHlfbmFtZSI6IkN1c3RvbWVyQSIsInJlcXVlc3RlZF9leGVjdXRpb25fZGF0ZSI6IjIwMTgtMDktMTciLCJkZWJ0b3JfbmFtZSI6IkJJTEJPIEJBR0dJTlMiLCJkZWJ0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMzQyMTIzNDU2NyIsImRlYnRvcl9hY2NvdW50X3R5cGUiOiJCQkFOIiwiaW5zdHJ1Y3RlZF9hbW91bnQiOnsiY3VycmVuY3kiOiJBVUQiLCJhbW91bnQiOiI1NjIuODkifSwiY3JlZGl0b3JfbmFtZSI6IlNBTVdJU0UgR0FNR0VFIiwiY3JlZGl0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMDE2OTg3NjU0MzIxIiwiY3JlZGl0b3JfYWNjb3VudF90eXBlIjoiQkJBTiIsImNyZWRpdG9yX2FnZW50X2JpYyI6Ik5PVFBST1ZJREVEIiwicmVtaXR0YW5jZV9pbmZvcm1hdGlvbl91bnN0cnVjdHVyZWQiOlsiRklSU1QgTElORSIsIlNFQ09ORCBMSU5FIl19.aR2RMEVTuOOI1YuUCf2Ppo3Bwtf2_91WMvLd3IIA0ToHBDn0II36FumIz2RrwiUNHBMZo41Qmjv_zt9TQbq61csx2lRZcQNNsstAXKZWI4oZjlBaenj3HvY2_ztxS2IPNZNlVUQrw8A51-1dm-EeVTsqwhxs-Ir6d1FCee5SaNBrhtfaDBGAwjtXolPJuyYve0J3F8X-JwKPLBUaQH5LgGlTOSasC0vsKqhfpZOc-3rS39UA7q0jHQyqcJKrhinEyWlTFU9PcOh2W4-0hXiPaLJ_PA-_EkY5kYBnBvUWofVy35ZnB_u0wv0gxvVVDYKLGUpOGblaWRUY09SHx52Njw"
}
{- "id": "a27f873f-663e-49c2-a688-10fd1c5ffe11",
- "status": "RCVD"
}
The purpose of this operation is to provide the processing outcome of the following MPIR actions initiated by the Biller via the PayTo API - MPIR:
If MPIR is processed same day and successfully settles then transaction_status
will be ACSC Settlement Completed.
If MPIR is future dated then transaction_status
will be PDNG Warehoused. This will be followed by the settlement processing outcome once requested_execution_date
is reached.
If MPIR settlement is delayed then transaction_status
will be ACSP Settlement Pending. This will be followed by the settlement processing outcome.
If MPIR is invalid or fails settlement then transaction_status
will be RJCT Rejected. The transaction_status_reason_code
will indicate the reason for rejection.
Duplicate checking should be based on Biller assigined identfier instruction_identification
/ uetr
and transaction_status
Biller should also consider Processing Outcomes for the same MPIR arrving out of sequence.
X-RequestKey required | string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{... Example: 325ea624-ac19-47e2-94ef-a1ab4e487275 Internal End to End key used for support and reporting purposes. Echoed from the Mandate Request acknowledgement or MPIR acknowledgement |
X-Message-Id required | string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{... Example: 3d003c66-2d00-4092-8d8a-e55ba9bf8b2b Duplicate check using point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message |
X-Correlation-Id | string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{... Example: 71d6fb19-7515-40dc-b045-e17550b67600 Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging. Echoed from the Mandate Request or MPIR |
priority | string (NotificationPriority1Code) Enum: "ATTENDED" "UNATTENDED" Priority (attended/unattended) to be included in any generated notification. Urgency or order of importance that the originator would like the recipient of the payment instruction to apply to the processing of the payment instruction. |
Secured resource, refer to Model/Schema MPIRActionOutcome for unencrypted payload object
secured_payload required | string Encrypted and secured payload |
{- "secured_payload": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpbnN0cnVjdGlvbl9pZGVudGlmaWNhdGlvbiI6IlRDMTIxLzE0NzE4NzM4MjMiLCJlbmRfdG9fZW5kX2lkZW50aWZpY2F0aW9uIjoiTk9UUFJPVklERUQiLCJjcmVhdGlvbl9kYXRlX3RpbWUiOiIyMDE4LTA5LTE3VDA5OjQ1OjQ3WiIsImluaXRpYXRpbmdfcGFydHlfbmFtZSI6IkN1c3RvbWVyQSIsInJlcXVlc3RlZF9leGVjdXRpb25fZGF0ZSI6IjIwMTgtMDktMTciLCJkZWJ0b3JfbmFtZSI6IkJJTEJPIEJBR0dJTlMiLCJkZWJ0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMzQyMTIzNDU2NyIsImRlYnRvcl9hY2NvdW50X3R5cGUiOiJCQkFOIiwiaW5zdHJ1Y3RlZF9hbW91bnQiOnsiY3VycmVuY3kiOiJBVUQiLCJhbW91bnQiOiI1NjIuODkifSwiY3JlZGl0b3JfbmFtZSI6IlNBTVdJU0UgR0FNR0VFIiwiY3JlZGl0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMDE2OTg3NjU0MzIxIiwiY3JlZGl0b3JfYWNjb3VudF90eXBlIjoiQkJBTiIsImNyZWRpdG9yX2FnZW50X2JpYyI6Ik5PVFBST1ZJREVEIiwicmVtaXR0YW5jZV9pbmZvcm1hdGlvbl91bnN0cnVjdHVyZWQiOlsiRklSU1QgTElORSIsIlNFQ09ORCBMSU5FIl19.aR2RMEVTuOOI1YuUCf2Ppo3Bwtf2_91WMvLd3IIA0ToHBDn0II36FumIz2RrwiUNHBMZo41Qmjv_zt9TQbq61csx2lRZcQNNsstAXKZWI4oZjlBaenj3HvY2_ztxS2IPNZNlVUQrw8A51-1dm-EeVTsqwhxs-Ir6d1FCee5SaNBrhtfaDBGAwjtXolPJuyYve0J3F8X-JwKPLBUaQH5LgGlTOSasC0vsKqhfpZOc-3rS39UA7q0jHQyqcJKrhinEyWlTFU9PcOh2W4-0hXiPaLJ_PA-_EkY5kYBnBvUWofVy35ZnB_u0wv0gxvVVDYKLGUpOGblaWRUY09SHx52Njw"
}
{- "id": "a27f873f-663e-49c2-a688-10fd1c5ffe11",
- "status": "RCVD"
}
The purpose of this operation is to provide a notification where the Payer has raised a PayTo query via the Payer's Financial Institution. The following notifications are supported:
The Biller should respond to the PayTo Query via the PayTo API - Query
Duplicate checking should be based on ANZ assigined identfier case_id
and reminder_count
and re_open_case_indication
X-Message-Id required | string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{... Example: 3d003c66-2d00-4092-8d8a-e55ba9bf8b2b Duplicate check using point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message |
priority | string (NotificationPriority2Code) Value: "UNATTENDED" Priority (attended/unattended) to be included in any generated notification. Urgency or order of importance that the originator would like the recipient of the PayTo query to apply to the processing of the query. |
Secured resource, refer to Model/Schema QueryNotification for unencrypted payload object
secured_payload required | string Encrypted and secured payload |
{- "secured_payload": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpbnN0cnVjdGlvbl9pZGVudGlmaWNhdGlvbiI6IlRDMTIxLzE0NzE4NzM4MjMiLCJlbmRfdG9fZW5kX2lkZW50aWZpY2F0aW9uIjoiTk9UUFJPVklERUQiLCJjcmVhdGlvbl9kYXRlX3RpbWUiOiIyMDE4LTA5LTE3VDA5OjQ1OjQ3WiIsImluaXRpYXRpbmdfcGFydHlfbmFtZSI6IkN1c3RvbWVyQSIsInJlcXVlc3RlZF9leGVjdXRpb25fZGF0ZSI6IjIwMTgtMDktMTciLCJkZWJ0b3JfbmFtZSI6IkJJTEJPIEJBR0dJTlMiLCJkZWJ0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMzQyMTIzNDU2NyIsImRlYnRvcl9hY2NvdW50X3R5cGUiOiJCQkFOIiwiaW5zdHJ1Y3RlZF9hbW91bnQiOnsiY3VycmVuY3kiOiJBVUQiLCJhbW91bnQiOiI1NjIuODkifSwiY3JlZGl0b3JfbmFtZSI6IlNBTVdJU0UgR0FNR0VFIiwiY3JlZGl0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMDE2OTg3NjU0MzIxIiwiY3JlZGl0b3JfYWNjb3VudF90eXBlIjoiQkJBTiIsImNyZWRpdG9yX2FnZW50X2JpYyI6Ik5PVFBST1ZJREVEIiwicmVtaXR0YW5jZV9pbmZvcm1hdGlvbl91bnN0cnVjdHVyZWQiOlsiRklSU1QgTElORSIsIlNFQ09ORCBMSU5FIl19.aR2RMEVTuOOI1YuUCf2Ppo3Bwtf2_91WMvLd3IIA0ToHBDn0II36FumIz2RrwiUNHBMZo41Qmjv_zt9TQbq61csx2lRZcQNNsstAXKZWI4oZjlBaenj3HvY2_ztxS2IPNZNlVUQrw8A51-1dm-EeVTsqwhxs-Ir6d1FCee5SaNBrhtfaDBGAwjtXolPJuyYve0J3F8X-JwKPLBUaQH5LgGlTOSasC0vsKqhfpZOc-3rS39UA7q0jHQyqcJKrhinEyWlTFU9PcOh2W4-0hXiPaLJ_PA-_EkY5kYBnBvUWofVy35ZnB_u0wv0gxvVVDYKLGUpOGblaWRUY09SHx52Njw"
}
{- "id": "a27f873f-663e-49c2-a688-10fd1c5ffe11",
- "status": "RCVD"
}
creation_date_time required | string^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]... Date and time when Processing outcome notification was processed by ANZ, not the MMS processing time. UTC expressed without offset, i.e. YYYY-MM-DDThh:mm:ss.sssZ An ISODateTime whereby all timezoned dateTime values are UTC. | ||||||||||||||||||
status required | string Enum: "RJCT" "SUCC" Status of the mandate request action.
| ||||||||||||||||||
mps_user_id | string [ 1 .. 10 ] characters MPS User Id which is associated with the mandate request | ||||||||||||||||||
request_id | string^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... Request UUID that identifies the mandate operation to be performed. This must be a Universally Unique IDentifier (UUID). Echoed from the mandate request | ||||||||||||||||||
mandate_identification | string^[a-f0-9]{12}1[a-f0-9]{3}[89ab][a-f0-9]{15}$ Unique ID, as assigned by the MMS, to unambiguously identify the mandate. This ID must be used to identify the mandate for all further operations on the mandate. Universally Unique IDentifier (UUID) version 1, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace" without the 4 hyphen separators. For example: '00000000000010008000000000000000' instead of '00000000-0000-1000-8000-000000000000' (without quotes) | ||||||||||||||||||
mandate_registration_date_time | string^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]... Date and time when the Mandate was originally registered in the MMS for a given Account Servicer, UTC expressed without offset, i.e. YYYY-MM-DDThh:mm:ss.sssZ An ISODateTime whereby all timezoned dateTime values are UTC. | ||||||||||||||||||
mandate_status | string Enum: "ACTV" "CNCD" "CRTD" "SUSD" Enumeration of the states that a mandate can have.
| ||||||||||||||||||
action_identification | string^[a-f0-9]{12}1[a-f0-9]{3}[89ab][a-f0-9]{15}$ Unique ID assigned to the mandate request action. This ID is used to uniquely identify the action for all further operations on a mandate action. Universally Unique IDentifier (UUID) version 1, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace" without the 4 hyphen separators. For example: '00000000000010008000000000000000' instead of '00000000-0000-1000-8000-000000000000' (without quotes) | ||||||||||||||||||
action_type | string (MandateActionType1Code) Enum: "AMND" "CREA" "PORT" "STCH" Enumeration of all mandate action types.
| ||||||||||||||||||
action_status | string (MandateActionStatus1Code) Enum: "CMPL" "DECL" "PEND" "RECL" "TIMO" Enumeration of the states that a mandate action can have.
| ||||||||||||||||||
bilateral | boolean Boolean flag indicating if the action was created as bilateral or unilateral. This will only be present for mandate creation and amendment actions. | ||||||||||||||||||
debtor_alias_name | string Debtor Alias Name. Only provided where a debtor alias was provided in the Mandate Creation request or Mandate Amendment request. | ||||||||||||||||||
resolution_requested_by | string^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]... Optional time used to indicate by when resolution of a bilateral action is requested from the other party to the mandate. It will be provided in any notification sent to the counterparty. This time is for informational purposes only and does not affect the expiry time imposed by the MMS. | ||||||||||||||||||
object (GenericStatus1) Specifies the generic status as a result of a method applied to a Resource. Property descriptions:
|
{- "creation_date_time": "2023-03-16T15:01:20.246Z",
- "status": "SUCC",
- "mps_user_id": "10002005",
- "request_id": "055c7f30-99f8-4ff9-a561-6b2b4346ed38",
- "mandate_identification": "247de1c0c3a911edafa10242ac120002",
- "mandate_registration_date_time": "2023-03-16T15:01:20.246Z",
- "mandate_status": "CRTD",
- "action_identification": "85f28334c3a911edafa10242ac120002",
- "action_type": "CREA",
- "action_status": "PEND",
- "bilateral": true,
- "debtor_alias_name": "Barney J Rubble",
- "resolution_requested_by": "2023-06-10T05:13:03.255Z",
- "error": {
- "code": "string",
- "severity": "FATL",
- "text": "string",
- "user_message": "string",
- "more_info": "string"
}
}
creation_date_time required | string^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]... Date and time when mandate notification was processed by ANZ, not the MMS processing time. UTC expressed without offset, i.e. YYYY-MM-DDThh:mm:ss.sssZ An ISODateTime whereby all timezoned dateTime values are UTC. | |||||||||||||||||||||||||||
trigger required | string (NotificationTrigger1Code) Enum: "MAMC" "MAMD" "MAMN" "MAMX" "MCRC" "MCRD" "MCRX" "MSCH" Defines events that trigger a notification.
| |||||||||||||||||||||||||||
mps_user_id required | string [ 1 .. 10 ] characters MPS User Id which is associated with the mandate request | |||||||||||||||||||||||||||
mandate_identification required | string^[a-f0-9]{12}1[a-f0-9]{3}[89ab][a-f0-9]{15}$ Unique ID, as assigned by the MMS, to unambiguously identify the mandate. This ID must be used to identify the mandate for all further operations on the mandate. Universally Unique IDentifier (UUID) version 1, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace" without the 4 hyphen separators. For example: '00000000000010008000000000000000' instead of '00000000-0000-1000-8000-000000000000' (without quotes) | |||||||||||||||||||||||||||
mandate_status | string Enum: "ACTV" "CNCD" "CRTD" "SUSD" Enumeration of the states that a mandate can have.
| |||||||||||||||||||||||||||
action_identification required | string^[a-f0-9]{12}1[a-f0-9]{3}[89ab][a-f0-9]{15}$ Unique ID assigned to the mandate request action. This ID is used to uniquely identify the action for all further operations on a mandate action. Universally Unique IDentifier (UUID) version 1, as described in IETC RFC 4122 "Universally Unique IDentifier (UUID) URN Namespace" without the 4 hyphen separators. For example: '00000000000010008000000000000000' instead of '00000000-0000-1000-8000-000000000000' (without quotes) | |||||||||||||||||||||||||||
action_type required | string (MandateActionType1Code) Enum: "AMND" "CREA" "PORT" "STCH" Enumeration of all mandate action types.
| |||||||||||||||||||||||||||
action_status required | string Enum: "CMPL" "DECL" "PEND" "RECL" "TIMO" Enumeration of the states that a mandate action can have.
| |||||||||||||||||||||||||||
object (MandateActionResolutionEvent1) Specification of the resolution event for a mandate action. | ||||||||||||||||||||||||||||
MandateAmendmentRequest (object) or MandateAmendmentRequestBilat (object) or MandateStatusChangeDetails (object) Details of an action performed on a mandate:
Property descriptions:
|
{- "creation_date_time": "2023-03-16T15:01:20.246Z",
- "trigger": "MCRC",
- "mps_user_id": "10002005",
- "mandate_identification": "247de1c0c3a911edafa10242ac120002",
- "mandate_status": "ACTV",
- "action_identification": "85f28334c3a911edafa10242ac120002",
- "action_type": "CREA",
- "action_status": "CMPL",
- "resolution_event": {
- "reason_code": "MD16",
- "reason_description": "Requested By Customer"
}, - "details": {
- "amendment": {
- "debtor_information": {
- "party_type": "ORGN",
- "party_name": "Barney Rubble",
- "ultimate_party_name": "Barney Rubble",
- "account_identification_type_code": "ALIA",
- "account_identification": "013010230008937",
- "account_alias_type_code": "TELI",
- "account_alias_identification": "+61-423765879",
- "party_reference": "RUBBLE-01"
}
}
}
}
creation_date_time required | string^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]... Date and time when Processing outcome notification was processed by ANZ, not the MPIR processing time. UTC expressed without offset, i.e. YYYY-MM-DDThh:mm:ss.sssZ An ISODateTime whereby all timezoned dateTime values are UTC. | |||||||||||||||
transaction_status required | string Enum: "ACSC" "ACSP" "PDNG" "RJCT" Specifies the status of the MPIR.
| |||||||||||||||
transaction_status_reason_code | string [ 1 .. 4 ] characters Reason for the status, as published in an external reason code list. | |||||||||||||||
transaction_status_additional_information | Array of strings[ items [ 1 .. 105 ] characters ] Additional information relating to the status code and reason. | |||||||||||||||
mps_user_id | string [ 1 .. 10 ] characters MPS User Id which is associated with the MPIR | |||||||||||||||
instruction_identification | string [ 1 .. 35 ] characters Unique identification as assigned by ANZ for an instructed party to unambiguously identify the instruction. | |||||||||||||||
uetr | string^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][... Universally unique identifier to provide an end-to-end reference of a payment transaction. Echoed from MPIR | |||||||||||||||
account_servicer_reference | string [ 1 .. 35 ] characters Unique reference, as assigned by the account servicing institution, to unambiguously identify the instruction. | |||||||||||||||
clearing_system_reference | string [ 1 .. 35 ] characters Unique reference, as assigned by a clearing system, to unambiguously identify the instruction. | |||||||||||||||
acceptance_date_time | string^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]... Point in time when the payment order from the initiating party meets the processing conditions of the account servicing agent. This means that the account servicing agent has received the payment order and has applied checks such as authorisation, availability of funds. | |||||||||||||||
object Key elements used to identify the original transaction that is being referred to. |
{- "creation_date_time": "2023-03-16T15:01:20.246Z",
- "transaction_status": "ACSC",
- "transaction_status_reason_code": "stri",
- "transaction_status_additional_information": [
- "string"
], - "mps_user_id": "10002005",
- "instruction_identification": "ANZBAU3LXXXI20230621900000000011200",
- "uetr": "06c9a782-ea52-4475-aaa3-653c5a303954",
- "account_servicer_reference": "MPS123456789",
- "clearing_system_reference": "CUSCAU2SXXXN20230403000139150001900",
- "acceptance_date_time": "2023-06-13T15:01:20.246Z",
- "original_transaction_reference": {
- "original_instruction_identification": "TC121/1471873823",
- "instructed_amount": {
- "currency": "AUD",
- "amount": "103.10"
}, - "mandate_identification": "247de1c0c3a911edafa10242ac120002",
- "creditor_name": "string",
- "creditor_ultimate_name": "string",
- "creditor_account_identification": "013010230008937"
}
}
creation_date_time required | string^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]... Date and time when PayTo Query notification was processed by ANZ, not when the PayTo query was raised. UTC expressed without offset, i.e. YYYY-MM-DDThh:mm:ss.sssZ An ISODateTime whereby all timezoned dateTime values are UTC. | ||||||
case_id required | string [ 1 .. 20 ] characters Case Identifier. A unique case reference as assigned by ANZ. To be referenced when providing a Query Resolution. | ||||||
investigation_type_code required | string Value: "INV14" Investigation Type Code.
| ||||||
case_type required | string Enum: "Mandate Query Case" "Mandate Query Payments" Case Type.
| ||||||
reminder_count | string [ 1 .. 2 ] characters Reminder Count. Will be incremented by 1 each time ANZ generates the same PayTo query notiication where no Query Resolution has been received. | ||||||
re_open_case_indication | boolean Re-opened Case Indicator. Where ANZ re-opens a previously closed case this flag will be set to true. | ||||||
narrative required | string [ 1 .. 2048 ] characters Narrative as sent by Payer's OFI. | ||||||
object Key elements used to identify the original transaction that is being referred to. | |||||||
required | object (QueryMandateDetails) Key Mandate details for the referenced Mandate Id in the PayTo Query. |
{- "creation_date_time": "2023-03-16T15:01:20.246Z",
- "case_id": "ANZAU230821-00002",
- "investigation_type_code": "INV14",
- "case_type": "Mandate Query Case",
- "reminder_count": "1",
- "re_open_case_indication": true,
- "narrative": "/MandateID/20a73840a79c11eda83b9b809f5abcbe//Reason/OAT 67/",
- "payment_details": {
- "transaction_identification": "CUSCAU2SXXXN20230403000139150001900",
- "instruction_identification": "ANZBAU3LXXXI20230621900000000011200",
- "transaction_date": "2023-03-01",
- "original_transaction_amount": {
- "currency": "AUD",
- "amount": "103.10"
}
}, - "mandate_details": {
- "mps_user_id": "10002005",
- "mandate_identification": "247de1c0c3a911edafa10242ac120002",
- "establishment_scheme": "AUPM",
- "mandate_purpose_code": "RETL",
- "description": "Car purchase",
- "debtor_information": {
- "party_name": "string",
- "account_identification_type_code": "ALIA",
- "account_identification": "013010XXXXX8937",
- "account_alias_type_code": "TELI",
- "account_alias_identification": "+61-423765879"
}, - "creditor_information": {
- "party_reference": "LOONEYTUNES-01"
}, - "payment_information": {
- "payment_frequency": "MNTH",
- "payment_execute_not_before_time": "23:31:14.450Z",
- "count_per_period": "42",
- "point_in_time": "12",
- "payment_amount_type": "VARI",
- "first_payment_amount": {
- "currency": "AUD",
- "amount": "103.10"
}, - "last_payment_amount": {
- "currency": "AUD",
- "amount": "103.10"
}, - "amount": {
- "currency": "AUD",
- "amount": "103.10"
}, - "maximum_amount": {
- "currency": "AUD",
- "amount": "103.10"
}
}, - "additional_information": "Addtional mandate information"
}
}
secured_payload required | string Encrypted and secured payload |
{- "secured_payload": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpbnN0cnVjdGlvbl9pZGVudGlmaWNhdGlvbiI6IlRDMTIxLzE0NzE4NzM4MjMiLCJlbmRfdG9fZW5kX2lkZW50aWZpY2F0aW9uIjoiTk9UUFJPVklERUQiLCJjcmVhdGlvbl9kYXRlX3RpbWUiOiIyMDE4LTA5LTE3VDA5OjQ1OjQ3WiIsImluaXRpYXRpbmdfcGFydHlfbmFtZSI6IkN1c3RvbWVyQSIsInJlcXVlc3RlZF9leGVjdXRpb25fZGF0ZSI6IjIwMTgtMDktMTciLCJkZWJ0b3JfbmFtZSI6IkJJTEJPIEJBR0dJTlMiLCJkZWJ0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMzQyMTIzNDU2NyIsImRlYnRvcl9hY2NvdW50X3R5cGUiOiJCQkFOIiwiaW5zdHJ1Y3RlZF9hbW91bnQiOnsiY3VycmVuY3kiOiJBVUQiLCJhbW91bnQiOiI1NjIuODkifSwiY3JlZGl0b3JfbmFtZSI6IlNBTVdJU0UgR0FNR0VFIiwiY3JlZGl0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMDE2OTg3NjU0MzIxIiwiY3JlZGl0b3JfYWNjb3VudF90eXBlIjoiQkJBTiIsImNyZWRpdG9yX2FnZW50X2JpYyI6Ik5PVFBST1ZJREVEIiwicmVtaXR0YW5jZV9pbmZvcm1hdGlvbl91bnN0cnVjdHVyZWQiOlsiRklSU1QgTElORSIsIlNFQ09ORCBMSU5FIl19.aR2RMEVTuOOI1YuUCf2Ppo3Bwtf2_91WMvLd3IIA0ToHBDn0II36FumIz2RrwiUNHBMZo41Qmjv_zt9TQbq61csx2lRZcQNNsstAXKZWI4oZjlBaenj3HvY2_ztxS2IPNZNlVUQrw8A51-1dm-EeVTsqwhxs-Ir6d1FCee5SaNBrhtfaDBGAwjtXolPJuyYve0J3F8X-JwKPLBUaQH5LgGlTOSasC0vsKqhfpZOc-3rS39UA7q0jHQyqcJKrhinEyWlTFU9PcOh2W4-0hXiPaLJ_PA-_EkY5kYBnBvUWofVy35ZnB_u0wv0gxvVVDYKLGUpOGblaWRUY09SHx52Njw"
}