Cashbuddy API

We have discovered a more inclusive and convenient way for you to pay your bills, receive payments and also become a bill payment service provider.

Bills Payments

Airtime API

POST https://app.cashbuddy.ng/apis/apiAirtime

This endpoint allows you to get free airtime.

Headers

Name
Type
Description

Secret-Key

string

Secret Authentication Key to access your product, found in your cashbuddy settings.

Request Body

Name
Type
Description

email

string

Account email attributed your secret key.

amount

number

Amount of the airtime

phone

number

Phone number to recharge

network

string

The network provider of the user

{    "status": "1",    "message": "Airtime purchase was successful",    "network": "mtn"}
curl --location --request POST 'https://app.cashbuddy.ng/apis/apiAirtime' \
--header 'Secret-Key: Bearer YOUR_SECRET_KEY' \
--form 'email="developer@cashbuddy.com"' \
--form 'phone=""' \
--form 'network=""' \
--form 'amount=""'

Data API

POST https://app.cashbuddy.ng/apis/apiData

This endpoint help you to recharge data and internet services To get biller_name call https://app.cashbuddy.ng/apis/apiFetchBills?network=airtel, See https://cashbuddyng.gitbook.io/cashbuddy/#fetch-bills-items. The networks available are airtel, 9mobile, glo, mtn, smile, spectranet. Send the amount of the plan returned on bills endpoint.

Headers

Name
Type
Description

Secret-Key

string

Secret Authentication Key to access your product, found in your cashbuddy settings.

Request Body

Name
Type
Description

biller_name

string

Get the biller name from fetch bills endpoint after supplying the network needed, all list of data plans will be returned.

amount

number

The amount attributed to the data plan.

network

string

The network providers e.g mtn, glo, 9mobile, airtel, smile, spectranet.

phone

number

Phone number to recharge.

email

string

The email attributed to your secret key.

{    "status": "1",    "message": "Data purchase was successful",    "network": "mtn"}
curl --location --request POST 'https://app.cashbuddy.ng/apis/apiData' \
--header 'Secret-Key: Bearer YOUR_SECRET_KEY' \
--form 'email="developer@cashbuddy.com"' \
--form 'phone="08103******"' \
--form 'network="mtn"' \
--form 'amount="500"' \
--form 'biller_name=""'

Electricity API

POST https://app.cashbuddy.ng/apis/apiElectricity

This endpoint help you pay for your electricity bills, to get biller_name call https://app.cashbuddy.ng/apis/apiFetchBills?network=eko-electric, See https://cashbuddyng.gitbook.io/cashbuddy/#fetch-bills-items. The distributions available are eko-electric, ibadan-electric, ikeja-electric, portharcourt-electric and enugu-electric. Send the amount to be paid by users to the distribution.

Headers

Name
Type
Description

Secret-Key

string

Secret Authentication Key to access your product, found in your cashbuddy settings.

Request Body

Name
Type
Description

amount

integer

Amount to be paid to the electricity distribution.

meter_number

number

The meter number of your electronic meter.

biller_name

string

Get bills name from fetch electricity bills payment after supplying the network, URL https://app.cashbuddy.ng/apis/apiFetchBills?network=eko-electric to fetch your data.

network

string

Available networks are eko-electric, ibadan-electric, ikeja-electric, portharcourt-electric and enugu-electric.

email

string

The email account attributed to your secret key.

{    "status": "1",    "message": "Electricity payment was successful"}
curl --location --request POST 'https://app.cashbuddy.ng/apis/apiElectricity' \
--header 'Secret-Key: Bearer YOUR_SECRET_KEY' \
--form 'email="developer@cashbuddy.com"' \
--form 'meter_number="29728728*******"' \
--form 'network="eko-electric"' \
--form 'amount="10000"' \
--form 'biller_name="EKEDC PREPAID TOPUP"'

Cable/TV Subscription API

POST https://app.cashbuddy.ng/apis/apiTv

Use this endpoint to pay for your dstv, gotv and startimes and earn commission on each single transaction.

Headers

Name
Type
Description

Secret-Key

string

Secret Authentication Key to access your product, found in your cashbuddy settings.

Request Body

Name
Type
Description

card_no

number

This is your smart card number from your service provider's decoder.

network

string

