Koverly Inc

- Let's get started! This section provides the basic steps necessary for gaining secure access to the Koverly API and creating a search key so that you can make conditional selections of objects based on descriptions and simplify your code.

Getting Started

Koverly’s B2B Financing solution allows you to provide flexible payment options within your existing checkout flow with credit that is underwritten and managed by Koverly.

Businesses using Koverly’s B2B Financing solution will receive payment within 24 hours of checkout. Koverly assumes all credit risk - underwriting clients, conducting approvals and managing payment collections.

Depending on your integration needs, Koverly’s B2B Financing solution can be fully embedded into your proprietary checkout, or implemented with lighter integrations.

Multiple integration options allow you to offer the best user experience for your platform:

| Integration Option | Description |
| --- | --- |
| **API with Redirect to Koverly** | Use the API to populate existing connections between companies, customers and users in Koverly for a clean and easy checkout experience on the Koverly platform. |
| **Embedded UI** | Embed Koverly’s finacing onboarding flow and/or Koverly's checkout widget into your platform for a seamless, branded payment experience without leaving your website. |
| **API only** | Completely customize the payment experience for your users by fully embedding Koverly’s APIs beneath your own UI. |

### API References

The following Koverly APIs are necessary to implement our B2B Financing solution:

- Company
- User
- Vendor
- Bill
- Embedded Finance

B2B Financing

Koverly’s B2B checkout solution allows customers to pay via ACH/bank transfer or credit card. Payments can be made in USD or foreign currency with real-time FX conversion rates built into checkout flow.

Businesses in the United States may also apply for KoverlyPay financing for the option to spread payments over time.

There are multiple integration options at every level:

| Integration Option | Description |
| --- | --- |
| Low code | Create and link a button on your website to an online payment page branded to your business by simply embedding an HTML tag on your website. |
| API with Redirect to Koverly | Use the API to populate existing connections between companies, customers and users in Koverly for a clean and easy checkout experience on the Koverly platform. |
| Embedded UI | Embed Koverly’s checkout widget into your platform for a seamless, branded payment experience without leaving your website. |
| API only | Completely customize the payment experience for your users by fully embedding Koverly’s APIs beneath your own UI. Please note that to offer B2B Financing (ie. KoverlyPay) using only API, requires a B2B Financing partnership. |

### API References

The following Koverly APIs are necessary to implement our B2B Checkout solution:

- Company
- Vendors
- Customer
- Invoice
- Bill
- Method
- Users
- Payments
- Webhooks
    

These Koverly APIs are optional for B2B Checkout implementation:

- FX
- Embedded Finance

B2B Checkout

API References

Company object is used to create an operating business entity in Koverly system. Same company can play a number of roles in the monetary exchange supported by the platform. It could be the payer, payee, service provider or a partner.

| **Property** | **Description** | **Type** |
| --- | --- | --- |
| id | Unique identifier | String |
| name | name | String |
| legalName | Legal name | String |
| address | Address | Address Object |
| signupLink | Signup link that can be used to initiate sign up for this company | String |
| ein | Legal/Tax id | String |

The address object within the Company object su structured as follows.

| **Property** | **Description** | **Type** |
| --- | --- | --- |
| address1 |  | String |
| address2 |  | String |
| town |  | String |
| ctrySubDivision | In US its a State code | String |
| postalCode | Postal code | String |
| country | 2-latter ISO country code | String |

Company

Vendors are companies that are setup to get remittances and fund transfers.

To setup a vendor use Company API to create a company and then add this company as a vendor to another. Companies can be vendors and customers in the same time.

Vendors

Customers are companies that are setup to get bills and statements to be paid.

To setup a customer use Company API to create a company and then add this company as a customers to another. Companies can be vendors and customers in the same time.

| **Property** | **Description** | **Required** |
| --- | --- | --- |
| firstName | Last name | Y |
| lastName | First name | Y |
| email | email | Y |
| role | ADMIN / CONTRIBUTOR | Y |
| isActive | true/false | false |
| isBlocked |

Users

Customers are companies that are setup to get statements and invoices

To setup a customer use Company API to create a company and then add this company as a customer to another.

Companies can be vendors and customers in the same time.

Customers

## Invoice

Invoice is request for payment presented between the company and its customer. The following fields are part of invoice object

| **Property** | **Description** | **Required** |
| --- | --- | --- |
| invoiceId | Invoice id, Retrned with created invoice |  |
| invoiceNumber | Invoice reference number. | Y |
| createdTime | Recorded as creation time for this invoice | N |
| dueDate | Due date of the invoice | Y |
| payerId | Id of the customer for which this invoice is targeted | Y |
| payeeId | Id of the company that presents the invoice | Y |
| amount | Amount of this invoice in designated currency | Y |
| balance | Remaining balance of this invoice in designated currency | Y |
| currency | Currency of this invoice | Y |
| note | Note attached to the invoice to be passed to the reciver | N |
| memo | Memo for check on this invoice | N |
| invoiceState | One of legal invoice states | N |
| paidTime | Time when invoice was paid. |  |

Invoice

Wallets

Bill

Method

Customers are companies that are setup to get bills and statements to be paid.

To setup a customer use Company API to create a company and then add this company as a customers to another. Companies can be vendors and customers in the same time.

Payments

### Overview

Web Hooks are used to report events to a web hook subscriber. In order to subscribe to web hook you first need to create a web hook object. The obect is a simple JSON object that contains 2 properties.

``` json
{
    "object": "payment",
    "callbackUrl": "https://www.my.com/a.b.c",
    "callbackPayload" : {any json object that will be relayed back to you}
    "event" : "STATUS_CHANGED"
}

 ```

