bc-omnicapital-sdk/README.md

BetterCommerce's OmniCapital NodeJS SDK enables BC client applications to integrate with OmniCapital merchant API system. It publishes an interface to interact with [OmniCapital API](https://api.omniporttest.ocrf.co.uk/swagger/ui/index#) endpoints.

# BetterCommerce OmniCapital NodeJS SDK

BetterCommerce's OmniCapital NodeJS SDK enables BC client applications to integrate with OmniCapital merchant API system. It publishes an interface to interact with [OmniCapital API](https://api.omniporttest.ocrf.co.uk/swagger/ui/index#) endpoints.

Use below command for package installation:

```
npm install @better-commerce/bc-omnicapital-sdk
```

## Architecture Diagram

![Architecture Diagram](/assets/app-architecture.png)

## SDK Initialization

**Use following snippet to initialize the SDK:**

### Server-to-server Authentication

Uses the access secret or OAuth for server-to-server communication.

```
OmniCapitalEnvironment.init("<apiKey>", "<installationId>", "<userName>", "<password>", [useSandbox: boolean]);
```

## Usage Example

### Request Payment

```
const data = {
    Identification: {
        api_key: "",
        RetailerUniqueRef: "10507-4252947",
        InstallationID: "",
        FirstName: "Amit",
        LastName: "Kumar",
        HouseNumber: "111",
        HouseName: "Conduit House",
        Town: "London",
        Postcode: "W4 4HH"
    },
    Goods: [
        {
            Description: "G242335E(1)",
            Price: "769.00"
        }
    ],
    Finance: {
        Code: "ONIB12-14.90-5697",
        Deposit: 250
    }
};

const result = await new Transaction().request(data);
```