Networks are gotv, dstv and startimes.

biller_name

string

Get bills name from fetch cable/tv subscription payment after supplying the network, URL https://app.cashbuddy.ng/apis/apiFetchBills?network=dstv to fetch your data.

amount

number

The amount returned by fetch cable/tv bills endpoint.

email

string

The email account attributed to your secret key.

{    "status": "1",    "message": "Cable subscription was successful"}
curl --location --request POST 'https://app.cashbuddy.ng/apis/apiTv' \
--header 'Secret-Key: Bearer YOUR_SECRET_KEY' \
--form 'email="developer@cashbuddy.com"' \
--form 'amount="200"' \
--form 'card_no="12345*****"' \
--form 'network="dstv"' \
--form 'biller_name=""'

Funds API

Funds Transfer API

POST https://app.cashbuddy.ng/apis/apiTransfer

This endpoint will enable you to transfer money to any bank in Nigeria.

Headers

Name
Type
Description

Secret-Key

string

Secret Authentication Key to access your product, found in your cashbuddy settings.

Request Body

Name
Type
Description

message

string

Transfer description.

amount

integer

The amount to be transfered.

bank_code

number

the bank code of the bank gotten from Fetch all banks api.

account_number

number

The account number to send the money to.

email

string

The email account attributed to your secret key.

{    "status": "1",    "message": "Your transfer was successful"}
curl --location --request POST 'https://app.cashbuddy.ng/apis/apiTransfer' \
--header 'Secret-Key: Bearer YOUR_SECRET_KEY' \
--form 'email="developer@cashbuddy.com"' \
--form 'amount="200"' \
--form 'account_number="12345*****"' \
--form 'bank_code="046"' \
--form 'message="Funds Description"'

Cash Pin Generation

Generate Pin

POST https://app.cashbuddy.ng/apis/apiGeneratePins

Cash card pin is one card unlimited use, used to recharge, purchace data, pay for bills e.g bet, gotv, dstv, startimes, electricity and funds transfer also to pay for anything online using Cashbuddy Payment Processor.

Headers

Name
Type
Description

Secret-Key

string

Secret Authentication Key to access your product, found in your cashbuddy settings.

Request Body

Name
Type
Description

amount

integer

Amount value to pin printed on cash card.

count

number

The number of times to generate that value.

email

string

The email account attributed to your secret key.

{
    "status": "1",
    "message": "PIN GENERATED SUCCESSFULLY",
    "generated_pin": "3",
    "pin": [
        {
            "pin": "67104******",
            "amount": "100",
            "status": "available"
        },
        {
            "pin": "35053******",
            "amount": "100",
            "status": "available"
        },
        {
            "pin": "92722******",
            "amount": "100",
            "status": "available"
        }
    ]
}
curl --location --request POST 'https://app.cashbuddy.ng/apis/apiGeneratePins' \
--header 'Secret-Key: Bearer YOUR_SECRET_KEY' \
--form 'email="developer@cashbuddy.com"' \
--form 'amount="200"' \
--form 'count="5"'

Fetch bills payment item

Fetch all banks with bank codes API

POST https://app.cashbuddy.ng/apis/apiFetchBanks

Fetch all banks in nigeria with this endpoint.

Headers

Name
Type
Description

Secret-Key

string

Secret Authentication Key to access your product, found in your cashbuddy settings.

Request Body

Name
Type
Description

email

string

The email account attributed to your secret key.

