Skip to main content
POST
/
v1
/
collections
/
{market}
/
rails
/
{rail}
Create a new collection (initiate inbound payment)
curl --request POST \
  --url https://sandbox.api.eqxpay.io/v1/collections/{market}/rails/{rail} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount": 5000,
  "currency": "MWK",
  "reference": "INV-2026-001",
  "customer": {
    "phone_number": "+265991234567"
  },
  "metadata": {
    "order_id": "ORD-123"
  }
}
'
{
  "collection_id": "e3d4b5c6-...",
  "integrator_id": "f1a2b3c4-...",
  "market": "MW",
  "rail": "mobile_money",
  "amount": 5000,
  "currency": "MWK",
  "reference": "INV-2026-001",
  "status": "pending",
  "customer": {
    "phone_number": "+265991234567"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "metadata": {
    "order_id": "ORD-123"
  },
  "payment_instruction": null
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string
required

Required; prevents duplicate charges on retry

Path Parameters

​
market
string
required
Example:

"MW"

​
rail
string
required
Example:

"mobile_money"

Body

application/json
​
amount
number
required

Amount in minor currency units (e.g. MWK tambala)

Example:

5000

​
currency
string
required
Example:

"MWK"

​
reference
string
required

Integrator reconciliation reference

Example:

"INV-2026-001"

​
customer
object
required

Rail-required customer fields

Example:
{ "phone_number": "+265991234567" }
​
metadata
object

Arbitrary integrator metadata preserved in all webhook payloads

Example:
{ "order_id": "ORD-123" }

Response

​
collection_id
string
required
Example:

"e3d4b5c6-..."

​
integrator_id
string
required
Example:

"f1a2b3c4-..."

​
market
string
required
Example:

"MW"

​
rail
string
required
Example:

"mobile_money"

​
amount
number
required
Example:

5000

​
currency
string
required
Example:

"MWK"

​
reference
string
required
Example:

"INV-2026-001"

​
status
string
required

Canonical status: created | pending | processing | successful | failed | expired | refunded | reversed

Example:

"pending"

​
customer
object
required
Example:
{ "phone_number": "+265991234567" }
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
expires_at
string<date-time>
required
​
metadata
object
Example:
{ "order_id": "ORD-123" }
​
payment_instruction
object

Provider payment instruction (e.g. USSD string, STK reference); null when provider is purely async

Example:

null