bm-vslice-layered-client-payments-node
v1.0.6
Published
This is a Node.js client SDK for [service-payments-node](https://bitbucket.org/entinco/bm-verticalslice-ecommerce) microservice. It provides an easy to use abstraction over communication protocols:
Downloads
2
Readme
Payments Microservice Client SDK for Node.js
This is a Node.js client SDK for service-payments-node microservice. It provides an easy to use abstraction over communication protocols:
- Direct client
- HTTP client
- Seneca client (see http://www.senecajs.org)
Quick Links:
Install
Add dependency to the client SDK into package.json file of your project
{
...
"dependencies": {
....
"bm-vslice-layered-client-payments-node": "^1.0.*",
...
}
}
Then install the dependency using npm tool
# Install new dependencies
npm install
# Update already installed dependencies
npm update
Use
Inside your code get the reference to the client SDK
let sdk = new require('client-payments-node');
Define client configuration parameters that match configuration of the microservice external API
// Client configuration
let config = {
connection: {
protocol: 'http',
host: 'localhost',
port: 8080
}
};
Instantiate the client and open connection to the microservice
// Create the client instance
let client = sdk.PaymentsHttpClientV1(config);
// Connect to the microservice
await client.open(null);
// Work with the microservice
...
Now the client is ready to perform operations
// Make payment
let order = {
id: '1',
currency_code: 'USD',
total: 100,
items: [
{
name: 'product 1',
description: 'description for product 1',
amount: 80,
amount_currency: 'USD',
category: 'category 1',
quantity: 1
},
{
name: 'product 2',
description: 'description for product 2',
amount: 20,
amount_currency: 'USD',
category: 'category 2',
quantity: 1
}
]
};
let payment = await await client.makePayment(
null,
'stripe',
{ // account
access_key: STRIPE_ACCESS_KEY
},
{ // buyer
id: '2',
name: 'Steve Jobs',
},
order,
{ // payment method
id: PAYMENT_METHOD_ID,
type: 'card'
},
order.total,
order.currency_code
);
if (payment.status == PaymentStatusV1.Confirmed) {
// ... payment processed successfully
}
// Refund confirmed payment
payment = awiat client.refundPayment(
null,
'stripe',
{ // account
access_key: STRIPE_ACCESS_KEY
},
payment.id
);
if (payment.status == PaymentStatusV1.Canceled) {
// ... payment refunded successfully
}
Contacts
This repository was created by and is currently maintained by Dmitriy Krayniy and Denis Kuznetsov.