Update Gateway's Settlement Schedule

This endpoint allows you to update the settlement schedule for a specific gateway associated with a merchant. You can configure the settlement time, timezone, and indicate whether a custom schedule is enabled.

PATCH https://<PayEngine-host>/api/merchant/:merchant_id/gateways/:gateway_id/settlement-schedule

Path Parameters

Name	Type	Description
merchant_id	string	PayEngine Merchant ID
gateway_id	string	Unique Identifier of the gateway

Request Parameters

Name	Type	Description
custom_settlement_time	string	Time of settlement in 24-hour HH:mm format (e.g., "15:00"). Note: This field is required if settlement_timezone is provided
custom_settlement_timezone	string	Timezone for the settlement time (e.g., "US/Alaska"). See list of supported timezones below Note: This field is required if settlement_time is provided
custom_settlement_enabled	boolean	Indicates whether a custom settlement time needs to be enabled.

List of supported time zones

• US/Alaska

• US/Aleutian

• US/Arizona

• US/Central

• US/Eastern

• US/Hawaii

• US/Mountain

• US/Pacific

Use the exact timezone string from the list above when setting settlement_timezone.

Response

Name	Type	Description
message	string	success | failed success - if the gateway settlement schedule is updated successfully failed - if the gateway settlement schedule is not updated
data.gateway_id	UUID	ID of the gateway associated with this settlement configuration. Note - this is the id provided in the request
data.custom_settlement_time	string	The configured settlement time (HH:mm format) Note - Time provided in the request
data.custom_settlement_timezone	string	The configured timezone Note: Timezone provided in the request
data.custom_settlement_enabled	boolean	True if the gateway is enabled for the merchant

Sample Request and Response

Sample Request

{
    "custom_settlement_time": "18:00",
    "custom_settlement_timezone": "US/Mountain",
    "custom_settlement_enabled": true
}

Sample Response - Success

{
    "message": "success",
    "data": {
        "gateway_id": "5322d0d2-ab71-49ab-ac6f-eaa53af50ad4",
        "custom_settlement_time": "18:00",
        "custom_settlement_timezone": "US/Mountain",
        "custom_settlement_enabled": true
    }
}