List connectors

Discovers connectors. Every filter is optional; without any, all connectors are listed. Fees are not part of the response (they are internal pricing inputs; use POST /v1/quotes for authoritative pricing). The connector id is the handle quotes and requirements take.

GET /connectors

List connectors

cURL

curl --request GET \
  --url https://api.zeam.money/gw/v1/connectors \
  --header 'Authorization: Bearer <token>' \
  --header 'x-zeam-auth: <api-key>'

200

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "acceptedAsset": "<string>",
      "destinationAsset": "<string>",
      "direction": "OFF_RAMP",
      "method": "MOMO",
      "flow": "STANDARD",
      "status": "ACTIVE",
      "requiresQuote": true,
      "isActive": true,
      "methodProvider": {
        "name": "<string>",
        "description": "<string>",
        "imageUrl": "<string>"
      },
      "limits": [
        {
          "scope": "<string>",
          "type": "<string>",
          "duration": 123,
          "minValue": 123,
          "maxValue": 123,
          "currency": "<string>"
        }
      ],
      "execution": [
        {
          "step": 123,
          "name": "<string>",
          "path": "<string>",
          "method": "<string>",
          "requestDefinition": {},
          "responseDefinition": {},
          "additionalInstructions": "<string>"
        }
      ],
      "transactionTypes": [
        {
          "type": "C_2_C",
          "status": "ONLINE"
        }
      ],
      "supportedTransactionType": {
        "b2b": true,
        "b2c": true,
        "c2b": true,
        "c2c": true
      },
      "region": {
        "iso": "<string>"
      }
    }
  ],
  "pagination": {
    "nextCursor": "<string>",
    "hasMore": true
  }
}

Authorizations

Authorization · string · header · required

Access token issued by POST /v1/auth/token.

x-zeam-auth · string · header · required

Application secret (the apiKey issued at registration), required on every request.

Query Parameters

countryIsoCode2 · string

ISO 3166-1 alpha-2 country code (case-insensitive).

Pattern: ^[A-Za-z]{2}$

Example:

"ZW"

method · string

Payment method (case-insensitive), e.g. BANK, MOMO, CASH.

Pattern: ^[A-Za-z0-9_]+$

Example:

"MOMO"

direction · enum<string>

Corridor direction (case-insensitive).

Available options: ON_RAMP, OFF_RAMP

Example:

"OFF_RAMP"

flow · enum<string>

STANDARD connectors are quoted and initiated; BESPOKE connectors need customer and reference registration instead.

Available options: STANDARD, BESPOKE

limit · integer · default: 20

Maximum items per page. Values above 100 are treated as 100; a non-numeric or non-positive value is a 400.

Required range: 1 <= x <= 100

cursor · string

Opaque pagination cursor from a previous response.

Response

200

application/json

A page of connectors.

data · object[] · required

Show child attributes

pagination · object · required

Show child attributes