GLOBAL PAYMENT (CROSS-BORDER)

Supported Channels

Retrieve supported payment channels (bank transfer, mobile money) for a given country and ramp type. Use the returned channelid as channel_id in transfer and collection requests.

GET /v1/crossborder/channels

Request

Query Parameters

Parameter	Type	Required	Description
`country_code`	string	✅	ISO 3166-1 alpha-2 country code (e.g. `KE`)
`ramptype`	string	✅	`deposit` for collections · `withdraw` for transfers

Code Samples

const axios = require("axios");

const response = await axios.get(
  "https://sandbox.hitchpay.ng/v1/crossborder/channels",
  {
    params: {
      country_code: "KE",
      ramptype: "deposit"
    },
    headers: {
      Authorization: `Bearer ${process.env.ACCESS_TOKEN}`
    }
  }
);

console.log(response.data);

<?php

$params = http_build_query([
  "country_code" => "KE",
  "ramptype"     => "deposit"
]);

$ch = curl_init();

curl_setopt_array($ch, [
  CURLOPT_URL => "https://sandbox.hitchpay.ng/v1/crossborder/channels?{$params}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer YOUR_ACCESS_TOKEN"
  ]
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

import requests

url = "https://sandbox.hitchpay.ng/v1/crossborder/channels"

headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

params = {
    "country_code": "KE",
    "ramptype": "deposit"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())

Response

200 — Success

{
  "status": "success",
  "message": "Supported channels retrieved successfully.",
  "data": [
    {
      "channelid": "de274d59-46b3-49a8-8836-3c0cc5b73a4f",
      "value": "bank",
      "paytype": "bank transfer",
      "channeltype": "bank",
      "currency": "KES",
      "minpay": 300,
      "maxpay": 0,
      "dstatus": 1
    },
    {
      "channelid": "cebda160-9966-4485-8d36-6205d516b050",
      "value": "momo",
      "paytype": "mobile money",
      "channeltype": "momo",
      "currency": "KES",
      "minpay": 10,
      "maxpay": 250000,
      "dstatus": 1
    }
  ]
}

Field	Description
`channelid`	Use as `channel_id` in transfer/collection requests
`minpay`	Minimum transaction amount in destination currency
`maxpay`	Maximum amount (0 = no upper limit)
`dstatus`	`1` = active

Questions? Email [email protected]. Also on GitBook.