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.

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.

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.

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.

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.

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.

Fetch all bills items API

POST https://app.cashbuddy.ng/apis/apiFetchBills?network=all

To fetch bills categories send the network as query get params ?network=value e.g airtel, mtn, glo, 9mobile/etisalat, smile, spectranet, gotv, dstv, startimes, eko-electric, ibadan-electric, ikeja-electric, portharcourt-electric, enugu-electric and all.

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.

Fetch electricity bills plans {eko-electric, ibadan-electric, ikeja-electric, portharcourt-electric and enugu-electric}

POST https://app.cashbuddy.ng/apis/apiFetchBills?network=eko-electric

To fetch electricity plans send the distribution as the network, this is the list of available distribution eko-electric, ibadan-electric, ikeja-electric, portharcourt-electric and enugu-electric. biller_name will be returned at every call to identify the plan you are paying for. For electricity biller_name will carry either prepared or postpaid

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.

Fetch data plans{mtn, glo, 9mobile, airtel}

POST https://app.cashbuddy.ng/apis/apiFetchBills?network=mtn

To fetch data plans send the network e.g mtn, glo, etisalat/9mobile and airtel. biller_name will be returned at every call to identify the plan you are paying for. For data plan biller_name will carry either the name of the plan

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.

Fetch cable/tv subscription plans{dstv, gotv, startimes}

POST https://app.cashbuddy.ng/apis/apiFetchBills?network=dstv

Pay for your cable subscription 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.

Verification APIs

Bank Verification/Resolve account number API

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

Resolve an account number to fetch the account name with this endpoints its 100% free.

Headers

Name
Type
Description

Secret-Key

string

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

Request Body

Name
Type
Description

bank_code

string

The bank code to resolve.

account_no

number

Account number of the user.

email

string

The email account attributed to your secret key.

BVN Verification API

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

Supply the BVN value and get the information for the user this costs ₦20

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.

bvn

number

The BVN to resolve.

Airtime To Cash

Request for airtime to cash conversion, be sure to dial the result returned on the data's value (replace YOUR PIN with your mobile network airtime transfer pin)

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

Headers

Name
Type
Description

Secret-Key*

string

Bearer YOUR_SECRET_KEY

Request Body

Name
Type
Description

reference_id

string

j900o0PPKe93

sub_user

string

Your User's Identifier (for businesses)

phone*

string

08100000000

network*

string

mtn, airtel, glo, q9mobile

amount*

number

2000

email*

string

developer@cashbuddy.com

Airtime To Cash History

Get and filter airtime to cash transaction history

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

Query Parameters

Name
Type
Description

status

string

Either approved, denied, pending

reference_id

string

Reference ID

Headers

Name
Type
Description

Secret-Key*

string

Bearer YOUR_SECRET_KEY

Last updated

Was this helpful?