Get Account-Level Settlement Schedule

Use this endpoint to retrieve the default settlement schedule configured at the account level.

Note: This reflects the schedule that applies to all merchants without custom settlement configurations.

GET https://<PayEngine-host>/api/settlement-schedules

Response

Name	Type	Description
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

curl --location --request GET '<API_HOST>/api/settlement-schedules

--header 'Authorization: Basic <API_KEY>'

Sample Response - success

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