Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Payments

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.

put/corporate/v1/feature/back-business/toggle

Request body

division_codestring required

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-]+$.

business_datestring date required

The business date on which payments will be disabled or enabled.<br> <b>Notes</b>:

  • 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.
enabledboolean 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.

channelsChannelCode[]

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

Example request

{
  "division_code": "my-division-code",
  "business_date": "2023-03-09",
  "enabled": true,
  "channels": [
    "GCE",
    "GDP"
  ]
}

Response

Ok

division_codestring required

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-]+$.

business_datestring date required

The business date on which payments will be disabled or enabled.<br> <b>Notes</b>:

  • 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.
enabledboolean 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.

channelsChannelCode[]

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

Example response

{
  "division_code": "my-division-code",
  "business_date": "2023-03-09",
  "enabled": true,
  "channels": [
    "GCE",
    "GDP"
  ]
}