Connect a gateway to a merchant

This API allows partners to connect a gateway to a merchant

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

Path Parameters

Name	Type	Description
id*	UUID	Merchant ID

Request Body

Name	Type	Description
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
configuration*	object	Configuration data for this gateway
enabled	boolean	true/false default: false
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 merchant ID.
id	UUID	PayEngine merchant 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

Webhook Event: GATEWAY_CREATED

Webhook Payload Example

{
  "event_uid": "d0d1c829c5c01be3b2a34583e826e939",
  "event": "GATEWAY_CREATED",
  "data": {
    "gateway": {
      "id": "8e2f55b2-3f0d-4e9b-a58b-9ab42edf7d62",
      "enabled": true,
      "gateway": "viaconex",
      "merchant_id": "e84dec2c-0bcb-49a8-afaf-5ebbdf9c7087"
    },
    "account_id": "4bc4e85c-2a4c-49fa-b9be-11966c3205ca"
  }
}