ITE1 Self-Service Bilateral Scheduled Settlement Instruction Request
Overview
The Bilateral Scheduled Settlement Instruction Request Self-Service Tool is provided to Payment Providers to act as a Participant to initiate the Bilateral Scheduled Settlement Instruction (BSSI) workflow via upload of a configurable CSV file using a cURL command to a REST endpoint, which will be consumed and validated by the CSP.
The REST endpoint translates the CSV files into an ISO XML message (Bilateral Scheduled Settlement Instruction Request (sett_105)) which is then submitted to the CSP.
The Bilateral Scheduled Settlement Instruction Request Self-Service Tool requires users to specify the User Defined ID component of the Transaction ID. The User Defined ID must be unique across all transactions for the respective Party ID.
For further information, refer to Transaction IDs and Reference fields.
The Self-Service CSV files must be populated with a Settlement Amount that is greater than zero, where the Payment is ‘AMPT’, indicating the transaction is ‘Against Payment Settlement’. Where the Payment is populated with ‘FREE’, indicating the transaction is a ‘Separate Settlement’, the Settlement Amount will not be populated.
On successful submission and validation of the CSV file, the CSP sends the following messages for an unmatched Bilateral Scheduled Settlement Instruction Request (sett_105):
Settlement Instruction Status Advice (sett_109) to the Requesting Participant; and
Settlement Instruction Allegement Notification (sett_110) to the Counterparty.
The Bilateral Scheduled Settlement Instruction Auto-Responder will then match the Bilateral Scheduled Settlement Instruction Request (sett_105) and send the matched Bilateral Scheduled Settlement Instruction Request (sett_105) to the CSP. Refer to Bilateral Settlement Instruction Process for further information regarding elements present in the CSV file.
If the CSV submitted by the requesting party is invalid due to errors in the business validity, an Invalid Transaction (comm_808) is received.
If the CSV submitted by the requesting party is invalid due to errors in the file format or schema validity, a rejection from the Self-Service Tool is received.
These responses are delivered to the REST endpoint, where they are converted to a JSON response.
The maximum CSV files size accepted by the Self-Service Tool is 50kb. The minimum number of records accepted by the Self-Service tool input via a CSV file is 1 record and the maximum number of records accepted is 50 records. The CSV file will be rejected if either of these parameters are violated.
The Self-Service Tool will parse the entire CSV file and ensure a summary of error/s is available to the CHESS user. The error response will specify the Transaction Id and the number of the row in which the error occurred.
Sample Template
The file below contains an Excel file template which is used to the build the CSV submission to the cURL.
When populating the CSV, the developer is required to ensure:
The message includes the appropriate fields, as populated in the attached template; and
Supplied dates are valid business dates.
Connection Details
Prior to establishing connection to the ITE1, Payment Providers will need to generate and submit a Certificate Signing Request and acquire the ASX root / issuing CA public key (instructions are available on the FTP). Payment Providers are also required to populate the CSV sample file above.
The below code snippet demonstrates how to establish connection to the Self-Service Bilateral Scheduled Settlement Instruction Request.
curl
// Verbose output
-v
// Informs recipients that the client is about to send a message body in this request and wishes to receive a 100 (continue) interim response
-H "Expect: 100-continue"
// ASX’s CA’s public keys in pem format
--cacert /c/path/to/file.pem
// File containing the certificate of the client machine
--cert /c/path/to/file.cer
// Private key of the client certificate provided in cert option
--key /c/path/to/file.key
// The URL of the Self-Service Tool
"https://ite1-test-tool.asx.com.au:5000/xmlIngest/sett105bssi"
// Header option to accept json format (not the same as the CSV file)
-H "accept: application/json"
// Header option to tell curl command that it will be form-data in other words file as input
-H "Content-Type: multipart/form-data"
// The input CSV file to be sent as part of the request
-F "file=@/c/path/to/file.csv"
In the above code fragment:
URL: The URL for Self-Service Bilateral Scheduled Settlement Instruction Requests is ite1-test-tool.asx.com.au. The local host DNS needs to be reconfigured to 203.4.179.146 to ensure correct routing.
Port: The port number exposed for Self-Service Tool.
- style