Skip to main content
GET
/
v1
/
collections
/
{market}
/
rails
/
{rail}
Get capability document for a specific rail
curl --request GET \
  --url https://sandbox.api.eqxpay.io/v1/collections/{market}/rails/{rail} \
  --header 'Authorization: Bearer <token>'
{
  "code": "mobile_money",
  "market": "MW",
  "currency": "MWK",
  "min_amount": 100,
  "max_amount": 5000000,
  "supports_refunds": true,
  "supports_async": false,
  "settlement_time": "instant",
  "customer_fields": [
    "phone_number"
  ],
  "providers": [
    "airtel_money",
    "tnm_mpamba"
  ],
  "supported_flows": [
    "collection"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
market
string
required
Example:

"MW"

​
rail
string
required
Example:

"mobile_money"

Response

​
code
string
required
Example:

"mobile_money"

​
market
string
required
Example:

"MW"

​
currency
string
required
Example:

"MWK"

​
min_amount
number
required
Example:

100

​
max_amount
number
required
Example:

5000000

​
supports_refunds
boolean
required
Example:

true

​
supports_async
boolean
required
Example:

false

​
settlement_time
string
required

instant when same-day, T+N for deferred settlement (e.g. T+1)

Example:

"instant"

​
customer_fields
string[]
required
Example:
["phone_number"]
​
providers
string[]
required
Example:
["airtel_money", "tnm_mpamba"]
​
supported_flows
string[]
required
Example:
["collection"]