\*Currently only payment object events are supported.

## Endpoint

Only https valid public internet endpoints, protected by a valid certificate are supported. The endpoint will need to process HTTP POST method and consume payload as well as Koverly-Token authentication header.

```
POST //// HTTP/1.1
.....
.....
Content-type: application:json
Koverly-Token: 823ue89ud289hde9w823d9jh928ed239udh982hdu9h2d98y23ehu92eh98dh239udh29983289838938383==
{
  "success": true,
  "statusCode": 0,
  "webhook": {
     "id": "id....",
     "callbackPayload": {}
  },
  "payment": {
    "paymentId": "3dca6f35-162b-4af9-92e9-c16c4c182fc6",
    "paymentNumber": "97898755",
    "invoices": [
      {
        "billId": "1fc74da3-2b66-45dd-b408-0cf0caf4752e",
        "currency": "USD",
        "dueAmount": 0,
        "paymentAmount": 12
      },
      {
        "billId": "ab85cd73-fd72-4730-88a5-fd0b06cbbba9",
        "currency": "USD",
        "dueAmount": 0,
        "paymentAmount": 12
      }
    ],
    "paymentMethodId": "123123123123123",
    "fundingMethodId": "123123123123123",
    "paymentType": "ACH/ACH",
    "payerId": "740cb157-3cab-467c-8223-ec4810dd3e09",
    "payeeId": "549d6fb1-48c2-4ca4-9c38-a600480f6335",
    "payerCurrency": "USD",
    "payeeCurrency": "USD",
    "payeeCurrencyRate": 1,
    "scheduleTime": "2023-05-29T23:11:01.702Z",
    "sentTime": null,
    "paymentAmount": 25,
    "paymentFeePercentage": 0,
    "payeeFeePercentage": 0,
    "paymentFee": 0,
    "payeeFee": 0,
    "payeeAmount": 0,
    "payeeCurrencyAmount": 0,
    "payerAmount": 0,
    "status": "scheduled",
    "transactionStatus": null,
    "paymentTransactionStatus": null
  }
}

 ```

#### Koverly-Token

Koverly-Token authentication header is a calculated as follows

``` javascript
const token = B64(HMAC256(weebhookId, 'api-secret'));
token == Koverly-Token header value 

 ```

Webhooks

Landing API is a collection of calls that support management, reservation and allocation of KoverylPay loans from Koverly platform.

### Credit Application

In order to initiate credit process Koverly Pay application needs to be filled out and submitted. The following information is needed in order to initialize cresit application with API. Application can also be initialize via embedded widget as well.

``` json
{
  "industry": {
    "code": "SIC Code",
    "name": "SIC Code description"
  },
  "address": {
    "address1": "address line 1",
    "address2": "address line 2",
    "postalCode": "postal code",
    "ctrySubDivision": "In US mus contain valid state code [A-Z]{2}",
    "town": "Town or city name",
    "country": "Must contain 2 character code for country",
    "phone": "phone number",
    "email": "valid email"
  },
  "leadership": {
    "firstName": "First name",
    "lastName": "LastName",
    "legalId": "In US should be a valid SSN",
    "passportNumber": "Passport information",
    "dateOfPassportExpiry": "Date passport expires",
    "address": {
      "address1": "Address line 1",
      "address2": "",
      "postalCode": "postal code",
      "ctrySubDivision": "In US is a valid state",
      "town": "Town",
      "country": "Must contain 2 character code for country",
      "phone": "phone"
    }
  },
  "otherOwners": "yes",
  "ownership": [
    {
      "firstName": "",
      "lastName": "",
      "dob": "valid date of birth mm/DD/yyyy",
      "legalId": "262-90-2126",
      "address": {
        "address1": "",
        "postalCode": "",
        "ctrySubDivision": "",
        "town": "",
        "country": "",
        "phone": ""
      }
    }
  ],
  "financial": {
    "revenue": {
      "amount": "between_1000000_and_2000000"
    }
  },
  "type": "Limited Liability Company (LLC)",
  "legalId": "In US must have valid EIN",
  "governmentIssuedCompanyId": "In non US",
  "legalName": "Liga company name",
  "web": "web presence URL"
}

 ```

#### SIC Codes

