Skip to content

Payment Methods

The Payment Methods allows you to retrieve the available payment channels configured for a specific country. This ensures that only supported payment options are used when initiating a transaction.

By querying this endpoint, you can dynamically determine which payment methods (such as mobile money, bank transfer, cards, or brijwallet) are available based on the wallet.

URL: {BaseURL}/paymentmethods

Field NameStructure/KeyTypeDescription
CurrencycurrencystringSpecifies the supported currency for the transaction, typically represented using the ISO 4217 currency code (e.g., KSH, GHS, NGN). This must match the wallet created on your account.

php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => '{{BaseURL}}/paymentmethods',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "currency": "Currency goes here"
}',
  CURLOPT_HTTPHEADER => array(
    'Accept: application/json',
    'Content-Type: application/json',
    'Authorization: Bearer YOUR_SECRET_KEY'
  ),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
js
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{BaseURL}}/paymentmethods',
  'headers': {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Authorization': Bearer YOUR_SECRET_KEY'
  },
  body: JSON.stringify({
    "currency": "Currency goes here"
  })
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
bash
curl --location '{{BaseURL}}/paymentmethods' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_KEY' \
--data '{
    "currency": "Currency goes here"
}'
Response