gpayments

Simple 4Geeks Payments API Client for NodeJS.

Installation

$ npm install gpayments

Usage

const gpayments = require('gpayments')

const gpApi = gpayments({
  clientId: '4geeks-payment-client-id',
  clientSecret: '4geeks-payment-client-secret'
})

gpApi.plans.create({
  id_name: 'plan-1',
  name: 'Test Plan',
  amount: 300000,
  currency: 'crc',
  trial_period_days: 0,
  interval: 'month',
  interval_count: 1,
  credit_card_description: 'Test Credit Card'
}).then((plan) => {
  console.log(plan)
}).catch((error) => {
  console.log('error', error.response)
})

// or with async/await

const plan = await gpApi.plans.create({
  id_name: 'plan-1',
  name: 'Test Plan',
  amount: 300000,
  currency: 'crc',
  trial_period_days: 0,
  interval: 'month',
  interval_count: 1,
  credit_card_description: 'Test Credit Card'
})

API

You will need your 4Geeks Payment Client ID and a Client Secret in order to use this library.

For additional information on all supported parameters of each method you can visit the official 4Geeks Payment API Documentation.

gpayments(options)

Create a new instance of gpayment api by passing the required clientId and clientSecret properties.

const api = gpayments({
  clientId: '4geeks-payment-client-id',
  clientSecret: '4geeks-payment-client-secret'
})

You can also set the GPAYMENTS_CLIENT_ID and GPAYMENTS_SECRET_ID environment variables instead of passing clientId and clientSecret properties directly.

For example, lets say somewhere in your app you have:

const api = gpayments()

You can startup your node application like this:

GPAYMENTS_CLIENT_ID=abc123 GPAYMENTS_SECRET_ID=123abcsecret node app.js

api.me.fetch()

Fetch my account information.

const account = await api.me.fetch()

console.log(account)

api.me.update(data)

Update my account information.

const account = await api.me.update({ bank_name: 'Bac', test: false })

console.log(account)

api.customers.fetch([key])

Fetch customers. You can also pass a customer key to fetch an specific customer.

const customers = await api.customers.fetch()

console.log(customers)

Or to fetch a single customer.

const customer = await api.customers.fetch('GfGsOKTZVlTKyn7khcihXYuEUx0nBxb')

console.log(customer)

api.customers.create(data)

Create a new customer.

const customer = await api.customers.create({
  name: 'Bruce Banner',
  email: '[email protected]',
  currency: 'usd',
  credit_card_number: 4242424242424242,
  credit_card_security_code_number: 123,
  exp_month: 12,
  exp_year: 2035
})

console.log(customer)

api.customers.update(key, data)

Update a customer.

const data = { email: '[email protected]' }
const customer = await api.customers.update('GfGsOKTZVlTKyn7khcihXYuEUx0nBxb', data)

console.log(customer)

api.customers.remove(key)

Delete a customer.

await api.customers.remove('GfGsOKTZVlTKyn7khcihXYuEUx0nBxb')

api.plans.fetch([key])

Fetch all plans. You can also pass a plan key to fetch an specific plan.

const plans = await api.plans.fetch()

console.log(plans)

Or to fetch a single plan.

const plan = await api.plans.fetch('ftmDCyPmun7QiKah5PrP2f')

console.log(plan)

api.plans.create(data)

Create a new plan.

const plan = await api.plans.create({
  id_name: 'plan-1',
  name: 'Test Plan',
  amount: 300000,
  currency: 'crc',
  trial_period_days: 0,
  interval: 'month',
  interval_count: 1,
  credit_card_description: 'Test Credit Card'
})

console.log(plan)

api.plans.remove(key)

Delete a plan.

await api.plans.remove('ftmDCyPmun7QiKah5PrP2f')

api.subscriptions.fetch([id])

Fetch all subscriptions. You can also pass a subscription id to fetch an specific subscription.

const subscriptions = await api.subscriptions.fetch()

console.log(subscriptions)

Or to fetch a single subscription.

const subscription = await api.subscriptions.fetch('BtZ3TxvsEvFh2x')

console.log(subscription)

api.subscriptions.subscribe(data)

Create a subscription.

await api.subscriptions.subscribe({
  plan_id_name: 'plan-1',
  customer_key: 'GfGsOKTZVlTKyn7khcihXYuEUx0nBxb',
})

api.subscriptions.unsubscribe(id)

Delete a subscription.

await api.subscriptions.unsubscribe('sub_B6Vje4CBVugWea')

api.charges.create(data)

Create a new charge.

await api.charges.create({
  amount: 90.32,
  customer_key: 'GfGsOKTZVlTKyn7khcihXYuEUx0nBxb',
  description: 'Plan 1 service charge',
  entity_description: 'Plan 1',
  currency: 'usd',
})

You can also just simple charge a credit card by omitting a customer_key and adding just the credit card information:

// Simple charge the credit card provided.
await api.charges.create({
  amount: 90.32,
  description: 'Plan 1 service charge',
  entity_description: 'Plan 1',
  currency: 'usd',
  credit_card_number: 4242424242424242,
  credit_card_security_code_number: 123,
  exp_month: 11,
  exp_year: 2020
})

api.charges.logs([id])

List all charges logs. You can also pass a charge id to fetch an specific charge log.

const logs = await api.charges.logs()

console.log(logs)

Or to fetch a single charge log.

const log = await api.charges.logs('1BTvroCqnAM123fqhvZw4dlkHk')

console.log(log)

Run tests

$ npm install
$ npm run test

License

Under The MIT License