[SIC Codesx](https://www.sec.gov/corpfin/division-of-corporation-finance-standard-industrial-classification-sic-code-list)

#### Revenue Ranges

| **Descitpion** | **Range** |
| --- | --- |
| Under $500,000 per year | under_500000 |
| $500,000 - $1,000,000 per year | between_500000_and_1000000 |
| $1,000,000 - $2,000,000 per year | between_1000000_and_2000000 |
| $1,000,000 - $5,000,000 per year | between_1000000_and_5000000 |
| Over $5,000,000 per year | more_5000000 |

Company Types

| **Types** |
| --- |
| Sole Proprietorships |
| Partnerships |
| S Corporations |
| Limited Liability Company (LLC) |

## Status

The status endpoint returns information about credit line, including activation, balance and outstanding amounts.

## Plan

The Plan endpoint returns information about credit plan that is assigned to the caller.

``` json
{
    "plan": {
        "displayName": "New plan with description 2",
        "description": "* test\nLorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen",
        "creditDelayEnabled": true,
        "creditDelayValue": 4,
        "creditOffers": [
            {
                "creditOfferId": "25431698",
                "name": "More offer 8",
                "description": "More offer 8",
                "installmentNumber": 34,
                "installmentInterval": 54,
                "installmentPercentage": 45
            },
            {
                "creditOfferId": "90090815",
                "name": "More offer 2",
                "description": "More offer 2",
                "installmentNumber": 4,
                "installmentInterval": 5,
                "installmentPercentage": 3
            },
            {
                "creditOfferId": "69918875",
                "name": "10 payments per 14 days (25%)",
                "description": "",
                "installmentNumber": 10,
                "installmentInterval": 14,
                "installmentPercentage": 25
            },
            {
                "creditOfferId": "40208009",
                "name": "2 payments per 7 days (10%)",
                "description": "",
                "installmentNumber": 2,
                "installmentInterval": 7,
                "installmentPercentage": 10
            }
        ]
    }
}

 ```

#### Reserving the Loan

In order to aquire the loan we first create loan reservation that take information about purpose of the loan, amount, invoices and returns reservation id that is valid for a period of time.

The payload required for the loan reservation is described below.

``` json
{
  "bills": [
    {
      "billId": "id of the bill created with bill api"
    }
  ],
  "collectingMethodId": "The method create with method api that will be used to collect loan repayments",
  "fundingMethodId": "Method that can be used to fund the reciver of loan funds.",
  "creditOfferId": "credit offer selected."
}

 ```

#### Allocate the Loan

If reservation is successful it will contain `loan_id` that can be used to allocate the loan.

The allocation call will return status to confirm that loan was allocated.

Embedded finance

Koverly API

Koverly Development Platform

Production

Sandbox

<p class="slate-p slate-indent-0" style="0px">This section provides the basic steps necessary for authorization to gain secure access to the Koverly API and creating a search key so that you can make conditional selections of objects based on descriptions and simplify your code and helpful operator functions.</p><p class="slate-p slate-indent-0" style="0px"></p><h1 class="slate-h1 " >
Authentication</h1><p class="slate-p " >In order to securely access the Koverly API platform, security artifacts and JWT token standards are required. </p><p class="slate-p " ></p><p class="slate-p " >We provide:</p><div class="table-container" style="width:98%;
  min-width:98%;"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">API Key</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">API Secret</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >512-bit unique value used as an authentication public token</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >1024-bit unique, cryptographically strongkey that is used as a secret token.</p></td></div></tr></tbody></table></div><h2 class="slate-h2 " >JWT Bearer Authentication</h2><p class="slate-p " >JWT Bearer uses construction of the JWT token together with an Authorization http header to gain access to Koverly API functions.</p><h3 class="slate-h3 " >NodeJS example</h3><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line"> const p1 = &apos;{&quot;alg&quot;:&quot;HS256&quot;,&quot;typ&quot;:&quot;JWT&quot;}&apos;;</div><div class="slate-code_line"> const p2 = &apos;{&quot;apiKey&quot;:&quot;api-key&quot;,&quot;nonce&quot;:1684189441978}&apos;;</div><div class="slate-code_line"> const p12 = B64(p1) + &apos;.&apos; + B64(p2);</div><div class="slate-code_line"> const token = p12 + &apos;.&apos; + B64(HMAC256(p12, &apos;api-secret&apos;))</div><div class="slate-code_line"></div></code></pre></div><h3 class="slate-h3 " >C# Example</h3><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-csharp keep-markup drop-tokens"><div class="slate-code_line">using System;
using System.Text;
using System.Security.Cryptography;
public class Program
{
public static void Main()
{
long milliseconds = DateTimeOffset.Now.ToUnixTimeMilliseconds();
string apikey = &quot;kk-…yw&quot;;
string apiSecret = &quot;ks-Mp…OLM&quot;;</div><div class="slate-code_line">    string p1 = &quot;{\&quot;alg\&quot;:\&quot;HS256\&quot;,\&quot;typ\&quot;:\&quot;JWT\&quot;}&quot;;</div><div class="slate-code_line">    string p2 = &quot;{\&quot;apiKey\&quot;:\&quot;&quot;+apikey+&quot;\&quot;,\&quot;nonce\&quot;:&quot;+milliseconds.ToString()+&quot;000}&quot;;</div><div class="slate-code_line">    </div><div class="slate-code_line">    Console.WriteLine(p2);</div><div class="slate-code_line">    </div><div class="slate-code_line">    string p12 = Base64Encode(p1) + &quot;.&quot; + Base64Encode(p2);</div><div class="slate-code_line">    string token = p12 + &quot;.&quot; + Base64UrlEncode(HMACSHA256(p12, apiSecret));</div><div class="slate-code_line">    Console.WriteLine(token);</div><div class="slate-code_line">}</div><div class="slate-code_line"></div><div class="slate-code_line">public static byte[] HMACSHA256(string data, string key)</div><div class="slate-code_line">{</div><div class="slate-code_line">    byte[] byteKey = Encoding.UTF8.GetBytes(key);</div><div class="slate-code_line">    using (HMACSHA256 hmac = new HMACSHA256(byteKey))</div><div class="slate-code_line">    {</div><div class="slate-code_line">        return hmac.ComputeHash(Encoding.UTF8.GetBytes(data));</div><div class="slate-code_line">    }</div><div class="slate-code_line">}</div><div class="slate-code_line">public static string Base64Encode(string plainText)</div><div class="slate-code_line">{</div><div class="slate-code_line">    byte[] plainTextBytes = Encoding.UTF8.GetBytes(plainText);</div><div class="slate-code_line">    string a = Convert.ToBase64String(plainTextBytes);</div><div class="slate-code_line">    return a.Replace(&apos;+&apos;, &apos;-&apos;).Replace(&apos;/&apos;, &apos;_&apos;).TrimEnd(&apos;=&apos;);</div><div class="slate-code_line">}</div><div class="slate-code_line"></div><div class="slate-code_line">public static string Base64UrlEncode(byte[] data)</div><div class="slate-code_line">{</div><div class="slate-code_line">    string base64 = Convert.ToBase64String(data);</div><div class="slate-code_line">    return base64.Replace(&apos;+&apos;, &apos;-&apos;).Replace(&apos;/&apos;, &apos;_&apos;).TrimEnd(&apos;=&apos;);</div><div class="slate-code_line">}</div><div class="slate-code_line">}</div><div class="slate-code_line"></div></code></pre></div><h3 class="slate-h3 " >Java Example</h3><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-java keep-markup drop-tokens"><div class="slate-code_line">import javax.crypto.Mac;</div><div class="slate-code_line">import javax.crypto.spec.SecretKeySpec;</div><div class="slate-code_line">import java.util.Base64;</div><div class="slate-code_line">public class JWTGenerator {</div><div class="slate-code_line">    private static final String ALGORITHM = &quot;HmacSHA256&quot;;</div><div class="slate-code_line">    private static final String SECRET = &quot;api-secret&quot;;</div><div class="slate-code_line">    private static final String KEY = &quot;api-key&quot;;</div><div class="slate-code_line">    public static void main(String[] args) {</div><div class="slate-code_line">        String header = &quot;{\&quot;alg\&quot;:\&quot;HS256\&quot;,\&quot;typ\&quot;:\&quot;JWT\&quot;}&quot;;</div><div class="slate-code_line">        String payload = &quot;{\&quot;apiKey\&quot;:\&quot;api-key\&quot;,\&quot;nonce\&quot;:String.valueOf(System.currentTimeMillis())}&quot;;</div><div class="slate-code_line">        String encodedHeader = base64Encode(header.getBytes());</div><div class="slate-code_line">        String encodedPayload = base64Encode(payload.getBytes());</div><div class="slate-code_line">        String jwt = encodedHeader + &quot;.&quot; + encodedPayload + &quot;.&quot; + generateSignature(encodedHeader + &quot;.&quot; + encodedPayload);</div><div class="slate-code_line">        System.out.println(&quot;JWT: &quot; + jwt);</div><div class="slate-code_line">    }</div><div class="slate-code_line">    private static String base64Encode(byte[] data) {</div><div class="slate-code_line">        return Base64.getUrlEncoder().withoutPadding().encodeToString(data);</div><div class="slate-code_line">    }</div><div class="slate-code_line">    private static String generateSignature(String data) {</div><div class="slate-code_line">        try {</div><div class="slate-code_line">            Mac signer = Mac.getInstance(ALGORITHM);</div><div class="slate-code_line">            SecretKeySpec keySpec = new SecretKeySpec(SECRET.getBytes(), ALGORITHM);</div><div class="slate-code_line">            signer.init(keySpec);</div><div class="slate-code_line">            byte[] signature = signer.doFinal(data.getBytes());</div><div class="slate-code_line">            return base64Encode(signature);</div><div class="slate-code_line">        } catch (Exception e) {</div><div class="slate-code_line">            e.printStackTrace();</div><div class="slate-code_line">        }</div><div class="slate-code_line">        return null;</div><div class="slate-code_line">    }</div><div class="slate-code_line">}</div><div class="slate-code_line"></div></code></pre></div><div class="slate-div"><p class="slate-p " >Note: “nonce” in this case is a millisecond precision time stamp.</p></div><p class="slate-p " >Once the token has being created, it can be used in http communication with Authorization headers.</p><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden">HTTP /../../../ HTTP/1.1
...
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJhcGlLZXkiOiJwYXJ0ZXN0Iiwibm9uY2UiOiIxNjg0Mzc1NzY1MDAwIn0.tDGyhWmWnRJfYDHfPItYRPorzeJT6VW516bwDnBnrds </textarea><code class="language-plainText keep-markup drop-tokens"></code></pre></div><h2 class="slate-h2 " >Search</h2><p class="slate-p " >All major objects in the API are associated with a search component that will allow you to make conditional selections of objects based on described properties.</p><p class="slate-p " >For example:</p><div class="slate-div"><p class="slate-p " >{ &quot;filter&quot;: {&lt;key1&gt;: &lt;expression1&gt;, &lt;key2&gt;: &lt;expression2&gt;, &lt;key3&gt;: &lt;expression3&gt;,....}}</p></div><h2 class="slate-h2 " >Operators</h2><h3 class="slate-h3 " >$or, $and, $not</h3><div class="slate-div"><p class="slate-p " >{ &quot;filter&quot;: {$or: [ {userId: : &apos;123&apos;}, {userId: &apos;456&apos;} ] } }</p></div><div class="slate-div"><p class="slate-p " >{ &quot;filter&quot;: {$and: [ {userId: : &apos;123&apos;}, {userId: &apos;456&apos;} ] }}</p></div><div class="slate-div"><p class="slate-p " >{ &quot;filter&quot;: {$not: {userId: : &apos;123&apos;} } }</p></div><h3 class="slate-h3 " >$in</h3><p class="slate-p " >Accepts the list of values and sets <code class="slate-code">true</code> if field in value.</p><div class="slate-div"><p class="slate-p " >{ &quot;filter&quot;: {field: {$in: [&lt;value&gt;, &lt;value&gt;,...]}}}}</p></div><h3 class="slate-h3 " >$like</h3><div class="slate-div"><p class="slate-p " >{ &quot;filter&quot;: {field: {$like: value}}}</p></div><h4 class="slate-h4 " >$start, $end</h4><p class="slate-p " >This is a range operator that can be used as following:</p><div class="slate-div"><p class="slate-p " >{ &quot;filter&quot;: {&lt;field&gt;: {$start: &lt;value1&gt;}}}</p></div><div class="slate-div"><p class="slate-p " >{ &quot;filter&quot;: {&lt;field&gt;: {$end: &lt;value2&gt;}}}</p></div><div class="slate-div"><p class="slate-p " >{ &quot;filter&quot;: {&lt;field&gt;: {$start: &lt;value1&gt;, $end: &lt;value2&gt;}}}</p></div><p class="slate-p " ></p><p class="slate-p " ></p>

