oneapp-node

1APP NodeJS Library

Learn how to integrate our APIs to build a web or mobile integration to accept payments, make payment of Bills and as well custom integration for your application and businesses. On this page, we'll go over some payment services we offer to give you a quick overview of what is obtainable with 1app.

Payment Collection

If you're a business owner, here are a few ways we make it possible for you to collect payments from customers all over the world: Direct Bank Account Payments (Nigeria) - Customers can pay you directly from their bank accounts.

Tokenized Payments

This is a feature that allows you to save a customer object on your platform so your users don't have to enter their card information repeatedly.

Transfers

With 1app, you can make transfers to over 6+ African countries. This is a growing list that currently includes the US and Europe. We offer this feature via the dashboard and also via API for financial service providers, merchants, marketplaces etc.

Bill Payments with 1app:

You can aggregate bill services such as airtime and data purchases and DSTV subscriptions. You get a commission for each sale and you can view your reports on a dashboard.

---

Install

This application can be cloned directly or run the command

 $  npm i oneapp-node

Import library

 const {OneApp} = require('oneapp-node')

Instantiate the library and pass your secret key and public key

For testing purposes, Use our test API Keys and for production, use our live API KEYS. You can get your PUBLIC_KEY and SECRET_KEY from the 1APP dashboard.
Click here to access your API Keys . Toggle on test mode to get TEST API KEYS and Toggle on to live mode to get LIVE API KEYS

  const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})

List of available API methods samples

Get account balance

   const oneapp = new OneApp({secretKey:'1apptest_sk_********', publicKey:'1apptest_pb_********'})
   oneapp.getBalance()
   .then(response=> console.log(response))
   .catch(e=>console.log(e))

Send Money

  const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})

   //Expected payload for sendmoney
      oneapp.sendMoney({
          amount: string | number,
          bankcode: string,
          bankname: string,
          reference: string,
          accountno: string | number,
          acctname: string,
          narration: any,
          currency: string
      })
         .then(response=>console.log(response))
         .catch(e=>console.log(e))

   // sample code
       oneapp.sendMoney({
           amount: 10000,
           bankcode: '000013',
           bankname: 'GT BANK',
           reference: 'shudgyutg876542',
           accountno: '0245000000',
           acctname: 'Olajide Olajide',
           narration: 'Transer to client',
           currency: 'NGN'
       })
       .then(response=>console.log(response))
       .catch(e=>console.log(e))
   

   

Data Plans

   const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})

   //Expected payload for data plans
   oneapp.DataPlans(provider:string).then(response=>console.log(response)).catch(e=>console.log(e))
   
   //sample code
   const provider = 'MTN' || 'AIRTEL' || 'GLO' || '9MOBILE' //use any of these providers
   oneapp.DataPlans(provider).then(response=>console.log(response)).catch(e=>console.log(e))

Purchase Data Bundle

    const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})
   
   //Expected payload for data bundle purchase
     oneapp.purchaseData({
         datacode: string,
         network_id: string,
         phoneno: string,
         reference: string
     })
         .then(response=>console.log(response))
       .catch(e=>console.log(response))
   
   //sample code
   oneapp.purchaseData({
       datacode: '1000',
       network_id: '2',
       phoneno: '07012345678',
       reference: 'DJIEJ2MEUE2EN34'
   }).then(response=>console.log(response))

Purchase Airtime

    const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})

   //Expected payload for airtime purchase
     oneapp.purchaseAirtime({
       phoneno: string,
       network_id: string,
       reference: string,
       amount: number | string,
   }).then(response=>console.log(response))

   //sample code
   // Network ID - MTN = 2,  GLO = 1, AIRTEL = 3, 9MOBILE = 4
   oneapp.purchaseAirtime({
       phoneno: '07012345678',
       network_id: '2',
       reference: 'O4I3U8SRNYOIYT',
       amount: '200'
   }).then(response=>console.log(response))

Verify Electricity

    const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})
   
   //Expected payload to verify electricity meter
   oneapp.electricityVerifier(meterno:string|number, provider:string)
   .then(response=>console.log(response))
   .catch(e=>console.log(e))
   
   //sample code
   oneapp.electricityVerifier('015900062628','IBADAN')
       .then(response=>console.log(response))
       .catch(e=>console.log(e))

Buy Electricity

 const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})

   //Expected payload to purchase electricity unit
   oneapp.purchaseElectricity({
       meterno: string | number,
       metername: string,
       provider: string,
       amount: string | number,
       vendtype: string
   }).then(response=>console.log(response)).catch(e=>console.log(e))
   
   //sample code
   oneapp.purchaseElectricity({
       'meterno': '62320094725',
       'metername': 'BRAHIM MARY OPE',
       'provider': 'IBADAN',
       'amount': '1000',
       'vendtype': 'PREPAID'
   }).then(response=>console.log(response))

Get Cable Tv List

    const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})
   
   //Expected payload to get cable tv list
   oneapp.CableTVPlans(provider:string)
   .then(response=>console.log(response))
   .catch(e=>console.log(e))
K;
   //sample code
   const provider = 'DSTV' || 'GOTV' || 'STARTIMES' //supported Cable Tv providers
   oneapp.CableTVPlans('DSTV')
       .then(response=>console.log(response))
       .catch(e=>console.log(e))

Verify IUC

   const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})
   
   //Expected payload to get verify IUC 
   oneapp.verifyCable(provider:string, iuc:string|number)
   .then(response=>console.log(response))
   .catch(e=>console.log(e))
   
   //sample code
   const provider = 'DSTV' || 'GOTV' || 'STARTIMES'  //supported Cable Tv providers
   oneapp.verifyCable('DSTV','7028914928')
       .then(response=>console.log(response))
       .catch(e=>console.log(e))