{
    "status": "success",
    "message": "Banks fetched successfully",
    "data": [
        {
            "id": 1,
            "code": "044",
            "name": "Access Bank"
        },
        {
            "id": 2,
            "code": "023",
            "name": "Citi Bank"
        },
        {
            "id": 4,
            "code": "050",
            "name": "EcoBank PLC"
        },
        {
            "id": 5,
            "code": "011",
            "name": "First Bank PLC"
        },
        {
            "id": 6,
            "code": "214",
            "name": "First City Monument Bank"
        },
        {
            "id": 7,
            "code": "070",
            "name": "Fidelity Bank"
        },
        {
            "id": 8,
            "code": "058",
            "name": "Guaranty Trust Bank"
        },
        {
            "id": 9,
            "code": "076",
            "name": "Polaris bank"
        },
        {
            "id": 10,
            "code": "221",
            "name": "Stanbic IBTC Bank"
        },
        {
            "id": 11,
            "code": "068",
            "name": "Standard Chaterted bank PLC"
        },
        {
            "id": 12,
            "code": "232",
            "name": "Sterling Bank PLC"
        },
        {
            "id": 13,
            "code": "033",
            "name": "United Bank for Africa"
        },
        {
            "id": 14,
            "code": "032",
            "name": "Union Bank PLC"
        },
        {
            "id": 15,
            "code": "035",
            "name": "Wema Bank PLC"
        },
        {
            "id": 16,
            "code": "057",
            "name": "Zenith bank PLC"
        },
        {
            "id": 17,
            "code": "215",
            "name": "Unity Bank PLC"
        },
        {
            "id": 18,
            "code": "101",
            "name": "ProvidusBank PLC"
        },
        {
            "id": 183,
            "code": "082",
            "name": "Keystone Bank"
        },
        {
            "id": 184,
            "code": "301",
            "name": "Jaiz Bank"
        },
        {
            "id": 186,
            "code": "030",
            "name": "Heritage Bank"
        },
        {
            "id": 231,
            "code": "100",
            "name": "Suntrust Bank"
        },
        {
            "id": 252,
            "code": "608",
            "name": "FINATRUST MICROFINANCE BANK"
        },
        {
            "id": 253,
            "code": "090175",
            "name": "Rubies Microfinance Bank"
        },
        {
            "id": 254,
            "code": "090267",
            "name": "Kuda"
        },
        {
            "id": 258,
            "code": "090115",
            "name": "TCF MFB"
        },
        {
            "id": 259,
            "code": "400001",
            "name": "FSDH Merchant Bank"
        },
        {
            "id": 260,
            "code": "502",
            "name": "Rand merchant Bank"
        },
        {
            "id": 301,
            "code": "103",
            "name": "Globus Bank"
        },
        {
            "id": 389,
            "code": "327",
            "name": "Paga"
        },
        {
            "id": 395,
            "code": "000026",
            "name": "Taj Bank Limited"
        },
        {
            "id": 596,
            "code": "100022",
            "name": "GoMoney"
        },
        {
            "id": 597,
            "code": "090180",
            "name": "AMJU Unique Microfinance Bank"
        },
        {
            "id": 638,
            "code": "090393",
            "name": "BRIDGEWAY MICROFINANCE BANK"
        },
        {
            "id": 639,
            "code": "090328",
            "name": "Eyowo MFB"
        },
        {
            "id": 640,
            "code": "090281",
            "name": "Mint-Finex MICROFINANCE BANK"
        },
        {
            "id": 659,
            "code": "070006",
            "name": "Covenant Microfinance Bank"
        },
        {
            "id": 660,
            "code": "090110",
            "name": "VFD Micro Finance Bank"
        },
        {
            "id": 661,
            "code": "090317",
            "name": "PatrickGold Microfinance Bank"
        },
        {
            "id": 728,
            "code": "090325",
            "name": "Sparkle"
        },
        {
            "id": 784,
            "code": "305",
            "name": "Paycom"
        },
        {
            "id": 811,
            "code": "070001",
            "name": "NPF MicroFinance Bank"
        },
        {
            "id": 812,
            "code": "110001",
            "name": "PayAttitude Online"
        },
        {
            "id": 813,
            "code": "100027",
            "name": "Intellifin"
        },
        {
            "id": 814,
            "code": "100032",
            "name": "Contec Global Infotech Limited (NowNow)"
        },
        {
            "id": 815,
            "code": "100031",
            "name": "FCMB Easy Account"
        },
        {
            "id": 816,
            "code": "100030",
            "name": "EcoMobile"
        },
        {
            "id": 817,
            "code": "100029",
            "name": "Innovectives Kesh"
        },
        {
            "id": 818,
            "code": "100026",
            "name": "One Finance"
        },
        {
            "id": 819,
            "code": "100025",
            "name": "Zinternet Nigera Limited"
        },
        {
            "id": 820,
            "code": "100023",
            "name": "TagPay"
        },
        {
            "id": 821,
            "code": "100021",
            "name": "Eartholeum"
        },
        {
            "id": 822,
            "code": "100020",
            "name": "MoneyBox"
        },
        {
            "id": 824,
            "code": "100019",
            "name": "Fidelity Mobile"
        },
        {
            "id": 825,
            "code": "000019",
            "name": "Enterprise Bank"
        },
        {
            "id": 826,
            "code": "060001",
            "name": "Coronation Merchant Bank"
        },
        {
            "id": 827,
            "code": "060002",
            "name": "FBNQUEST Merchant Bank"
        },
        {
            "id": 828,
            "code": "060003",
            "name": "Nova Merchant Bank"
        },
        {
            "id": 829,
            "code": "070007",
            "name": "Omoluabi savings and loans"
        },
        {
            "id": 830,
            "code": "090001",
            "name": "ASOSavings & Loans"
        },
        {
            "id": 831,
            "code": "090005",
            "name": "Trustbond Mortgage Bank"
        },
        {
            "id": 832,
            "code": "090006",
            "name": "SafeTrust "
        },
        {
            "id": 833,
            "code": "090107",
            "name": "FBN Mortgages Limited"
        },
        {
            "id": 834,
            "code": "100024",
            "name": "Imperial Homes Mortgage Bank"
        },
        {
            "id": 835,
            "code": "100028",
            "name": "AG Mortgage Bank"
        },
        {
            "id": 836,
            "code": "070009",
            "name": "Gateway Mortgage Bank"
        },
        {
            "id": 837,
            "code": "070010",
            "name": "Abbey Mortgage Bank"
        },
        {
            "id": 838,
            "code": "070011",
            "name": "Refuge Mortgage Bank"
        },
        {
            "id": 839,
            "code": "070012",
            "name": "Lagos Building Investment Company"
        },
        {
            "id": 840,
            "code": "070013",
            "name": "Platinum Mortgage Bank"
        },
        {
            "id": 841,
            "code": "070014",
            "name": "First Generation Mortgage Bank"
        },
        {
            "id": 842,
            "code": "070015",
            "name": "Brent Mortgage Bank"
        },
        {
            "id": 843,
            "code": "070016",
            "name": "Infinity Trust Mortgage Bank"
        },
        {
            "id": 844,
            "code": "090003",
            "name": "Jubilee-Life Mortgage  Bank"
        },
        {
            "id": 845,
            "code": "070017",
            "name": "Haggai Mortgage Bank Limited"
        },
        {
            "id": 846,
            "code": "090108",
            "name": "New Prudential Bank"
        },
        {
            "id": 847,
            "code": "070002",
            "name": "Fortis Microfinance Bank"
        },
        {
            "id": 848,
            "code": "070008",
            "name": "Page Financials"
        },
        {
            "id": 849,
            "code": "090004",
            "name": "Parralex Microfinance bank"
        },
        {
            "id": 850,
            "code": "090097",
            "name": "Ekondo MFB"
        },
        {
            "id": 851,
            "code": "090112",
            "name": "Seed Capital Microfinance Bank"
        },
        {
            "id": 852,
            "code": "090114",
            "name": "Empire trust MFB"
        },
        {
            "id": 853,
            "code": "090116",
            "name": "AMML MFB"
        },
        {
            "id": 854,
            "code": "090117",
            "name": "Boctrust Microfinance Bank"
        },
        {
            "id": 855,
            "code": "090118",
            "name": "IBILE Microfinance Bank"
        },
        {
            "id": 856,
            "code": "090119",
            "name": "Ohafia Microfinance Bank"
        },
        {
            "id": 857,
            "code": "090120",
            "name": "Wetland Microfinance Bank"
        },
        {
            "id": 858,
            "code": "090121",
            "name": "Hasal Microfinance Bank"
        },
        {
            "id": 859,
            "code": "090122",
            "name": "Gowans Microfinance Bank"
        },
        {
            "id": 860,
            "code": "090123",
            "name": "Verite Microfinance Bank"
        },
        {
            "id": 861,
            "code": "090124",
            "name": "Xslnce Microfinance Bank"
        },
        {
            "id": 862,
            "code": "090125",
            "name": "Regent Microfinance Bank"
        },
        {
            "id": 863,
            "code": "090126",
            "name": "Fidfund Microfinance Bank"
        },
        {
            "id": 864,
            "code": "090127",
            "name": "BC Kash Microfinance Bank"
        },
        {
            "id": 865,
            "code": "090128",
            "name": "Ndiorah Microfinance Bank"
        },
        {
            "id": 866,
            "code": "090129",
            "name": "Money Trust Microfinance Bank"
        },
        {
            "id": 867,
            "code": "090130",
            "name": "Consumer Microfinance Bank"
        },
        {
            "id": 868,
            "code": "090131",
            "name": "Allworkers Microfinance Bank"
        },
        {
            "id": 869,
            "code": "090132",
            "name": "Richway Microfinance Bank"
        },
        {
            "id": 870,
            "code": "090133",
            "name": " AL-Barakah Microfinance Bank"
        },
        {
            "id": 871,
            "code": "090134",
            "name": "Accion Microfinance Bank"
        },
        {
            "id": 872,
            "code": "090135",
            "name": "Personal Trust Microfinance Bank"
        },
        {
            "id": 873,
            "code": "090136",
            "name": "Baobab Microfinance Bank"
        },
        {
            "id": 874,
            "code": "090137",
            "name": "PecanTrust Microfinance Bank"
        },
        {
            "id": 875,
            "code": "090138",
            "name": "Royal Exchange Microfinance Bank"
        },
        {
            "id": 876,
            "code": "090139",
            "name": "Visa Microfinance Bank"
        },
        {
            "id": 877,
            "code": "090140",
            "name": "Sagamu Microfinance Bank"
        },
        {
            "id": 878,
            "code": "090141",
            "name": "Chikum Microfinance Bank"
        },
        {
            "id": 879,
            "code": "090142",
            "name": "Yes Microfinance Bank"
        },
        {
            "id": 880,
            "code": "090143",
            "name": "Apeks Microfinance Bank"
        },
        {
            "id": 881,
            "code": "090144",
            "name": "CIT Microfinance Bank"
        },
        {
            "id": 882,
            "code": "090145",
            "name": "Fullrange Microfinance Bank"
        },
        {
            "id": 883,
            "code": "090146",
            "name": "Trident Microfinance Bank"
        },
        {
            "id": 884,
            "code": "090147",
            "name": "Hackman Microfinance Bank"
        },
        {
            "id": 885,
            "code": "090148",
            "name": "Bowen Microfinance Bank"
        },
        {
            "id": 886,
            "code": "090149",
            "name": "IRL Microfinance Bank"
        },
        {
            "id": 887,
            "code": "090150",
            "name": "Virtue Microfinance Bank"
        },
        {
            "id": 888,
            "code": "090151",
            "name": "Mutual Trust Microfinance Bank"
        },
        {
            "id": 889,
            "code": "090152",
            "name": "Nagarta Microfinance Bank"
        },
        {
            "id": 890,
            "code": "090153",
            "name": "FFS Microfinance Bank"
        },
        {
            "id": 891,
            "code": "090154",
            "name": "CEMCS Microfinance Bank"
        },
        {
            "id": 892,
            "code": "090155",
            "name": "La  Fayette Microfinance Bank"
        },
        {
            "id": 893,
            "code": "090156",
            "name": "e-Barcs Microfinance Bank"
        },
        {
            "id": 894,
            "code": "090157",
            "name": "Infinity Microfinance Bank"
        },
        {
            "id": 895,
            "code": "090158",
            "name": "Futo Microfinance Bank"
        },
        {
            "id": 896,
            "code": "090159",
            "name": "Credit Afrique Microfinance Bank"
        },
        {
            "id": 897,
            "code": "090160",
            "name": "Addosser Microfinance Bank"
        },
        {
            "id": 898,
            "code": "090161",
            "name": "Okpoga Microfinance Bank"
        },
        {
            "id": 899,
            "code": "090162",
            "name": "Stanford Microfinance Bak"
        },
        {
            "id": 900,
            "code": "090164",
            "name": "First Royal Microfinance Bank"
        },
        {
            "id": 901,
            "code": "090165",
            "name": "Petra Microfinance Bank"
        },
        {
            "id": 902,
            "code": "090166",
            "name": "Eso-E Microfinance Bank"
        },
        {
            "id": 903,
            "code": "090167",
            "name": "Daylight Microfinance Bank"
        },
        {
            "id": 904,
            "code": "090168",
            "name": "Gashua Microfinance Bank"
        },