This section provides the basic steps necessary for authorization to gain secure access to the Koverly API and creating a search key so that you can make conditional selections of objects based on descriptions and simplify your code and helpful operator functions.

In order to securely access the Koverly API platform, security artifacts and JWT token standards are required. 

Title

Description

JWT Bearer uses construction of the JWT token together with an Authorization http header to gain access to Koverly API functions.

Once the token has being created, it can be used in http communication with Authorization headers.

All major objects in the API are associated with a search component that will allow you to make conditional selections of objects based on described properties.

This is a range operator that can be used as following:

Koverly’s B2B Financing solution allows you to provide flexible payment options within your existing checkout flow with credit that is underwritten and managed by Koverly.

Businesses using Koverly’s B2B Financing solution will receive payment within 24 hours of checkout. Koverly assumes all credit risk - underwriting clients, conducting approvals and managing payment collections.

Depending on your integration needs, Koverly’s B2B Financing solution can be fully embedded into your proprietary checkout, or implemented with lighter integrations.

Multiple integration options allow you to offer the best user experience for your platform:

My Importer

 referenced in the code above is the unique identifier that you will use for future references and API calls.

Option A) Credit Application via Koverly website

Complete the initialization of the user with Koverly platform and allow the user to complete a credit application within Koverly within the main web-site.

