Get a connector

Returns a single connector by ID, including its execution steps. The richer single-connector shape (with steps) is only available from this endpoint, not the list. Optionally pass transactionType to get steps scoped to that type.

GET /connectors/{connectorId}

Get a connector

cURL

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

200

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "acceptedAsset": "<string>",
  "destinationAsset": "<string>",
  "direction": "OFF_RAMP",
  "method": "MOBILE_MONEY",
  "status": "ACTIVE",
  "requiresQuote": true,
  "isActive": true,
  "methodProvider": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "imageUrl": "<string>"
  },
  "limits": [
    {
      "id": "<string>",
      "scope": "<string>",
      "type": "<string>",
      "duration": 123,
      "minValue": 123,
      "maxValue": 123,
      "currency": "<string>"
    }
  ],
  "execution": [
    {
      "step": 123,
      "name": "<string>",
      "path": "<string>",
      "method": "<string>",
      "additionalInstructions": "<string>"
    }
  ],
  "transactionTypes": [
    {
      "type": "C2C",
      "status": "ONLINE"
    }
  ],
  "supportedTransactionType": {
    "b2b": true,
    "b2c": true,
    "c2b": true,
    "c2c": true
  },
  "region": {
    "iso": "<string>"
  }
}

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.

Path Parameters

connectorId · string · required

Connector identifier.

Query Parameters

transactionType · string

Transaction type to scope execution steps (e.g. C2C).

Response

200

application/json

The connector.

id · string · required

name · string · required

description · string

acceptedAsset · string

destinationAsset · string

direction · string

Example:

"OFF_RAMP"

method · string

Example:

"MOBILE_MONEY"

status · string

Example:

"ACTIVE"

requiresQuote · boolean

isActive · boolean

methodProvider · object

Show child attributes

limits · object[]

Show child attributes

execution · object[]

The connector's execution steps. Only present on GET /v1/connectors/{connectorId}, not on the list response.

Show child attributes

transactionTypes · object[]

Each transaction type the connector supports (C2C/C2B/B2C/B2B), with its own status.

Show child attributes

supportedTransactionType · object

Which transaction-type categories the connector supports.

Show child attributes

region · object

Show child attributes