Get Gateway's Settlement Schedule

Use this endpoint to retrieve the current settlement schedule configuration for a specific gateway tied to a merchant account.

GET https://<Platform-host>/api/merchant/:merchant_id/gateways/:gateway_id/settlement-schedule

Path Parameters

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

Response

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

curl --location --request GET '<API_HOST>/api/merchant/1cc7b594-b80f-4227-a0fa-299c4c6ce8ab/gateways/5322d0d2-ab71-49ab-ac6f-eaa53af50ad4/settlement-schedule \

--header 'Authorization: Basic <API_KEY>'

Sample Response - Success

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