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 --request GET \
--url https://api.zeam.money/gw/v1/connectors/{connectorId} \
--header 'Authorization: Bearer <token>' \
--header 'x-zeam-auth: <api-key>'{
"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>"
}
}{
"type": "https://errors.zeam.app/validation-error",
"title": "Validation Error",
"status": 422,
"detail": "The 'amount' field must be a positive decimal.",
"instance": "/v1/quotes",
"requestId": "01J8Z6K3QW9F2",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "https://errors.zeam.app/validation-error",
"title": "Validation Error",
"status": 422,
"detail": "The 'amount' field must be a positive decimal.",
"instance": "/v1/quotes",
"requestId": "01J8Z6K3QW9F2",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "https://errors.zeam.app/validation-error",
"title": "Validation Error",
"status": 422,
"detail": "The 'amount' field must be a positive decimal.",
"instance": "/v1/quotes",
"requestId": "01J8Z6K3QW9F2",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "https://errors.zeam.app/validation-error",
"title": "Validation Error",
"status": 422,
"detail": "The 'amount' field must be a positive decimal.",
"instance": "/v1/quotes",
"requestId": "01J8Z6K3QW9F2",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "https://errors.zeam.app/validation-error",
"title": "Validation Error",
"status": 422,
"detail": "The 'amount' field must be a positive decimal.",
"instance": "/v1/quotes",
"requestId": "01J8Z6K3QW9F2",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Access token issued by POST /v1/auth/token.
Application secret (the apiKey issued at registration), required on every request.
Path Parameters
Connector identifier.
Query Parameters
Transaction type to scope execution steps (case-insensitive). Defaults to C2C.
Available options:
C2C, C2B, B2C, B2B Response
The connector.
Example:
"OFF_RAMP"
Example:
"MOMO"
Available options:
STANDARD, BESPOKE Example:
"ACTIVE"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The connector's execution steps. Only present on GET /v1/connectors/{connectorId}, not on the list response.
Show child attributes
Show child attributes
Each transaction type the connector supports (C_2_C/C_2_B/B_2_C/B_2_B), with its own status.
Show child attributes
Show child attributes
Which transaction-type categories the connector supports.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Get a connector
curl --request GET \
--url https://api.zeam.money/gw/v1/connectors/{connectorId} \
--header 'Authorization: Bearer <token>' \
--header 'x-zeam-auth: <api-key>'{
"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>"
}
}{
"type": "https://errors.zeam.app/validation-error",
"title": "Validation Error",
"status": 422,
"detail": "The 'amount' field must be a positive decimal.",
"instance": "/v1/quotes",
"requestId": "01J8Z6K3QW9F2",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "https://errors.zeam.app/validation-error",
"title": "Validation Error",
"status": 422,
"detail": "The 'amount' field must be a positive decimal.",
"instance": "/v1/quotes",
"requestId": "01J8Z6K3QW9F2",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "https://errors.zeam.app/validation-error",
"title": "Validation Error",
"status": 422,
"detail": "The 'amount' field must be a positive decimal.",
"instance": "/v1/quotes",
"requestId": "01J8Z6K3QW9F2",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "https://errors.zeam.app/validation-error",
"title": "Validation Error",
"status": 422,
"detail": "The 'amount' field must be a positive decimal.",
"instance": "/v1/quotes",
"requestId": "01J8Z6K3QW9F2",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "https://errors.zeam.app/validation-error",
"title": "Validation Error",
"status": 422,
"detail": "The 'amount' field must be a positive decimal.",
"instance": "/v1/quotes",
"requestId": "01J8Z6K3QW9F2",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}