# 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](ref:corporate-v2-post-payments) and [Post multileg payment](ref:corporate-v2-post-multileg-payments) 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.
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"info": {
"title": "Banking - Transaction banking",
"version": "0.9.0",
"description": "Transaction banking API",
"contact": {
"name": "API Support",
"url": "https://developers.pismo.io/support/"
},
"license": {
"name": "Copyright Pismo"
}
},
"servers": [
{
"url": "https://sandbox.pismolabs.io",
"description": "Sandbox API server for testing"
}
],
"security": [
{
"BearerAuth": []
}
],
"tags": [
{
"name": "Payments",
"description": "Payment endpoints supporting external accounts"
}
],
"components": {
"schemas": {
"BackBusinessToggleRequest": {
"title": "BackBusinessToggleRequest",
"type": "object",
"required": [
"division_code",
"business_date",
"enabled"
],
"properties": {
"division_code": {
"type": "string",
"description": "The division code registered in the [Create division](https://developers.pismo.io/pismo-docs/reference/post-division-v2) endpoint for which payments are enabled or disabled. It must comply with the rule `^[a-zA-Z0-9-]+$`.",
"maximum": 36,
"pattern": "^[a-zA-Z0-9-]+$",
"example": "my-division-code"
},
"business_date": {
"type": "string",
"format": "date",
"description": "The business date on which payments will be disabled or enabled.
\nNotes:\n - The business date is in ISO 8601 format.\n - Users are restricted to specifying a `business_date` that is within a past business cycle.\n - Setting a `business_date` that falls within the current or a future business cycle returns a `400` error.\n",
"example": "2023-03-09"
},
"enabled": {
"type": "boolean",
"description": "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.",
"example": true
},
"channels": {
"type": "array",
"description": "List of channels that may bypass the cutoff when `enabled=false`",
"items": {
"$ref": "#/components/schemas/ChannelCode"
},
"example": [
"GCE",
"GDP"
]
}
}
},
"ChannelCode": {
"description": "Alphanumeric channel code identifier",
"type": "string",
"minLength": 1,
"maxLength": 20,
"pattern": "^[a-zA-Z0-9]+$",
"example": "GDP"
},
"ErrorCode": {
"description": "Error code\n`minLength: 1`\n`maxLength: 12`\n",
"type": "string",
"minLength": 1,
"maxLength": 12,
"example": "WPMT0017"
},
"ErrorMessage": {
"description": "Error message\n`minLength: 1`\n`maxLength: 1000`\n",
"type": "string",
"minLength": 1,
"maxLength": 1000,
"example": "Invalid JSON payload received: Error unmarshalling request"
},
"ErrorResponse": {
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/ErrorCode"
},
"message": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
}
},
"responses": {
"401Unauthorized": {
"description": "Access token is missing or invalid"
},
"403Forbidden": {
"description": "The request has been lost"
}
},
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
},
"paths": {
"/corporate/v1/feature/back-business/toggle": {
"put": {
"summary": "Past business date toggle",
"description": "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](https://developers.pismo.io/pismo-docs/reference/corporate-v2-post-payments) and [Post multileg payment](https://developers.pismo.io/pismo-docs/reference/corporate-v2-post-multileg-payments) for details.\n\nNOTE:\n- 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.\n- It is not allowed to set a business date that falls within the current or a future business cycle.\n- 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.\n- 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.\n\nThis endpoint does not generate events.",
"parameters": [],
"operationId": "put-back-business-toggle",
"tags": [
"Payments"
],
"requestBody": {
"description": "Request body",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackBusinessToggleRequest"
},
"examples": {
"Disable with channels": {
"value": {
"enabled": false,
"division_code": "CN6",
"business_date": "2026-02-23",
"channels": [
"GCE",
"GDP"
]
}
},
"Disable without channels": {
"value": {
"enabled": false,
"division_code": "CN6",
"business_date": "2026-02-23"
}
},
"Enable": {
"value": {
"enabled": true,
"division_code": "CN6",
"business_date": "2026-02-23"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BackBusinessToggleRequest"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"Invalid JSON payload": {
"value": {
"code": "WBBT0001",
"message": "Invalid JSON payload received: Error unmarshalling request"
}
},
"Enabled required": {
"value": {
"code": "WBBT0002",
"message": "enabled is a required field"
}
},
"Division code required": {
"value": {
"code": "WBBT0002",
"message": "division_code is a required field"
}
},
"Division code exceeds size": {
"value": {
"code": "WBBT0002",
"message": "division_code must be a maximum of 36 characters in length"
}
},
"Business date invalid format": {
"value": {
"code": "WBBT0002",
"message": "business_date {business_date} should be formatted as yyyy-mm-dd and be a valid date"
}
},
"Business date required": {
"value": {
"code": "WBBT0002",
"message": "business_date is a required field"
}
},
"Business date fall within future cycle": {
"value": {
"code": "WBBT0003",
"message": "Business date must fall within a past business cycle"
}
},
"Division not found": {
"value": {
"code": "WBBT0004",
"message": "Division not found"
}
},
"Channel not found": {
"summary": "Channel not found",
"value": {
"code": "WBBT0005",
"message": "Channel '{channel}' not found"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/401Unauthorized"
},
"403": {
"$ref": "#/components/responses/403Forbidden"
},
"500": {
"description": "Internal Errors",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"Generic internal error": {
"value": {
"code": "ECMN9999",
"message": "Internal error"
}
}
}
}
}
}
}
}
}
}
}
```