To do this, we will call the API to get a sign-up-link:

This will return a single-use URL that can be used to initiate signup to the company that was just created.  The link can be opened in a new browser tab or used to execute http 302 forward.

User will then go through credit application and credit line approval in the Koverly platform.

Option B) Credit Application via Koverly Widget

This allows the user to go through the credit application and credit line approval in an embedded widget on your site.

To do this, we first call the widget application to prepare endpoint with 

The following token can subsequently be used to bring up the UI widget

The token is then passed to the KoverlyApi in Javascript to initialize the embedded   widget.

 required and displays configured plan and offers for the provided company

Koverly aims to provide credit approvals in near-real-time. However, since this still takes a few seconds we provide two ways to obtain notification of a completed credit decision.

In both cases, the data returned will be the same, which includes the status, the credit limit and balance owed. 


Step 4 - Credit checkout via Koverly API or widget

In order to complete checkout using Koverly API or through the Koverly credit checkout widget, the "Vendor" company getting paid needs to be created and associated as a "Vendor" to an existing company. Following this, one or more bills to be used in the checkout process must also be created.

The process for the creation of the "Vendor" company is the same as any other Company as described in Step 1.

Once the vendor company is created we need to associate it to your clients company with the call below.

Partest2 company 7897897898755

Once a vendor is created, one or more bills can be created using the Bill API to prepare for payment.

In response to this call, we will return created invoice object with the id that can be referenced for future calls.

Step 4.4 - Create Credit Loan Reservation

 . If not provided, this will be defaulted to Customer's primary payment information and the Vendor's primary funding information stored in your application.

In return, a successful loan reservation will be generated, locking in an amount for the Customer's credit amount until the reservation is canceled or allocated.

Koverly’s B2B checkout solution allows customers to pay via ACH/bank transfer or credit card. Payments can be made in USD or foreign currency with real-time FX conversion rates built into the checkout flow.

Businesses in the United States may also apply for KoverlyPay financing for the option to spread payments over time.

There are multiple integration options at every level:

The first step to integration is onboarding a new client to the payment platform. This a combination of API calls to create a 

 object that is populated with initial information; create a 

 object; and finally to initiate an invitation to the 

 is the unique identifier of your client that you will be retaining for future references and API calls.

In response, you will get a user object with 

Once the user has being invited and goes through login setup process to get access to Koverly platform, the following will appear in your account:

Once you select to activate the account, you will be guided through the activation process, which includes passing the KYC/Compliance stage to gain access to the fully activated account.

The flow continues until the "approval pending" screen

 have been created and completed onboarding, the API(s) can be used to:

 is created, you can get a sign-on-url using the following code:

This will return a 1-time use URL that can be used to initiate a signup to the 

Once signed up, the activation process described above will take place. When this process has been completed, a fully activated account will be accessible to invited users.

Koverly's AR platform provides tools for efficient collection of 

 companies can be created manually within the platform itself, or via API.

 has been generated, this call can be made:

 will show up in the Koverly AR section for customers.

 SSO to one of our embedded UI solutions you will need to create a 

 in order to pass the secure identity from your login system. In this case, you might need to be able to create a 

 has been created and setup has been completed, invoices should be added to their accounts so that the AR process can be presented.

In response to this call, Koverly will return a 

 that can be referenced for future calls.

Vendors are created in the same way as customers. The 

 object is created as described above. Secondly, you will need to call:

In order to create the checkout widget, you need to create all required supporting objects.

 differs depending on how you will be implementing the checkout functionality: 

Start by creating a new customer company that will be paying through the checkout widget.

This will create a customer company instance.

 to the payee company that we selected in 

 is the Id of the company of the API caller found in in the

 is id of the customer company that we created in previous call.

