Appearance
Card Payment
The Card Payment method allows customers to securely pay using their debit or credit cards. This option supports online transactions and provides a fast and convenient way to complete payments.
URL: {BASEURL}/pay
| Field Name | Structure/Key | Type | Description |
|---|---|---|---|
| Transaction ID | transaction_id | string | This is the unique identifier for the transaction |
| Merchant ID | merchant_id | string | This is the unique identifier assigned to a merchant, used to associate transactions and requests with the correct merchant account |
| Wallet Currency | currency | string | Specifies the currency in which the transaction is conducted, typically represented using the ISO 4217 currency code (e.g., KSH, GHS, NGN etc). Note that this must correspond with the wallet you have created on your account. |
| Payment Detail | payment_details | Object | Contains detailed information about the payment |
| Mobile Money | payment_details.momo_number | string | The active mobile number. |
| One-Time Password | payment_details.otp | string | The One-Time Password sent to the intended payer before initiating the debit request. It is used to authenticate and authorize the transaction. |
| Customer Email | payment_details.customer_email | string | The payer’s email |
| Customer First name | payment_details.customer_firstname | string | The payer or customer first name |
| Customer Last name | payment_details.customer_lastname | string | The payer or customer last name |
| Description | payment_details.description | string | A brief note about the payment, such as the purpose of the transaction or details for the payer. This helps provide context for both the merchant and the customer. |
| Card Number | payment_details.card_number | string | The primary number printed on the customer’s card, used to debit the card for the transaction. |
| CVV | payment_details.card_cvv | string | The 3- or 4-digit security code on the customer’s card, used to verify and authorize the card for the transaction |
| Card Expiry Month | payment_details.expiry_month | string | The month when the customer’s card expires, used to validate the card for the transaction. |
| Card Expiry Year | amount | string | The year when the customer’s card expires, used to validate the card for the transaction. |
| Name on Card | payment_details.name_on_card | string | The cardholder’s name as printed on the card, used to verify ownership during the transaction. |
| Payment Method ID | payment_method_id | string | A Brij-generated unique ID identifying the payment method used in the transaction. |
| Amount | amount | Numeric string | The total value of the transaction to be processed, represented as a string of digits (e.g., "5000"). |
💡 only 3-DSS cards are supported
php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => '{{BaseURL}}/pay',
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 =>'{
"transaction_id": "Transaction ID",
"merchant_id": "Merchant ID",
"currency": "Wallet Currency",
"payment_details": {
"otp": "367***",
"card_number": "10************10",
"card_cvv": "***",
"expiry_month": "**", //e.g 01, 12, 08
"expiry_year": "**", //e.g 24, 25,
"name_on_card": "Test Test",
"momo_number": "+24370XXXXX",
"customer_email": "Customer Email",
"customer_firstname": "Customer First name",
"customer_lastname": "Customer Last name",
"description": "Payment Description"
},
"payment_method_id": "Brij payment method ID",
"amount": "amount"
}
',
CURLOPT_HTTPHEADER => array(
'X-Requested-With: XMLHttpRequest',
'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': '{{BaseULR}}/pay',
'headers': {
'X-Requested-With': 'XMLHttpRequest',
'Content-Type': 'application/json',
'Authorization': 'Bearer YOUR_SECRET_KEY'
},
body: JSON.stringify({
"transaction_id": "Transaction ID",
"merchant_id": "Merchant ID",
"currency": "Wallet Currency",
"payment_details": {
"otp": "367***",
"card_number": "10************10",
"card_cvv": "***",
"expiry_month": "**",
"expiry_year": "**",
"name_on_card": "Name on Card",
"momo_number": "+24370XXXXX",
"customer_email": "Customer Email",
"customer_firstname": "Customer First name",
"customer_lastname": "Customer Last name",
"description": "Payment Description"
},
"payment_method_id": "Brij payment method ID",
"amount": "amount"
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});bash
curl --location '{{BaseURL}}/pay' \
--header 'X-Requested-With: XMLHttpRequest' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_KEY' \
--data-raw '{
"transaction_id": "Transaction ID",
"merchant_id": "Merchant ID",
"currency": "Wallet Currency",
"payment_details": {
"otp": "367***",
"card_number": "Card Number",
"card_cvv": "***",
"expiry_month": "**",
"expiry_year": "**",
"name_on_card": "Name on Card",
"momo_number": "+24370XXXXX",
"customer_email": "Customer Email",
"customer_firstname": "Customer First name",
"customer_lastname": "Customer Last name",
"description": "Payment Description"
},
"payment_method_id": "Brij payment method ID",
"amount": "amount"
}'Response
