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 .
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
Parameter Definition Sample Type isRequired firstnameThe customer's first name. Jane string Yes lastnameThe customer's last name. Doe string Yes mobileThe customer's mobile number. This should contain the ISO 3 country code. +2348109001000 string Yes countryThe customer's country. This is the ISO 2 country code. NG string Yes emailThe customer's email address. [email protected] string Yes amountThe transaction amount 2300 int Yes referenceA unique identifier for the payment. ORD2300 string Yes descriptionA custom descriptor or comment for the payment. example string Yes currencyThe currency code. NGN string Yes RedirectUrlThe URL to redirect the user to after completing the payment https://google.com/ string No frequencyIdThe ID that corresponds to the billing frequency (e.g., weekly, monthly). See here for available frequencies. 1 int No numberOfPaymentThe total number of payments in a recurring schedule. If omitted, payments continue indefinitely until cancelled. 12 int No ipAddressThe IP address of the client making the request. 127.0.0.1string No userAgentThe user agent string provided by the client's browser or application Chrome/129.0.0.0string No
Sample request
{
"customer":{
"firstname":"ideos",
"lastname":"pay",
"mobile":"+23481582333444",
"country":"NG",
"email":"[email protected] "
},
"order":{
"amount":100,
"reference":"ORD001",
"description":"Pay",
"currency":"NGN"
},
"payment":{
"RedirectUrl":"https://www.hi.com"
}
}Parameter Definition Sample Type isRequired? referenceA unique identifier for the payment. ORD2300 string Yes
Sample request Encrypted
{
"reference": "test_transaction_05"
}{
"data": "ASK7UxU45861CgMkQGlcUbQgLcWBpuw4sUEnd4+xWfD5VnEK6rT07cBb32VLcHK910Hpf3K+RD5n4JSwZC6Eu0PvBLAIPjH8FCkGATyo9+C2IS8OcNGLB4cHYNIfdUAUUmDFXqXMW5uz7gmJdfH47TyTmIbEh7ErJyGnM/vDdIUHJD0eh/m/xr1xdCXIUITQyIQ9ABu6MH4W8vjFg3MaW2iJC6wJVoKejd5HomJtUiGBOrlri1tUx0xuQs3rS0/Z2qxEed0j6aZHy1wfifHY6p4WOok7umx4FTTU1In3xS8Fwh2GB4YZizFVAtrghioL2IiXNauTgV+hKk9X56Ti3A7+VOm7ytPduysitaDWL6ZxNEEyepy83amFOGBIYySUGNrltCkUx2sSezH8Zdwv9IqlFoplo5zViSqyAjUB8BP86H0YF+Toc9s9c/XjVK+w811ypVVcVlKJL6I86usKwvDgZqR8s2ExUAJBvNZFSJ+RZE9Y3JBzUm2iKPTffGO90rVX30GsGZmTVwsVw/FPPP9iUOKxFXWplXmS/5mL5R0XTh3DL3gte8FyLjMkf9BPcCiCJ6L5910Iolb2PDC/jVBqoMVRRuMO30Qgy1UuFFQ6XmHEyzXh7WUPd12l00vi3s6AOp7+J6ZMzWp42AD75K7iQ9T5GkTj0tBBmpVGrMI=",
"message": "Operation successful"
}Parameter Definition Sample Type isRequired referenceA unique identifier for the payment. ORD2300 string Yes paymentoptionThis flag indicates the payment method used. Expected value: C. C string Yes countryThe country where the card was issued. NG string Yes cardObject containing card information. object Yes cvvA 3 or 4-digit security code behind the card. 101 string Yes pinThe customer's card pin. 1234 string Yes cardnumberThe customer's card number. 5123450000000008 string Yes expirymonthThe 2-digit number representing the card's expiry month. 10 string Yes expiryyearThe 2-digit number representing the card's expiry year. 30 string Yes authOptionThe auth model for noauth transactions. Expected value: noauth noauth string No
Sample request Encrypted
{
"reference":"ORD001",
"paymentoption":"C",
"country":"NG",
"card":{
"cvv":"101",
"cardnumber":"5123450000000008",
"expirymonth":"02",
"expiryyear":"30",
"pin":"1234"
}
}{
"data": "L5j3aO/R7dFkhC79naBxPbMehPXJ5H8Oehb5m2orJElB8ARCwsofnVjdROvVvT5cTIMw+ZlAcj9dHTJHp3x62A4VHArrjenFbs8IwMZmhmhr2cZGUp26U6J0glNxJdKO+/L/U6Q6W9c1ja3cRGeP3ozzcv59WnaeWUQ5q6kOHbWSCml1BnmQrIV/tfA9d1ry1M8g01Nm6F1RHK/1r3lyTebHiJDJ6N/oAGWfYnss/l/thy+K56krHP4Pww7dUUymeQvE86p1pLpm3bp+wzngvbiRyZQpaHz2c0r926lJCP1xCJiv5KXnwHmFo7tJCqTg3FtjElEatvzmI97VXBX8bMTisXVfMvnqJtyOGj5qKDMCYb3hrqXB77FLl+hNMkkI5pEAN45re+2zESJoChiJDgqXgnxTwWyXiTnXVTwFyKi2FzvNfuArz0nifwVEb+0mIXSU7wsucdoJ2rdr0McDDYSPRUNHqspvmb7Sy+F1CgRIOCS9Df730CwCzGZlBFvdkBX1+r4wEKpYT30d67y0jukygmtsnt6gcfnMttkcsFCRmp348pGx9I3g/3xkNL8zAnDpeH+muzLritKrYvmGXX4MrKwl3cPwP11P42t2G1wNBflx1HjYX7u3YYLj4joAVleo43Say3l5Q7nD/LVqW19teHHOOjUZA9KBX3eWuEk=",
"message": "Operation successful"
}Parameter Definition Sample Type isRequired referenceA unique identifier for the payment. ORD2300 string Yes paymentoptionThis flag indicates the payment method used. Expected value: BANK-TRANSFER. BANK-TRANSFER string Yes banktransferObject containing payment information. object Yes bankcode3-digit code to identify the receiving bank. 035 string Yes
Sample request
{
"reference": "ORD001",
"paymentoption": "BANK-TRANSFER",
"banktransfer": {
"bankcode": "035"
}
}Parameter Definition Sample Type isRequired referenceA unique identifier for the payment. ORD2300 string Yes paymentoptionThis flag indicates the payment method used. Expected value: NQR. NQR string Yes
Sample request
{
"reference": "ORD001",
"paymentoption": "NQR"
}
Parameter Definition Sample Type isRequired referenceA unique identifier for the payment. ORD2300 string Yes paymentoptionThis flag indicates the payment method used. Expected value: USSD. USSD string Yes ussdObject containing payment information. object Yes bankcode3-digit code to identify the receiving bank. 035 string Yes
Sample request
{
"reference": "ORD001",
"paymentoption": "USSD",
"ussd": {
"bankcode": "035"
}
}Parameter Definition Sample Type isRequired amountThe transaction amount. ORD2300 string Yes paymentoptionThis flag indicates the payment method used. Expected value: BANK-TRANSFER, C, NQR, USSD. BANK-TRANSFER string Yes
Sample request
{
"amount": 500,
"paymentoption": "BANK-TRANSFER"
}