Finally, if the customer company that you created does not have a 

 that was authenticated in the context of this flow associated with it, you need to also create this 

 returned with this call should be retained for future payment calls at user level in the hosting application.

You are now ready to select or add all required invoices. You may add all outstanding invoices or select invoices (eg. invoices that are due now). Either way, once invoices are created you must retain each invoice ID somewhere in the system, so that the same invoice does not get created multiple times.

To initialize the widget, you must call the 

 endpoint with all of the data gathered above to get a secure token.

The token is then passed into the KoverlyAPI in Javascript to initialize the embedded widget.

The checkout widget allows for an embedded checkout experience powered by Koverly's technology.

In order to put together a functional checkout widget, the following is required:

name

legalName

address

legalTaxType

legalTaxNumber

defaultCurrency

ITS Freight Broker Client Customer

Tab 1

 object is used to create an operating business entity in the Koverly system. The same company can play a number of roles, such as payer, payee, service provider or a partner.

<p class="slate-p" placeholder="Type / for widgets">Vendors are companies that are setup to get remittances and fund transfers.</p><p class="slate-p" placeholder="Type / for widgets">To setup a Vendor, use the <a href="https://app.theneo.io/koverly/koverly-development-platform/api-references/company" target="_blank">Company API</a> to create a Company and then add this company as a Vendor to another Company. </p><p class="slate-p" placeholder="Type / for widgets">Companies can be Vendors and Customers at the same time.</p>

Vendors are companies that are setup to get remittances and fund transfers.

 to create a Company and then add this company as a Vendor to another Company. 

Companies can be Vendors and Customers at the same time.

<p class="slate-p" placeholder="Type / for widgets">Users are individuals associated with a company. The company they are associated with can be a vendor or a customer to any other company.  </p><table class="slate-table"><colgroup></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content"><strong class="slate-bold">Property</strong></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><strong class="slate-bold">Description</strong></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content"><strong class="slate-bold">Required</strong></div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content">firstName</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">Last name</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">Y</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content">lastName</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">First name</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">Y</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content">email</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">email</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">Y</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content">role</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">ADMIN / CONTRIBUTOR</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">Y</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content">isActive</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">true/false</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td><td class="slate-td"><div class="slate-TableCellElement-content">false</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr><tr class="slate-tr"><td class="slate-td"><div class="slate-TableCellElement-content">isBlocked</div><div class="slate-TableCellElement-resizableWrapper" contenteditable="false"><div style="position:relative;user-select:auto;width:100%;height:100%;box-sizing:border-box;flex-shrink:0" ><div><div  style="position:absolute;user-select:none;width:10px;height:calc(100% + 12px);top:-12px;cursor:col-resize;right:-5px;z-index:20"></div></div></div><div class="slate-TableCellElement-handle"></div></div><div class="slate-TableCellElement-selectedCell" contenteditable="false"></div></td></tr></tbody></table><p class="slate-p" placeholder="Type / for widgets"></p>

Users are individuals associated with a company. The company they are associated with can be a vendor or a customer to any other company.  

<p class="slate-p" placeholder="Type / for widgets">Customers are companies that are setup to receive statements and invoices.</p><p class="slate-p" placeholder="Type / for widgets">To setup a customer use Company API to create a company and then add this company as a customer to another.</p><p class="slate-p" placeholder="Type / for widgets">Companies can be vendors and customers in the same time.</p>

Customers are companies that are setup to receive statements and invoices.

To setup a customer use Company API to create a company and then add this company as a customer to another.

Companies can be vendors and customers in the same time.

Invoice is request for payment presented between the company and its customer. The following fields are part of invoice object

<h2 class="slate-h2">Invoice</h2><p class="slate-p" placeholder="Type / for widgets">Wallet API allows you to initialize and use Wallet infrastrcutre.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Wallet API allows you to initialize and use Wallet infrastrcutre.

<p class="slate-p" placeholder="Type / for widgets">Enables different payment options. </p>

<p class="slate-p" placeholder="Type / for widgets">Koverly&apos;s FX API provides functionality for obtaining supported currencies and live FX rates for each currency at the customer level.  </p>

Koverly's FX API provides functionality for obtaining supported currencies and live FX rates for each currency at the customer level.  

<p class="slate-p" placeholder="Type / for widgets">Get a list of supported currencies for FX payments.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Get a list of supported currencies for FX payments.

Get supported currencies

Content-type

companyId

<p class="slate-p" placeholder="Type / for widgets">Get a list of supported countries for FX payments.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Get a list of supported countries for FX payments.

Get supported countries

<p class="slate-p" placeholder="Type / for widgets">Get FX rates for all currencies unique to a company.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Get FX rates for all currencies unique to a company.

Get company FX rates

A unique identifier used to specify the service provider for the foreign exchange transaction

providerId

A three-letter code representing the type of currency the user wishes to purchase

buyCurrency

A three-letter code representing the type of currency the user is selling in exchange for the buyCurrency

sellCurrency

The specific timestamp when the payment transaction is scheduled to take place

scheduleTime

Unique identifier representing the customer or entity making the payment

payerId

Unique identifier representing the customer or entity set to receive the payment

payeeId

The total value of the transaction expressed in the sellCurrency. This is a numerical input field

amount

<p class="slate-p" placeholder="Type / for widgets">Create a conversion lock for a specific BUYSELL pair of currencies.  The lock could be scheduled forward</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Create a conversion lock for a specific BUYSELL pair of currencies.  The lock could be scheduled forward

Create Currency Lock

