Fileactive Testing API (1.0.3)

Download OpenAPI specification:Download

Fileactive Self-Service Testing API.

Rate limit is one request per second.

Release 1.0.3 changes:

Updated RequestMandateNotification schema to include new trigger codes MAMC, MAMD & MAMX
Updated RequestMandateNotification schema to include the amend mandate bilateral request, refer to details object. Applies when trigger code = MAMC, MAMD & MAMX
Updated MandateNotification schema to include the reason why a bilateral request was declined by the Payer, refer to resolution_event object. Applies when trigger code = MAMD & MCRD
Updated RequestQueryNotification to support migrated DDRs

Release 1.0.2 changes:

Updated descriptions from "Payee" to "Biller".

Release 1.0.1 changes:

List of mandate attributes amended by Payer can be included in RequestMandateNotification schema, refer to details object. Applies when trigger = MAMN.

Receivables

Operations related to receivables.

Request A Real Time Notification Submit

Request includes attributes which will be included in the RTN. All unspecified RTN fields will be defaulted

RTN Additional Information

Authorizations:

apiKeyAuth

header Parameters

x-Correlation-Id	string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{... Example: baf7b2b0-449d-48c7-a63a-876e72cd7b02 Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.
x-Message-Id required	string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{... Example: 3c40b28a-b902-477f-8400-6cb97d41cb06 Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message

Request Body schema: application/json
required

account_identification	string [ 1 .. 34 ] characters Account identification assigned by an institution, includes BSB. This field is not applicable for Singapore FAST
entry_reference required	string [ 1 .. 35 ] characters Unique reference for the entry
amount required	string [ 1 .. 19 ] characters Notified amount in AUD for NPP. This will be in SGD for Singapore FAST.
puid	string [ 1 .. 16 ] characters An optionally provided identifier which is returned in the requested RTN
debtor_name	string [ 1 .. 140 ] characters Debtor (payer) account name
creditor_name	string [ 1 .. 140 ] characters Creditor (biller) account name
arm_creditor_account_identification	string [ 1 .. 34 ] characters ARM(virtual)account identification, includes BSB for NPP. Only has account number for SG FAST
	object Creditor account alias (Applicable for NPP only)
	object
	object Applicable only for NPP
hierarchy	string [ 1 .. 11 ] characters Always SG/PAYMENTS (Applicable for SG FAST only)
postingBsb	string [ 1 .. 11 ] characters Will be the BIC where the funds were posted (Applicable for SG FAST only)
postingAcctNmbr	string [ 1 .. 34 ] characters will be the account number where the funds are posted (Applicable for SG FAST only)
acctBsb	string [ 1 .. 11 ] characters Will be populated with the real/natural BIC or the virtual BIC (Applicable for SG FAST only)
acctNmbr	string [ 1 .. 34 ] characters Will be populated with the real/natural account number or the ARM/virtual account number (Applicable for SG FAST only)

Responses

Request samples

Payload

Content type

application/json

Example

NPP

{"account_identification": "014814800000010",
"entry_reference": "Reference entered in the channel",
"amount": "7120.86",
"puid": "PTM2022101389715",
"debtor_name": "Andras Arato",
"creditor_name": "Holden Holdings",
"arm_creditor_account_identification": "063678965323010",
"creditor_alias": {"type": "TELI",
"identification": "+61403736550"
},
"remittance_information": {"unstructured": ["👨‍👩‍👧‍👦Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim a",
"d minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit i"
]
},
"return_information": {"reason_code": "NARR",
"additional_information": ["Beneficiary is",
"unknown"
]
}
}

Response samples

400
403
500

Content type

application/json

{"status": {"code": "EC000_003",
"severity": "Fatal",
"text": "The request failed validation {reason}"
}
}

PayTo Biller

Operations related to PayTo Biller.

Request A Mandate Notification.

Request includes attributes which will be included in the Mandate Notification.

Authorizations:

apiKeyAuth

header Parameters

x-Correlation-Id	string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{... Example: baf7b2b0-449d-48c7-a63a-876e72cd7b02 Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.
x-Message-Id required	string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{... Example: 3c40b28a-b902-477f-8400-6cb97d41cb06 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 required	string (NotificationPriority1Code) Enum: "ATTENDED" "UNATTENDED" Priority (attended/unattended) to be included in any generated notification.

Request Body schema: application/json
required

mps_user_id

required

string [ 1 .. 10 ] characters

MPS User Id which is associated with the mandate request

trigger

required

string (NotificationTrigger1Code)

Enum: "MAMC" "MAMD" "MAMN" "MAMX" "MCRC" "MCRD" "MCRX" "MSCH"

Defines events that trigger a notification.

Code	Name	Description
MAMC	MandateAmendConfirmed	Sent to the initiator of a bilateral mandate amendment to indicate that the counterparty has confirmed the action.
MAMD	MandateAmendDeclined	Sent to the initiator of a bilateral mandate amendment to indicate that the counterparty has declined the action.
MAMN	MandateAmended	Sent to the counterparty of a unilateral mandate amendment to indicate that action has occurred.
MAMX	MandateAmendExpired	Sent to the initiator of an amend action once its expiry time has been reached and the status of the action is set to Timed Out (TIMO). For a bilateral amend action, this notification is also sent to the servicer of the Debtor Account.
MCRC	MandateCreateConfirmed	Sent to the initiator of a bilateral mandate creation to indicate that the counterparty has confirmed the action.
MCRD	MandateCreateDeclined	Sent to the initiator of a bilateral mandate creation to indicate that the counterparty has declined the action.
MCRX	MandateCreateExpired	Sent to the initiator of a mandate creation action once its expiry time has been reached and the status of the action is set to Timed Out (TIMO). For a bilateral creation action, this notification is also sent to the servicer of the Debtor Account.
MSCH	MandateStatusChanged	Sent to the counterparty of a unilateral mandate status change to indicate that action has occurred.

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

required

string (MandateStatus1Code)

Enum: "ACTV" "CNCD" "SUSD"

Enumeration of the states that a mandate can have.

Code	Name	Description
ACTV	Active	The mandate has a status of active.
CNCD	Cancelled	The mandate has a status of cancelled.
SUSD	Suspended	The mandate has a status of suspended.

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" "STCH"

Enumeration of all mandate action types.

Code	Name	Description
AMND	Amend	Mandate amendment.
CREA	Create	Mandate creation.
STCH	StatusChange	Mandate status change.

action_status

required

string (MandateActionStatus1Code)

Enum: "CMPL" "DECL" "TIMO"

Enumeration of the states that a mandate action can have.

Code

Name

Description

CMPL

Completed

This status represents the following situations:

A bilateral action that has been confirmed.
A unilateral action has been performed.
A port that has been finalised.

DECL

Declined

Action has been declined.

TIMO

TimedOut

Action was created bilaterally and has now timed out.

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:

Unilateral Amendment initiated by Payer
Bilateral Amendment initiated by Biller
Status Change initiated by Payer

Property descriptions:

amendment - Mandate amendment details provided in the request, trigger = 'MAMN'.
bilateral_amendment - Mandate amendment details provided in the request, trigger ='MAMC', 'MAMD' & 'MAMX'.
status_change - Mandate status change details provided in the request, trigger ='MSCH'.

Responses

Request samples

Payload

Content type

application/json

Example

Mandate Amend Confirmed

{"mps_user_id": "10002005",
"trigger": "MAMC",
"mandate_identification": "247de1c0c3a911edafa10242ac120002",
"mandate_status": "ACTV",
"action_identification": "85f28334c3a911edafa10242ac120002",
"action_type": "AMND",
"action_status": "CMPL",
"details": {"bilateral_amendment": {"resolution_requested_by": "2023-06-10T05:13:03.255Z",
"validity_end_date": "2023-06-10",
"transfer_arrangement": "-",
"automatic_extension_indicator": false,
"payment_information": {"payment_frequency": "MNTH",
"payment_execute_not_before_time": "00:00:00-00:00",
"first_payment_amount": {"currency": "ZZZ"
},
"maximum_amount": {"currency": "AUD",
"amount": "1000.00"
},
"last_payment_date": "1000-01-01"
},
"additional_information": "Updated addtional mandate information"
}
}
}

Response samples

400
403
500

Content type

application/json

{"status": {"code": "EC000_003",
"severity": "Fatal",
"text": "The request failed validation {reason}"
}
}

Request A PayTo Query.

Request includes attributes which will be included in the Mandate Query or Mandate Query Payment.

Authorizations:

apiKeyAuth

header Parameters

x-Correlation-Id	string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{... Example: baf7b2b0-449d-48c7-a63a-876e72cd7b02 Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.
x-Message-Id required	string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{... Example: 3c40b28a-b902-477f-8400-6cb97d41cb06 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 required	string (NotificationPriority2Code) Value: "UNATTENDED" Priority (attended/unattended) to be included in any generated notification. Only UNATTENDED is supported for this request type.

Request Body schema: application/json
required

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.

Code	Name
INV14	Mandate Query

case_type

required

string

Enum: "Mandate Query Case" "Mandate Query Payments"

Case Type.

Name	Description
Mandate Query Case	A query about a mandate.
Mandate Query Payments	A query about a mandated payment.

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.

Responses

Request samples

Payload

Content type

application/json

Example

Mandate Query Case

{"case_id": "ANZAU230821-00002",
"investigation_type_code": "INV14",
"case_type": "Mandate Query Case",
"narrative": "/MandateID/247de1c0c3a911edafa10242ac120002//Reason/OAT 67/",
"mandate_details": {"mps_user_id": "10002005",
"mandate_identification": "247de1c0c3a911edafa10242ac120002",
"establishment_scheme": "AUPM",
"mandate_purpose_code": "UTIL",
"description": "Gas Agreement",
"debtor_information": {"party_name": "Andras Arato",
"account_identification_type_code": "BBAN",
"account_identification": "013010XXXXX8937"
},
"creditor_information": {"party_reference": "REF123"
},
"payment_information": {"payment_frequency": "MNTH",
"payment_amount_type": "VARI",
"maximum_amount": {"currency": "AUD",
"amount": "1000.00"
}
},
"additional_information": "Additional Mandate Info"
}
}

Response samples

400
403
500

Content type

application/json

{"status": {"code": "EC000_003",
"severity": "Fatal",
"text": "The request failed validation {reason}"
}
}

RequestRTN

account_identification	string [ 1 .. 34 ] characters Account identification assigned by an institution, includes BSB. This field is not applicable for Singapore FAST
entry_reference required	string [ 1 .. 35 ] characters Unique reference for the entry
amount required	string [ 1 .. 19 ] characters Notified amount in AUD for NPP. This will be in SGD for Singapore FAST.
puid	string [ 1 .. 16 ] characters An optionally provided identifier which is returned in the requested RTN
debtor_name	string [ 1 .. 140 ] characters Debtor (payer) account name
creditor_name	string [ 1 .. 140 ] characters Creditor (biller) account name
arm_creditor_account_identification	string [ 1 .. 34 ] characters ARM(virtual)account identification, includes BSB for NPP. Only has account number for SG FAST
	object Creditor account alias (Applicable for NPP only)
	object
	object Applicable only for NPP
hierarchy	string [ 1 .. 11 ] characters Always SG/PAYMENTS (Applicable for SG FAST only)
postingBsb	string [ 1 .. 11 ] characters Will be the BIC where the funds were posted (Applicable for SG FAST only)
postingAcctNmbr	string [ 1 .. 34 ] characters will be the account number where the funds are posted (Applicable for SG FAST only)
acctBsb	string [ 1 .. 11 ] characters Will be populated with the real/natural BIC or the virtual BIC (Applicable for SG FAST only)
acctNmbr	string [ 1 .. 34 ] characters Will be populated with the real/natural account number or the ARM/virtual account number (Applicable for SG FAST only)

{"account_identification": "014814800000010",
"entry_reference": "Reference entered in the initiating channel",
"amount": 7120.86,
"puid": "PTM2022101389715",
"debtor_name": "Andras Arato",
"creditor_name": "Holden Holdings",
"arm_creditor_account_identification": "063678965323010",
"creditor_alias": {"type": "TELI",
"identification": "+61403736550"
},
"remittance_information": {"unstructured": ["👨‍👩‍👧‍👦Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim a",
"d minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit i"
]
},
"return_information": {"reason_code": "NARR",
"additional_information": ["Beneficiary is",
"unknown"
]
},
"hierarchy": "SG/PAYMENT",
"postingBsb": "ANZBSGSXXXX",
"postingAcctNmbr": "148148000000333",
"acctBsb": "ANZBSGSXXXY",
"acctNmbr": "148148000000333"
}

RequestMandateNotification

mps_user_id

required

string [ 1 .. 10 ] characters

MPS User Id which is associated with the mandate request

trigger

required

string (NotificationTrigger1Code)

Enum: "MAMC" "MAMD" "MAMN" "MAMX" "MCRC" "MCRD" "MCRX" "MSCH"

Defines events that trigger a notification.

Code	Name	Description
MAMC	MandateAmendConfirmed	Sent to the initiator of a bilateral mandate amendment to indicate that the counterparty has confirmed the action.
MAMD	MandateAmendDeclined	Sent to the initiator of a bilateral mandate amendment to indicate that the counterparty has declined the action.
MAMN	MandateAmended	Sent to the counterparty of a unilateral mandate amendment to indicate that action has occurred.
MAMX	MandateAmendExpired	Sent to the initiator of an amend action once its expiry time has been reached and the status of the action is set to Timed Out (TIMO). For a bilateral amend action, this notification is also sent to the servicer of the Debtor Account.
MCRC	MandateCreateConfirmed	Sent to the initiator of a bilateral mandate creation to indicate that the counterparty has confirmed the action.
MCRD	MandateCreateDeclined	Sent to the initiator of a bilateral mandate creation to indicate that the counterparty has declined the action.
MCRX	MandateCreateExpired	Sent to the initiator of a mandate creation action once its expiry time has been reached and the status of the action is set to Timed Out (TIMO). For a bilateral creation action, this notification is also sent to the servicer of the Debtor Account.
MSCH	MandateStatusChanged	Sent to the counterparty of a unilateral mandate status change to indicate that action has occurred.

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

required

string (MandateStatus1Code)

Enum: "ACTV" "CNCD" "SUSD"

Enumeration of the states that a mandate can have.

Code	Name	Description
ACTV	Active	The mandate has a status of active.
CNCD	Cancelled	The mandate has a status of cancelled.
SUSD	Suspended	The mandate has a status of suspended.

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" "STCH"

Enumeration of all mandate action types.

Code	Name	Description
AMND	Amend	Mandate amendment.
CREA	Create	Mandate creation.
STCH	StatusChange	Mandate status change.

action_status

required

string (MandateActionStatus1Code)

Enum: "CMPL" "DECL" "TIMO"

Enumeration of the states that a mandate action can have.

Code

Name

Description

CMPL

Completed

This status represents the following situations:

A bilateral action that has been confirmed.
A unilateral action has been performed.
A port that has been finalised.

DECL

Declined

Action has been declined.

TIMO

TimedOut

Action was created bilaterally and has now timed out.

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:

Unilateral Amendment initiated by Payer
Bilateral Amendment initiated by Biller
Status Change initiated by Payer

Property descriptions:

amendment - Mandate amendment details provided in the request, trigger = 'MAMN'.
bilateral_amendment - Mandate amendment details provided in the request, trigger ='MAMC', 'MAMD' & 'MAMX'.
status_change - Mandate status change details provided in the request, trigger ='MSCH'.

{"mps_user_id": 10002005,
"trigger": "MAMC",
"mandate_identification": "247de1c0c3a911edafa10242ac120002",
"mandate_status": "ACTV",
"action_identification": "85f28334c3a911edafa10242ac120002",
"action_type": "AMND",
"action_status": "CMPL",
"resolution_event": {"reason_code": "MD16",
"reason_description": "Requested By Customer"
},
"details": {"amendment": {"debtorInformation": {"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"
}
}
}
}

RequestQueryNotification

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.

Code	Name
INV14	Mandate Query

case_type

required

string

Enum: "Mandate Query Case" "Mandate Query Payments"

Case Type.

Name	Description
Mandate Query Case	A query about a mandate.
Mandate Query Payments	A query about a mandated payment.

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.

{"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": "100.00"
}
},
"mandate_details": {"mps_user_id": "10002005",
"mandate_identification": "247de1c0c3a911edafa10242ac120002",
"establishment_scheme": "AUPM",
"mandate_purpose_code": "DEPD",
"description": "string",
"debtor_information": {"party_name": "string",
"account_identification_type_code": "ALIA",
"account_identification": "013010XXXXX8937",
"account_alias_type_code": "AUBN",
"account_alias_identification": "string"
},
"creditor_information": {"party_reference": "string"
},
"payment_information": {"payment_frequency": "YEAR",
"payment_execute_not_before_time": "string",
"count_per_period": "string",
"point_in_time": "string",
"payment_amount_type": "BALN",
"first_payment_amount": {"currency": "AUD",
"amount": "100.00"
},
"last_payment_amount": {"currency": "AUD",
"amount": "100.00"
},
"amount": {"currency": "AUD",
"amount": "100.00"
},
"maximum_amount": {"currency": "AUD",
"amount": "100.00"
}
},
"additional_information": "string"
}
}

Fileactive Testing API (1.0.3)

Release 1.0.3 changes:

Release 1.0.2 changes:

Release 1.0.1 changes:

Receivables

Request A Real Time Notification Submit

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

PayTo Biller

Request A Mandate Notification.

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request A PayTo Query.

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

RequestRTN

RequestMandateNotification

RequestQueryNotification

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required