Getting Started

Alliance Pay provides robust payment APIs for your business. We assume that you understand the basics of using APIs but you can read this for a quick refresher.

Unsure of where to start? Checkout our Quickstart or Postman collections.

Encryption

Most endpoints accept only encrypted requests. RSA is the supported encryption algorithm.

To help you better interact with the endpoints, Here are the unencrypted parameters for our endpoints

Create Orders

Parameter	Definition	Sample	Type	isRequired
first_name	The customer's first name.	Jane	string	Yes
last_name	The customer's last name.	Doe	string	Yes
mobile	The customer's mobile number. This should contain the ISO 3 country code.	[phone]	string	Yes
country	The customer's country. This is the ISO 2 country code.	NG	string	Yes
email	The customer's email address.	[email protected]	string	Yes
amount	The transaction amount	2300	int	Yes
reference	A unique identifier for the payment.	ORD2300	string	Yes
description	A custom descriptor or comment for the payment.	example	string	Yes
currency	The currency code.	NGN	string	Yes
redirect_url	The URL to redirect the user to after completing the payment	https://google.com/	string	No

Sample request

{
   "customer": {
       "first_name": "Jane",
       "last_name": "Doe",
       "mobile": "08024578023",
       "country": "NG",
       "email": "[email protected]"
   },
   "order": {
       "amount": 250,
       "reference": "ORD001",
       "description": "First Order",
       "currency": "NGN"
   }
}

Order Status

Parameter	Definition	Sample	Type	isRequired?
reference	A unique identifier for the payment.	ORD2300	string	Yes

Sample request

{
    "reference": "test_transaction_05"
}

Pay Orders

Card Payments

Parameter	Definition	Sample	Type	isRequired
reference	A unique identifier for the payment.	ORD2300	string	Yes
payment_option	This flag indicates the payment method used. Expected value: C.	C	string	Yes
country	The country where the card was issued.	NG	string	Yes
card	Object containing card information.		object	Yes
cvv	A 3 or 4 digit security code behind the card.	101	string	Yes
card_number	The customer's card number.	5123450000000008	string	Yes
expiry_month	The 2-digit number representing the card's expiry month.	10	string	Yes
expiry_year	The 2-digit number representing the card's expiry year.	30	string	Yes
auth_option	The auth model for noauth transactions. Expected value: noauth	noauth	string	No

Sample request

{
   "reference":"ORD001",
   "payment_option":"C",
   "country":"NG",
   "card":{
       "cvv":"101",
       "card_number":"5123450000000008",
       "expiry_month":"02",
       "expiry_year":"30"
   }
}

Pay with Bank transfer

Parameter	Definition	Sample	Type	isRequired
reference	A unique identifier for the payment.	ORD2300	string	Yes
payment_option	This flag indicates the payment method used. Expected value: BANK-TRANSFER.	BANK-TRANSFER	string	Yes
bank_transfer	Object containing payment information.		object	Yes
bank_code	3-digit code to identify the receiving bank.	035	string	Yes

Sample request

{
   "reference": "ORD001",
   "payment_option": "BANK-TRANSFER",
   "bank_transfer": {
       "bank_code": "035"
   }
}

NQR Payments

Parameter	Definition	Sample	Type	isRequired
reference	A unique identifier for the payment.	ORD2300	string	Yes
payment_option	This flag indicates the payment method used. Expected value: NQR.	NQR	string	Yes

Sample request

{
   "reference": "ORD001",
   "payment_option": "NQR"
}

USSD Payments

Parameter	Definition	Sample	Type	isRequired
reference	A unique identifier for the payment.	ORD2300	string	Yes
payment_option	This flag indicates the payment method used. Expected value: USSD.	USSD	string	Yes
ussd	Object containing payment information.		object	Yes
bank_code	3-digit code to identify the receiving bank.	035	string	Yes

Sample request

{
   "reference": "ORD001",
   "payment_option": "USSD",
   "ussd": {
       "bank_code": "035"
   }
}

Fetch Transaction fees

Parameter	Definition	Sample	Type	isRequired
amount	The transaction amount.	ORD2300	string	Yes
payment_option	This flag indicates the payment method used. Expected value: BANK-TRANSFER, C, NQR, USSD.	BANK-TRANSFER	string	Yes

Sample request

{
    "amount": 500,
    "payment_option": "BANK-TRANSFER"
}