connext

Connext

npm module for Connext

Installation

npm install connext --save

Best practices:

1. Call Connext functions only from your client-side code. To ensure that you remain PCI compliant, credit card data must not directly touch your servers

2. Do not save your API key and secret into source control. Use other strategies such as a git-ignored config file or environment variables.

//connext.js
const Connext = require('connext');

const apiKey = process.env.API_KEY
const apiSecret = process.env.API_SECRET

const connext = new Connext(apiKey, apiSecret);

module.exports = connext;

Reference

All of the Connext object methods return Promises. See this article for an overview on how to use them: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises.

getKey(email, password) [to be deprecated soon for security reasons]

Inputs: (email, password)

Outputs: Promise that resolves with object { key, secret }

Retrieves your key and secret if you already have an account.

Usage:

connext.getKey(email, password).then(({ key, secret }) => {
  console.log(key, secret);
})

newToken()

Inputs: ()

Outputs: Promise that resolves with an object { ...tokenParameters }

Generates an empty token object to be filled out into a Promise. You can console.log() it to find out what the possible data fields are. You should call this on your client side and fill out the data fields there so that no credit card info touches your servers.

Usage:

connext.newToken().then(token => {
  console.log(token); // show token parameters
})

tokenize(token)

Inputs: (token)

Outputs: Promise that resolves with an object { ...updatedTokenParameters }

Sends the card info to connext servers and returns a token in a callback. The token is a redacted version of the information which is saveable on your servers without violating PCI compliancy. Like above, call only from the client side to make sure credit card info never touches your servers.

Usage:

connext.tokenize(token).then(newToken => {
  console.log(newToken);
})

chargeCard(token, amount, chargebackDestination, tokenContractAddress)

Inputs: (token, amount, chargebackDestination, tokenContractAddress)

Outputs: Promise that resolves with an object { vaultAddress }

Actually charges the card and deploys a vault contract to receive the tokens. chargebackDestination must be a valid Ethereum address that will be the "escape hatch" for tokens that are returned in the case of a charge reversal. tokenContractAddress must be a valid Ethereum address that is the ERC20 token contract for the tokens that will be sent to the vault upon settlement of the transaction. Amount must be written as payment(in dollars)x100, as a number. Eg: $30.10 becomes 3010. The tokenization and charge process are separated to facilitate recurring payments or a second attempt at a payment if the payment fails. The resolved Promise object contains the vault address.

Example usage:

connext.newToken()
  .then(token => {
    return connext.tokenize(token);
  })
  .then(newToken => {
    // add payment info here from input fields
    // ...
    return connext.chargeCard(newToken, 101, "0x1111111111111111", "0x1111111111111112");
  })
  .then(response => {
    const { vaultAddress } = response; // destructure vault address from response
    // send tokens to vault
  })
  .catch(error => {
    // handle me
  });

Error Handling

The Connext API makes use of axios for HTTP calls. Errors are returned directly from axios, so they should be handled appropriately using this guide as reference: https://github.com/mzabriskie/axios#handling-errors