<p class="slate-p" placeholder="Type / for widgets">The Payments section of the Koverly Development Platform API plays a vital role in facilitating seamless financial transactions within your application. The primary function of this API section is to handle all operations related to payments. This includes, but is not limited to, creating new transactions, updating existing transactions, retrieving transaction details, and processing refunds.</p><p class="slate-p" placeholder="Type / for widgets">This API endpoint is typically used in cases where you need to integrate payment functionality into your application. For instance, it could be an e-commerce platform requiring a full-fledged payment processing system, or a subscription-based service needing recurring payment operations. Regardless of the complexity of your use-case, the Payments API ensures a smooth, secure, and reliable experience.</p><p class="slate-p" placeholder="Type / for widgets">One of the standout features of the Payments API is its robust security protocols. It safeguards sensitive financial data using the highest level of encryption, which aligns with industry-standard security practices. Therefore, you can confidently use this Payments API, knowing that your and your customers&apos; data are protected at all times.</p><p class="slate-p" placeholder="Type / for widgets">Another special consideration involves the Payments API&apos;s broad compatibility with numerous payment methods. Whether it&apos;s credit cards, debit cards, digital wallets, or bank transfers, this API provides comprehensive support for a wide variety of payment options. It&apos;s designed to cater to your diverse customer base, offering them the flexibility to choose their preferred mode of payment.</p><p class="slate-p" placeholder="Type / for widgets">Furthermore, the Payments API is extremely user-friendly. It is designed to be easily navigated by both technical and non-technical users. Its straightforward structure and clear instructions make it easy to understand and implement, even for those with limited programming knowledge.</p><p class="slate-p" placeholder="Type / for widgets">In summary, the Payments API section is a powerful tool that simplifies payment-related integrations within your application. It&apos;s secure, flexible, and user-friendly, making it a great choice for your financial transaction needs.</p>

The Payments section of the Koverly Development Platform API plays a vital role in facilitating seamless financial transactions within your application. The primary function of this API section is to handle all operations related to payments. This includes, but is not limited to, creating new transactions, updating existing transactions, retrieving transaction details, and processing refunds.

This API endpoint is typically used in cases where you need to integrate payment functionality into your application. For instance, it could be an e-commerce platform requiring a full-fledged payment processing system, or a subscription-based service needing recurring payment operations. Regardless of the complexity of your use-case, the Payments API ensures a smooth, secure, and reliable experience.

One of the standout features of the Payments API is its robust security protocols. It safeguards sensitive financial data using the highest level of encryption, which aligns with industry-standard security practices. Therefore, you can confidently use this Payments API, knowing that your and your customers' data are protected at all times.

Another special consideration involves the Payments API's broad compatibility with numerous payment methods. Whether it's credit cards, debit cards, digital wallets, or bank transfers, this API provides comprehensive support for a wide variety of payment options. It's designed to cater to your diverse customer base, offering them the flexibility to choose their preferred mode of payment.

Furthermore, the Payments API is extremely user-friendly. It is designed to be easily navigated by both technical and non-technical users. Its straightforward structure and clear instructions make it easy to understand and implement, even for those with limited programming knowledge.

In summary, the Payments API section is a powerful tool that simplifies payment-related integrations within your application. It's secure, flexible, and user-friendly, making it a great choice for your financial transaction needs.

<h3 class="slate-h3 " >Overview</h3><p class="slate-p " >Web Hooks are used to report events to a web hook subscriber. In order to subscribe to web hook you first need to create a web hook object. The obect is a simple JSON object that contains 2 properties.</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">    &quot;webhookId&quot;: &quot;&lt;Id of created web hook&gt;&quot;,</div><div class="slate-code_line">    &quot;object&quot;: &quot;PAYMENT|COMPANY&quot;, //</div><div class="slate-code_line">    &quot;event&quot;: &quot;CREDIT_ACTIVATED|CREDIT_AGREED|CREDIT_ENABLED|CREDIT_DISABLED|PAYMENT_CREATED|CREDIT_DECLINED&quot;,</div><div class="slate-code_line">    &quot;callbackUrl&quot;: &quot;https://...&quot;,</div><div class="slate-code_line">    &quot;callbackPayload&quot;: &quot;...&quot;</div><div class="slate-code_line">}</div></code></pre></div><p class="slate-p " ></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:400px;">Title</div><div style="width:400px;">Description</div><div style="width:400px;">Title</div></div><colgroup ></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#6AA74F">Event</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#6AA74F">Object</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:#6AA74F">Description</span></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-1" style="24px">CREDIT_ACTIVATED</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-1" style="24px">COMPANY</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >When credit setup is initiated</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-1" style="24px">CREDIT_AGREED</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-1" style="24px">COMPANY</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >When credit line is signed</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-1" style="24px">CREDIT_ENABLED</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-1" style="24px">COMPANY</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >When credit is enabled</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-1" style="24px">CREDIT_DISABLED</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-1" style="24px">COMPANY</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >When credit is disabled</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-1" style="24px">STATUS_CHANGED</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p slate-indent-1" style="24px">PAYMENT</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >When payment status is changed</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="background-color:rgb(248, 248, 248);color:rgb(29, 28, 29)">    CREDIT_DECLINED</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >     COMPANY</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Declined credit app</p></td></div></tr></tbody></table></div><h2 class="slate-h2 " >Endpoint</h2><p class="slate-p " >Only https valid public internet endpoints, protected by a valid certificate are supported. The endpoint will need to process HTTP POST method and consume payload as well as Koverly-Token authentication header.</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden">POST //// HTTP/1.1
.....
.....
Content-type: application:json
Koverly-Token: 823ue89ud289hde9w823d9jh928ed239udh982hdu9h2d98y23ehu92eh98dh239udh29983289838938383==
{
  "success": true,
  "statusCode": 0,
  "webhook": {
     "id": "id....",
     "callbackPayload": {}
  },
  "payment": {
    "paymentId": "3dca6f35-162b-4af9-92e9-c16c4c182fc6",
    "paymentNumber": "97898755",
    "invoices": [
      {
        "billId": "1fc74da3-2b66-45dd-b408-0cf0caf4752e",
        "currency": "USD",
        "dueAmount": 0,
        "paymentAmount": 12
      },
      {
        "billId": "ab85cd73-fd72-4730-88a5-fd0b06cbbba9",
        "currency": "USD",
        "dueAmount": 0,
        "paymentAmount": 12
      }
    ],
    "paymentMethodId": "123123123123123",
    "fundingMethodId": "123123123123123",
    "paymentType": "ACH/ACH",
    "payerId": "740cb157-3cab-467c-8223-ec4810dd3e09",
    "payeeId": "549d6fb1-48c2-4ca4-9c38-a600480f6335",
    "payerCurrency": "USD",
    "payeeCurrency": "USD",
    "payeeCurrencyRate": 1,
    "scheduleTime": "2023-05-29T23:11:01.702Z",
    "sentTime": null,
    "paymentAmount": 25,
    "paymentFeePercentage": 0,
    "payeeFeePercentage": 0,
    "paymentFee": 0,
    "payeeFee": 0,
    "payeeAmount": 0,
    "payeeCurrencyAmount": 0,
    "payerAmount": 0,
    "status": "scheduled",
    "transactionStatus": null,
    "paymentTransactionStatus": null
  }
} </textarea><code class="language-plainText keep-markup drop-tokens"></code></pre></div><h4 class="slate-h4 " >Koverly-Token</h4><p class="slate-p " >Koverly-Token authentication header is a calculated as follows</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-javascript keep-markup drop-tokens"><div class="slate-code_line">const token = B64(HMAC256(weebhookId, &apos;api-secret&apos;));</div><div class="slate-code_line">token == Koverly-Token header value </div><div class="slate-code_line"></div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p>

