Update a gateway for a merchant

This API allows partners to update a gateway for a merchant

PATCH https://<PayEngine-host>/api/merchant/:merchant_id/gateways/:id

Path Parameters

Name	Type	Description
merchant_id*	UUID	Merchant ID
id	UUID	PayEngine unique ID

Request Body

Name	Type	Description
enabled	boolean	true/false
configuration	object	configuration data for this gateway
settlement_schedule.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
settlement_schedule.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
settlement_schedule.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

200

Field Definitions

Field Name	Type	Description
merchant_id	UUID	PayEngine system ID for the merchant
id	UUID	PayEngine unique gateway ID
gateway_id (deprecated)	string	Deprecated. Use gateway instead.
gateway	string	3rd party gateway type. Example: nmi | sierra | viaconex | stripe | elavon | payrix | etc. List Available Gateways
enabled	boolean	true/false
configuration	object	configuration data for this gateway

Webhook event: GATEWAY_UPDATED

Webhook Payload Example

{
  "event_uid": "2671112f7b359343729bff31197529c5",
  "event": "GATEWAY_UPDATED",
  "data": {
    "gateway": {
      "enabled": false,
      "gateway": "actum",
      "merchant_id": "4b270c54-faef-4c65-b56d-40f0179bf8b4"
    },
    "account_id": "4bc4e85c-2a4c-49fa-b9be-11966c3205ca"
  }
}