Purchase Cable TV

  const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})

   //Expected payload to purchase cable tv
   oneapp.purchaseCableTV({
      tvno: string | number,
      tv: string,
      custname: string,
      custno: string|number,
      amount: string|number,
      reference: string
   }).then(response=>console.log(response))

   //sample code
   oneapp.purchaseCableTV({
       tvno: '7528393100',
       tv: 'GOTV', //providers listed above
       custname: 'IBRAHIM MARY OPE',
       custno: '376946518',
       amount: '100',
       reference: 'OI8UYTEFYDTYTG7'
   }).then(response=>console.log(response))

Bank List

    const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})

   oneapp.BankList().then(response=>console.log(response)).catch(e=>console.log(e))

Initialize Transaction

  const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})

   //Expected payload to initialize a transaction
   oneapp.initiateTransaction({
    amount: string | number,
    fname: string,
    lname: string,
    customer_email: string,
    phone: string,
    reference: string,
    currency: string,
    redirecturl: string
   }).then(response=>console.log(response))

   //sample code
   oneapp.initiateTransaction({
    amount: '1000',
    fname: 'John',
    lname: 'Doe',
    customer_email: '[e-mail]',
    phone: '0801234567789',
    reference: 'OI8UYTEFYDTYTG7',
    currency: 'NGN', //NGN or USD supported for now
    redirecturl: 'https://mywebsite.com'
   }).then(response=>console.log(response))

Verify Transaction

  const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})

   //Expected payload to verify transaction
   oneapp.verifyTransaction({
    reference :string
   }).then(response=>console.log(response))

   //sample code
   oneapp.verifyTransaction({
    reference: 'OI8UYTEFYDTYTG7'
   }).then(response=>console.log(response))

Transaction List

  const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})

   oneapp.TransactionList().then(response=>console.log(response))

Transaction Details

  const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})

   //Expected payload to fetch a transaction details
   oneapp.TransactionDetail({
    reference :string
   }).then(response=>console.log(response))

   //sample code
   oneapp.TransactionDetail({
    reference: 'OI8UYTEFYDTYTG7'
   }).then(response=>console.log(response))

Customers

   //NB: Pass your live SECRETKEY to fetch customers
  const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})

   oneapp.ListCustomers().then(response=>console.log(response))

Payout / Settlements

   //NB: Pass your live SECRETKEY to fetch payouts or settlemnts
  const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})

   oneapp.Payouts().then(response=>console.log(response))

Settlement Transactions

 //NB: Pass your live SECRETKEY to fetch a settlement details
  const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})

   //Expected payload to fetch a settlement details
   oneapp.SettlementDetails({
    reference :string
   }).then(response=>console.log(response))

   //sample code
   oneapp.SettlementDetails({
    reference: 'OI8UYTEFYDTYTG7'
   }).then(response=>console.log(response))

Fetch Disputes

   //NB: Pass your live SECRETKEY to fetch payouts or settlemnts
  const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})

   oneapp.FetchDisputes().then(response=>console.log(response))

Accept a Dispute

 //NB: Pass your live SECRETKEY to accept dispute
  const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})

   //Expected payload to fetch a settlement details
   oneapp.AcceptDispute({
    sesscode: string | number,
    userid: string | number,
    businessid: string | number,
    disputeid: number,
    transref: string,
    customername: string,
    customeremail: string,
    customerphone: string,
    dclaim: string,
    torefund: string,
   }).then(response=>console.log(response))

   //sample code
   oneapp.SettlementDetails({
    sesscode: '123456',
    userid: 1,
    businessid: 2,
    disputeid: 1,
    transref: 'OI8UYTEFYDTYTG7',
    customername: 'John Doe',
    customeremail: '[e-mail]',
    customerphone: '09034568931',
    dclaim: 'shoe purchase', //service offered
    torefund: 10000, //amount to refund
   }).then(response=>console.log(response))

Decline a Dispute

 //NB: Pass your live SECRETKEY to decline dispute
  const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})

   //Expected payload to fetch a settlement details
   oneapp.DeclineDispute({
    sesscode:string | number,
    userid:string | number,
    businessid:string | number,
    disputeid:string | number,
    txref:string,
    name:string,
    email:string,
    phone:string,
    claim:string,
    descres:string,
    receipt:File,
   }).then(response=>console.log(response))

   //sample code
   oneapp.SettlementDetails({
    sesscode:'12345',
    userid:'1234',
    businessid:3,
    disputeid:3,
    txref:'OI8UYTEFYDTYTG7',
    name:'John Doe',
    email:'[e-mail]',
    phone:'080XXXXXX98',
    claim:'shoe purchase', //service offered
    descres:'no error in transaction', //decline reason
    receipt:'receipt.jpeg', //evidence of decline, File Upload
   }).then(response=>console.log(response))

Create a Wallet

 //NB: Pass your live SECRETKEY to create wallet
  const oneapp = new OneApp({secretKey:'secret_key', publicKey:'public_key'})

   //Expected payload to create a wallet
   oneapp.CreateWallet({
    appToken:string,
    fname:string,
    sname:string,
    email: string,
    phoneno: string,
    auth: string,
    referby: string | null
   }).then(response=>console.log(response))

   //sample code
   oneapp.SettlementDetails({
    appToken:'O4I3U8SRNYOIYT',
    fname:'John',
    sname:'Doe',
    email: '[e-mail]',
    phoneno: '07036292257',
    auth: 'Ilove1app@1', // password must be least 6 characters long (special character,  number, letter) to authenticate your account
    referby: 'instagram' //who referred you
   }).then(response=>console.log(response))

Web link

Link to 1app full documentation with sample data: 1app Documentation