Web Hooks are used to report events to a web hook subscriber. In order to subscribe to web hook you first need to create a web hook object. The obect is a simple JSON object that contains 2 properties.

Only https valid public internet endpoints, protected by a valid certificate are supported. The endpoint will need to process HTTP POST method and consume payload as well as Koverly-Token authentication header.

Koverly-Token authentication header is a calculated as follows

<p class="slate-p " >Create API allows Koverly partners and customers to embed finance products into their own integrated environments.  </p><p class="slate-p " ></p><div class="slate-code_line"></div><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">                &quot;name&quot;: &quot;10 payments per 14 days (25%)&quot;,</div><div class="slate-code_line">                &quot;description&quot;: &quot;&quot;,</div><div class="slate-code_line">                &quot;installmentNumber&quot;: 10,</div><div class="slate-code_line">                &quot;installmentInterval&quot;: 14,</div><div class="slate-code_line">                &quot;installmentPercentage&quot;: 25</div><div class="slate-code_line">            },</div><div class="slate-code_line">            {</div><div class="slate-code_line">                &quot;creditOfferId&quot;: &quot;40208009&quot;,</div><div class="slate-code_line">                &quot;name&quot;: &quot;2 payments per 7 days (10%)&quot;,</div><div class="slate-code_line">                &quot;description&quot;: &quot;&quot;,</div><div class="slate-code_line">                &quot;installmentNumber&quot;: 2,</div><div class="slate-code_line">                &quot;installmentInterval&quot;: 7,</div><div class="slate-code_line">                &quot;installmentPercentage&quot;: 10</div><div class="slate-code_line">            }</div><div class="slate-code_line">        ]</div><div class="slate-code_line">    }</div><div class="slate-code_line">}</div><div class="slate-code_line"></div></code></pre></div><h4 class="slate-h4 " >Reserving the Loan</h4><p class="slate-p " >In order to aquire the loan we first create loan reservation that take information about purpose of the loan, amount, invoices and returns reservation id that is valid for a period of time.</p><p class="slate-p " >The payload required for the loan reservation is described below.</p><div class="code-block-wrapper"  style="width:60%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{</div><div class="slate-code_line">  &quot;bills&quot;: [</div><div class="slate-code_line">    {</div><div class="slate-code_line">      &quot;billId&quot;: &quot;id of the bill created with bill api&quot;</div><div class="slate-code_line">    }</div><div class="slate-code_line">  ],</div><div class="slate-code_line">  &quot;collectingMethodId&quot;: &quot;The method create with method api that will be used to collect loan repayments&quot;,</div><div class="slate-code_line">  &quot;fundingMethodId&quot;: &quot;Method that can be used to fund the reciver of loan funds.&quot;,</div><div class="slate-code_line">  &quot;creditOfferId&quot;: &quot;credit offer selected.&quot;</div><div class="slate-code_line">}</div><div class="slate-code_line"></div></code></pre></div><h4 class="slate-h4 " >Allocate the Loan</h4><p class="slate-p " >If reservation is successful it will contain <code class="slate-code">loan_id</code> that can be used to allocate the loan.</p><p class="slate-p " >The allocation call will return status to confirm that loan was allocated.</p><p class="slate-p " ></p>

Create API allows Koverly partners and customers to embed finance products into their own integrated environments.  

In order to aquire the loan we first create loan reservation that take information about purpose of the loan, amount, invoices and returns reservation id that is valid for a period of time.

The payload required for the loan reservation is described below.

If reservation is successful it will contain 

The allocation call will return status to confirm that loan was allocated.

Sections