bayonet-node

Bayonet

Bayonet enables companies to feed and consult a global database about online consumers’ reputation, based on historic payments. Start making smarter business decisions today.

Introduction

Bayonet’s API is organized around REST and exposes endpoints for HTTP requests. It is designed to have predictable, resource-oriented URLs and uses standard HTTP response codes to indicate the outcome of operations. Request and response payloads are formatted as JSON.

About the service

Bayonet provides an Ecosystem of Trust and Protection where companies can collaborate with each other to combat online fraud. We provide a secure platform to share and consult data to understand when a consumer is related to fraudulent activity or has a fraud-free record. Different technologies that run algorithms to link parameters seen in different transactions, fed by companies connected to the ecosystem are employed in order to build consumer profiles. By consulting Bayonet’s API, a response with data provided by companies themselves is available in real-time for your risk assesment process to analyze it and take better decisions.

Bayonet's API details

To know more about Bayonet's API and its domain and technical details, please refer to the Bayonet API documentation.

Getting started

To use this SDK, please make sure:

• You have NodeJS installed on your system.

• You have an API KEY (sandbox and/or live) provided by Bayonet's team.

• Install the 'bayonet-node' module on your system

  npm install bayonet-node

• Add dependency 'bayonet-node' in your package.json file.

• Require 'bayonet-node' in your file

  var bayonet = require('bayonet-node');

• Create config options, with parameters (api_key).

  bayonet.configure({
    'api_key': 'your_api_key'
  });

• You can use environment vars too.

  export BAYONET_API_KEY=your_api_key

Usage

Once you have Bayonet's SDK configured, you can call the three APIs with the following syntax:

• Consulting API

  bayonet.api.consulting({
      "channel": "mpos",
      "email": "[e-mail]",
      "consumer_name": "Example name",
      "cardholder_name": "Example name",
      "payment_method": "card",
      "card_number": 4111111111111111,
      "transaction_amount": 999,
      "currency_code": "MXN",
      "transaction_time": 1476012879,
      "coupon": false,
      "payment_gateway": "stripe",
      "shipping_address" : {
          "address_line_1" : "example line 1",
          "address_line_2" : "example line 2",
          "city" : "Mexico City",
          "state" : "Mexico DF",
          "country" : "MEX",
          "zip_code" : "64000"
      },
      ...
  });

• Feedback API

  bayonet.api.feedback({
      "transaction_status": "success",
      "transaction_id": "uhffytd65rds56yt",
      ...
  });

• Feedback-historical API

  bayonet.api.feedback_historical({
      "channel": "mpos",
      "type": "transaction",
      "email": "[e-mail]",
      "consumer_name": "Example name",
      "payment_method": "card",
      "card_number": 4111111111111111,
      "transaction_amount": 999,
      "currency_code": "MXN",
      "transaction_time": 1423823404,
      "transaction_status": "bank_decline",
      "transaction_id": "uhffytd65rds56yt",
      "coupon": false,
      "payment_gateway": "stripe",
      "device_fingerprint": "AF567GHGJJJ87JH",
      "bank_auth_code": "5353888",
      "telephone": "0000000000",
      "expedited_shipping": false,
      "bank_decline_reason": "stolen_card",
      "shipping_address": {
          "address_line_1": "example line 1",
          "address_line_2": "example line 2",
          "city": "Mexico City",
          "state": "Mexico DF",
          "country": "MEX",
          "zip_code": "64000"
      }
      ...
  });

Success and error handling

Bayonet's SDK supports Promises for success and error handling

bayonet.api.consulting({
    ...
})
.then(function (parsedBody) {
    console.log('Success', parsedBody);
})
.catch(function (error) {
    console.log('Error', error);
});

For a full list of error codes and their messages, please refer to the Bayonet API documentation.

Demo

You can run a demo application with this command:

cd demo && node index.js

Testing

You can run the test suite with the following command:

grunt