Banking days API

This resource is used to check whether a specific day is an Australian Direct Debit banking day and whether transactions will be processed on that day.

This is useful to help with selecting a date for your payments based on a desired settlement date. This resource can also help with reconciliation of payments when it might not be known whether settlement will occur on that day.

Some payments may require additional processing that will mean a payment may not be processed on a particular day. Use the Get Payment Details resource to check the date and details of a payment

Check banking day

Check whether a date is an Australian Direct Debit banking day.

Request

GET `/banking-days/{YYYY-MM-DD}`

Path parameters

Parameter Name	Format	Description
`date`	`string`	The date to check. In the format YYYY-MM-DD.

Request body

None.

Response

Field	Format	Description
`date`	`string`	The date that was checked. In the format YYYY-MM-DD.
`isBankingDay`	`boolean`	Indicates whether the date checked is a banking day.
`nextBankingDay`	`string`	The next banking day after the date that was checked. In the format YYYY-MM-DD.
`previousBankingDay`	`string`	The previous banking day before the one that was checked. In the format YYYY-MM-DD.

For example:

{
    "date": "2018-06-01",
    "isBankingDay": true,
    "nextBankingDay": "2018-06-04",
    "previousBankingDay": "2018-05-31"
}

HTTP Status Codes

See HTTP Status Codes for more.

Status Code	Description	More information
`200`	OK	Authorisation succeeded and your software/network can access the API.
`401`	UNAUTHORIZED	Authorisation failed. View more.
`403`	FORBIDDEN	Your facility may not be set up. View more.
`407`	PROXY AUTHENTICATION REQUIRED	This error is returned by your proxy server, not PaymentsPlus. You need to configure a proxy username and password in order to access the internet.