spike-api

SPIKE REST API for Node.js

An asynchronous client library for the SPIKE REST API.

var SpikeAPI = require('spike-api').SpikeAPI;
 
var client = new SpikeAPI({
  secretKey: 'YOUR_SECRET_KEY'
});
 
client.getChargeList(function(err, result) {
  if (!err) {
    console.log(result);
  }
});

Installation

npm install spike-api

Post a new Charge

POST https://api.spike.cc/v1/charges

var Product = require('spike-api').Product;
 
// new charge data
var newCharge = {
  currency: 'JPY'; // 'JPY' or 'USD'
  amount: 1080,
  card: 'CARD_TOKEN', // Token that has been acquired in SPIKE Checkout.
  products: 
    new Product({
      id: '0001',
      title: 'product A',
      description: 'desc',
      price: 1000,
      currency: 'JPY',
      count: 1,
      stock: 100
    })
  ]
};
 
// POST https://api.spike.cc/v1/charges
client.postCharge(newCharge, function(err, result) {
  if (!err) {
    console.log(result);
  }
});

result example:

{
  "id": "20140609-064331-onjmfi1z5q",
  "object": "charge",
  "created": 1402375175,
  "livemode": false,
  "paid": true,
  "captured": true,
  "amount": 1080,
  "currency": "JPY",
  "refunded": false,
  "amount_refunded": null,
  "refunds": []
}

Get a Charge info

GET https://api.spike.cc/v1/charges/{CHARGE_ID}

var chargeID = '20140609-064331-onjmfi1z5q';
 
// GET https://api.spike.cc/v1/charges/{CHARGE_ID}
client.getCharge(chargeID, function(err, result) {
  if (!err) {
    console.log(result);
  }
});

result example:

{
  "id": "20140609-064331-onjmfi1z5q",
  "object": "charge",
  "created": 1402375175,
  "livemode": false,
  "paid": true,
  "captured": true,
  "amount": 1900,
  "currency": "JPY",
  "refunded": false,
  "amount_refunded": null,
  "refunds": []
}

Refund a Charge

POST https://api.spike.cc/v1/charges/{CHARGE_ID}/refund

var chargeID = '20140609-064331-onjmfi1z5q';
 
// POST https://api.spike.cc/v1/charges/{CHARGE_ID}/refund
client.refundCharge(chargeID, function(err, result) {
  if (!err) {
    console.log(result);
  }
});

result example:

{
  "id": "20140609-064331-onjmfi1z5q",
  "object": "charge",
  "livemode": false,
  "created": 1400220648,
  "paid": false,
  "captured": true,
  "amount": 100,
  "currency": "USD",
  "refunded": true,
  "amount_refunded": 100,
  "refunds": [
    {
      "object": "refund",
      "created": 1400220648,
      "amount": 100,
      "currency": "USD"
    }
  ]
}

Get Charge List

GET https://api.spike.cc/v1/charges

// Acquisition number of list
var limit = 2;
 
// GET https://api.spike.cc/v1/charges
client.getChargeList(limit, function(err, result) {
  if (!err) {
    console.log(result);
  }
});

result example:

{
  "object": "list",
  "url": "/v1/charges",
  "has_more": false,
  "data": [
    {
      "id": "20140609-064331-onjmfi1z5q",
      "object": "charge",
      "created": 1402375175,
      "livemode": false,
      "paid": true,
      "captured": true,
      "amount": 1900,
      "currency": "JPY",
      "refunded": false,
      "amount_refunded": null,
      "refunds": []
    },
    {
      "id": "20140609-064332-xijafi4p6x",
      "object": "charge",
      "created": 1402375275,
      "livemode": false,
      "paid": true,
      "captured": true,
      "amount": 1080,
      "currency": "JPY",
      "refunded": false,
      "amount_refunded": null,
      "refunds": []
    }
  ]
}

Post Token

POST https://api.spike.cc/v1/tokens

var newCard = {
  'card[number]': 4444333322221111,
  'card[exp_month]': 1,
  'card[exp_year]': 2020,
  'card[cvc]': 111,
  'card[name]': 'KATSUAKI SATO',
  'currency': 'JPY'
};
 
// POST https://api.spike.cc/v1/charges
client.postToken(cardData, function(err, result) {
  if (!err) {
    console.log(result);
  }
});

result example:

{ 
  "id": "tok_xEI0RJWqwC3HqO0TQOxoGRgx",
  "object": "token",
  "created": 1435069120,
  "livemode": false,
  "type": "card",
  "source": 
  { 
    "object": "card",
    "last4": "1111",
    "brand": "Visa",
    "exp_month": 1,
    "exp_year": 2020,
    "name": "KATSUAKI SATO" 
  } 
}

Get Token

GET https://api.spike.cc/v1/tokens/{TOKEN_ID}

// POST https://api.spike.cc/v1/charges
client.getToken(cardToken, function(err, result) {
  if (!err) {
    console.log(result);
  }
});

result example:

{ 
  "id": "tok_xEI0RJWqwC3HqO0TQOxoGRgx",
  "object": "token",
  "created": 1435069120,
  "livemode": false,
  "type": "card",
  "source": 
  { 
    "object": "card",
    "last4": "1111",
    "brand": "Visa",
    "exp_month": 1,
    "exp_year": 2020,
    "name": "KATSUAKI SATO" 
  } 
}

SPIKE API Reference

https://spike.cc/dashboard/developer/docs/api_reference

Contributors

• Yuhta Nakajima [e-mail]
• takayukii [e-mail]

License

MIT License. ©2015 Yuhta Nakajima