# pip-clients-payments-node

> Node.js client sdk for service-payments microservice

Latest version **1.0.0** (published 2023-04-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install pip-clients-payments-node
pnpm add pip-clients-payments-node
yarn add pip-clients-payments-node
bun add pip-clients-payments-node
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-04-26 |
| First published | 2023-04-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=10.0.0 |
| Dependencies | 4 |
| Unpacked size | 155.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Conceptual Vision Consulting LLC |
| Maintainers | pipdeveloper |
| Keywords | pip.services, payments, microservice, client, sdk |

## Links

- npm: https://www.npmjs.com/package/pip-clients-payments-node
- Repository: https://github.com/pip-services-ecommerce/pip-clients-payments-node
- Homepage: https://github.com/pip-services-ecommerce/pip-clients-payments-node#readme
- Issues: https://github.com/pip-services-ecommerce/pip-clients-payments-node/issues
- npm.io page: https://npm.io/package/pip-clients-payments-node

## Dependencies (4)

- [pip-services3-rpc-node](https://npm.io/package/pip-services3-rpc-node.md) ^3.3.1
- [pip-services-payments-node](https://npm.io/package/pip-services-payments-node.md) ^1.0.0
- [pip-services3-commons-node](https://npm.io/package/pip-services3-commons-node.md) ^3.0.0
- [pip-services3-components-node](https://npm.io/package/pip-services3-components-node.md) ^3.0.0

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2023-04-26

## README

# <img src="https://github.com/pip-services/pip-services/raw/master/design/Logo.png" alt="Pip.Services Logo" style="max-width:30%"> <br/> Payments Microservice Client SDK for Node.js

This is a Node.js client SDK for [pip-services-payments-node](https://github.com/pip-services/pip-services-payments-node) microservice.
It provides an easy to use abstraction over communication protocols:

* Direct client
* HTTP client
* Seneca client (see http://www.senecajs.org)

<a name="links"></a> Quick Links:

* [Development Guide](doc/Development.md)
* [API Version 1](doc/NodeClientApiV1.md)

## Install

Add dependency to the client SDK into **package.json** file of your project
```javascript
{
    ...
    "dependencies": {
        ....
        "pip-clients-payments-node": "^1.0.*",
        ...
    }
}
```

Then install the dependency using **npm** tool
```bash
# Install new dependencies
npm install

# Update already installed dependencies
npm update
```

## Use

Inside your code get the reference to the client SDK
```javascript
var sdk = new require('pip-clients-payments-node');
```

Define client configuration parameters that match configuration of the microservice external API
```javascript
// Client configuration
var config = {
    connection: {
        protocol: 'http',
        host: 'localhost', 
        port: 8080
    }
};
```

Instantiate the client and open connection to the microservice
```javascript
// Create the client instance
var client = sdk.PaymentsHttpClientV1(config);

// Connect to the microservice
client.open(null, function(err) {
    if (err) {
        console.error('Connection to the microservice failed');
        console.error(err);
        return;
    }
    
    // Work with the microservice
    ...
});
```

Now the client is ready to perform operations
```javascript
// Make payment
var 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
        }
    ]
};

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,
    function(err, payment) => {
        if (payment.status == PaymentStatusV1.Confirmed) {
        // ... payment processed successfully
        }
    }
);
```

```javascript
// Refund confirmed payment
client.refundPayment(
    null,
    'stripe',
    {   // account
        access_key: STRIPE_ACCESS_KEY
    },
    payment.id,
    function(err, payment) {
        if (payment.status == PaymentStatusV1.Canceled) {
        // ... payment refunded successfully
        }
        ...    
});
```    

## Acknowledgements

This client SDK was created and currently maintained by *Sergey Seroukhov*.

---
_Source: https://npm.io/package/pip-clients-payments-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._