pip-services-paymentmethods-node v1.0.0

Payment methods microservice

This is payment methods microservice from Pip.Services library. It stores customer payment methods internally or in external PCI-complient service like Paypal

The microservice currently supports the following deployment options:

• Deployment platforms: Standalone Process, Seneca
• External APIs: HTTP/REST, Seneca
• Persistence: Flat Files, MongoDB

This microservice has no dependencies on other microservices.

Quick Links:

• Download Links
• Development Guide
• Configuration Guide
• Deployment Guide
• Client SDKs
  • Node.js SDK
• Communication Protocols
  • HTTP Version 1
  • Seneca Version 1
  • Lambda Version 1

Contract

Logical contract of the microservice is presented below. For physical implementation (HTTP/REST, Thrift, Seneca, Lambda, etc.), please, refer to documentation of the specific protocol.

class AddressV1 {
    public line1: string;
    public line2?: string;
    public city: string;
    public postal_code?: string;
    public postal_code?: string;
    public country_code: string; // ISO 3166-1
}

class PaymentMethodV1 implements IStringIdentifiable {
    public id: string;
    public customer_id: string;

    public create_time?: Date;
    public update_time?: Date;
    
    public type?: string;
    public number?: string;
    public expire_month?: number;
    public expire_year?: number;
    public first_name?: string;
    public last_name?: string;
    public billing_address?: AddressV1;
    public state?: string;
    public ccv?: string;

    public name?: string;
    public saved?: boolean;
    public default?: boolean;
}

class PaymentMethodTypeV1 {
    public static readonly Visa = "visa";
    public static readonly Mastermethod = "mastermethod";
    public static readonly AmericanExpress = "amex";
    public static readonly Discover = "discover";
    public static readonly Maestro = "maestro";
}

class CreditCardStateV1 {
    public static Ok: string = "ok";
    public static Expired: string = "expired";
}

interface IPaymentMethodsV1 {
    getPaymentMethods(correlationId: string, filter: FilterParams, paging: PagingParams, 
        callback: (err: any, page: DataPage<PaymentMethodV1>) => void): void;

    getPaymentMethodById(correlationId: string, method_id: string, 
        callback: (err: any, method: PaymentMethodV1) => void): void;

    createPaymentMethod(correlationId: string, method: PaymentMethodV1, 
        callback: (err: any, method: PaymentMethodV1) => void): void;

    updatePaymentMethod(correlationId: string, method: PaymentMethodV1, 
        callback: (err: any, method: PaymentMethodV1) => void): void;

    deletePaymentMethodById(correlationId: string, method_id: string,
        callback: (err: any, method: PaymentMethodV1) => void): void;
}

Download

Right now the only way to get the microservice is to check it out directly from github repository

git clone git@github.com:pip-services-ecommerce/pip-services-paymentmethods-node.git

Pip.Service team is working to implement packaging and make stable releases available for your as zip downloadable archieves.

Run

Add config.yml file to the root of the microservice folder and set configuration parameters. As the starting point you can use example configuration from config.example.yml file.

Example of microservice configuration

- descriptor: "pip-services-container:container-info:default:default:1.0"
  name: "pip-services-paymentmethods"
  description: "PaymentMethods microservice"

- descriptor: "pip-services-commons:logger:console:default:1.0"
  level: "trace"

- descriptor: "pip-services-paymentmethods:persistence:file:default:1.0"
  path: "./data/payment_methods.json"

- descriptor: "pip-services-paymentmethods:controller:default:default:1.0"

- descriptor: "pip-services-paymentmethods:service:http:default:1.0"
  connection:
    protocol: "http"
    host: "0.0.0.0"
    port: 8080

For more information on the microservice configuration see Configuration Guide.

Start the microservice using the command:

node run

Use

The easiest way to work with the microservice is to use client SDK. The complete list of available client SDKs for different languages is listed in the Quick Links

If you use Node.js then you should add dependency to the client SDK into package.json file of your project

{
    ...
    "dependencies": {
        ....
        "pip-clients-paymentmethods-node": "^1.1.*",
        ...
    }
}

Inside your code get the reference to the client SDK

var sdk = new require('pip-clients-paymentmethods-node');

Define client configuration parameters that match configuration of the microservice external API

// Client configuration
var config = {
    connection: {
        protocol: 'http',
        host: 'localhost', 
        port: 8080
    }
};

Instantiate the client and open connection to the microservice

// Create the client instance
var client = sdk.PaymentMethodsHttpClientV1(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

// Create a new payment_method
var payment_method = {
    id: '2',
    customer_id: '1',
    name: 'Visa *2780',
    type: PaymentMethodTypeV1.CreditCard,
    card: {
        brand: 'VISA',
        ccv: '921',
        expire_month: 4,
        expire_year: 2024,
        first_name: 'Steve',
        last_name: 'Jobs',
        number: '4032037578262780',
        state: CreditCardStateV1.Ok
    }
};

client.createPaymentMethod(
    null,
    payment_method,
    function (err, payment_method) {
        ...
    }
);

// Get the list of payment_methods on 'time management' topic
client.getPaymentMethods(
    null,
    {
        customer_id: '1'
    },
    {
        total: true,
        skip: 0,
        take: 10
    },
    function(err, page) {
    ...    
    }
);

Acknowledgements

This microservice was created and currently maintained by Denis Kuznetsov.