List Gateways Connected to Merchant
description: >-
This API allows our partner to retrieve a list of Gateways connected to a
merchant ID
List Gateways Connected to Merchant
Get a list of all gateways supported by PayEngine
GET https://<PayEngine-host>/api/merchant/:merchantId/gateways
Path Parameters
Name
Type
Description
merchant_id
UUID
Merchant ID
Field Name
Types
Description
merchant_id
UUID
Merchant ID
data
array
All gateways
data[i].id
UUID
PayEngine unique gateway ID
data[i].gateway_id (deprecated)
string
Deprecated. Use gateway instead.
data[i].gateway
string
3rd party gateway type.
Example:
nmi | sierra | viaconex | stripe | elavon | payrix | etc.
List Available Gateways
data[i].nickname
string
Nickname given to the gateway
data[i].capabilities
object
Capabilities enabled for the gateway
data[i].enabled
boolean
true / false
{
"merchant_id": "b984b025-dd88-487b-bd35-a169978dda8c",
"data": [
{
"id": "495fa2cd-8196-4029-aac5-3b3e5671b65c",
"gateway_id": "nmi", // deprecated
"gateway": "nmi",
"nickname": "payengine-2",
"capabilities": {
"cc_payments": true
},
"enabled": true
},
{
"id": "272027f6-da8e-47e6-b6b8-b2e27461412a",
"gateway_id": "nmi", // deprecated
"gateway": "nmi",
"nickname": "payengine-3",
"capabilities": {
"cc_payments": true
},
"enabled": true
}
]
}Last updated