📖 Documentation

See our in-depth documentation to learn how you can use the trustshare REST client to integrate with our platform.

🔧 Installation

To use the REST client on your back-end service, you can easily install our package from NPM:

# via npm:
npm install --save @trustshare/rest

# via yarn
yarn add @trustshare/rest

🚀 Quick start

To use our client, you will need to sign up or log in to the dashboard to acquire a private API key used to instantiate the REST client. You can use our handy getting started guide that describes setting up your organisation on the dashboard.

Once you have access to your organisation's private key, you can easily instantiate and start using the REST client. With all this out of the way, you can use the newly set up client to achieve tasks needed for integration such as creating a payment intent.

import rest from '@trustshare/rest';

const trustshare = rest('<YOUR_PRIVATE_API_KEY>');

const result = await trustshare.v1.createPaymentIntent({ ... });