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"
  }
}
'

import requests

url = "https://sandbox.api.eqxpay.io/v1/collections/{market}/rails/{rail}"

payload = {
    "amount": 5000,
    "currency": "MWK",
    "reference": "INV-2026-001",
    "customer": { "phone_number": "+265991234567" },
    "metadata": { "order_id": "ORD-123" }
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 5000,
    currency: 'MWK',
    reference: 'INV-2026-001',
    customer: {phone_number: '+265991234567'},
    metadata: {order_id: 'ORD-123'}
  })
};

fetch('https://sandbox.api.eqxpay.io/v1/collections/{market}/rails/{rail}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.api.eqxpay.io/v1/collections/{market}/rails/{rail}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 5000,
    'currency' => 'MWK',
    'reference' => 'INV-2026-001',
    'customer' => [
        'phone_number' => '+265991234567'
    ],
    'metadata' => [
        'order_id' => 'ORD-123'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.api.eqxpay.io/v1/collections/{market}/rails/{rail}"

	payload := strings.NewReader("{\n  \"amount\": 5000,\n  \"currency\": \"MWK\",\n  \"reference\": \"INV-2026-001\",\n  \"customer\": {\n    \"phone_number\": \"+265991234567\"\n  },\n  \"metadata\": {\n    \"order_id\": \"ORD-123\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.api.eqxpay.io/v1/collections/{market}/rails/{rail}")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 5000,\n  \"currency\": \"MWK\",\n  \"reference\": \"INV-2026-001\",\n  \"customer\": {\n    \"phone_number\": \"+265991234567\"\n  },\n  \"metadata\": {\n    \"order_id\": \"ORD-123\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.api.eqxpay.io/v1/collections/{market}/rails/{rail}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 5000,\n  \"currency\": \"MWK\",\n  \"reference\": \"INV-2026-001\",\n  \"customer\": {\n    \"phone_number\": \"+265991234567\"\n  },\n  \"metadata\": {\n    \"order_id\": \"ORD-123\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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
}

POST

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"
  }
}
'

import requests

url = "https://sandbox.api.eqxpay.io/v1/collections/{market}/rails/{rail}"

payload = {
    "amount": 5000,
    "currency": "MWK",
    "reference": "INV-2026-001",
    "customer": { "phone_number": "+265991234567" },
    "metadata": { "order_id": "ORD-123" }
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 5000,
    currency: 'MWK',
    reference: 'INV-2026-001',
    customer: {phone_number: '+265991234567'},
    metadata: {order_id: 'ORD-123'}
  })
};

fetch('https://sandbox.api.eqxpay.io/v1/collections/{market}/rails/{rail}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.api.eqxpay.io/v1/collections/{market}/rails/{rail}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 5000,
    'currency' => 'MWK',
    'reference' => 'INV-2026-001',
    'customer' => [
        'phone_number' => '+265991234567'
    ],
    'metadata' => [
        'order_id' => 'ORD-123'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.api.eqxpay.io/v1/collections/{market}/rails/{rail}"

	payload := strings.NewReader("{\n  \"amount\": 5000,\n  \"currency\": \"MWK\",\n  \"reference\": \"INV-2026-001\",\n  \"customer\": {\n    \"phone_number\": \"+265991234567\"\n  },\n  \"metadata\": {\n    \"order_id\": \"ORD-123\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.api.eqxpay.io/v1/collections/{market}/rails/{rail}")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 5000,\n  \"currency\": \"MWK\",\n  \"reference\": \"INV-2026-001\",\n  \"customer\": {\n    \"phone_number\": \"+265991234567\"\n  },\n  \"metadata\": {\n    \"order_id\": \"ORD-123\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.api.eqxpay.io/v1/collections/{market}/rails/{rail}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 5000,\n  \"currency\": \"MWK\",\n  \"reference\": \"INV-2026-001\",\n  \"customer\": {\n    \"phone_number\": \"+265991234567\"\n  },\n  \"metadata\": {\n    \"order_id\": \"ORD-123\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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

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

Get capability document for a specific rail

List collections for the authenticated integrator