Past business date toggle

This endpoint enables you to enable or disable the back business payment feature for a specific division, as well as business_date in the payments and multileg payments endpoint. For business_date, see Post payment and Post multileg payment for details.

NOTE:

  • Only transactions for a business date are blocked. If you want to block transactions for more than one business date, you must call this endpoint to disable transactions for each business date.
  • It is not allowed to set a business date that falls within the current or a future business cycle.
  • The channel codes configured in this toggle act as an allowlist, so any payment submitted through one of those channels bypasses the back-business-dated restriction for the relevant division and business date.
  • For transfers, which involve both a debit account and a credit account, the toggle applies independently to each account’s administrative division. Both divisions must allow the back-business-dated operation; if either division rejects it, the system rejects the entire payment.

This endpoint does not generate events.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body

string
required
≤ 36
^[a-zA-Z0-9-]+$

The division code registered in the Create division endpoint for which payments are enabled or disabled. It must comply with the rule ^[a-zA-Z0-9-]+$.

date
required

The business date on which payments will be disabled or enabled.
Notes:

  • The business date is in ISO 8601 format.
  • Users are restricted to specifying a business_date that is within a past business cycle.
  • Setting a business_date that falls within the current or a future business cycle returns a 400 error.
boolean
required

Indicates whether the payments are enabled or disabled. When set to true, payments within a division and business date are allowed. When set to false, payment requests are not allowed.

channels
array of objects

List of channels that may bypass the cutoff when enabled=false

channels
Responses

401

Access token is missing or invalid

403

The request has been lost

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json