Overview

This manual is divided into several sections, each focusing on a specific aspect of the Stripe-Kognitos integration.

Introduction

The integration of Stripe with Kognitos offers a seamless and intuitive way to manage Stripe's payment processing capabilities. This integration allows users to perform a variety of operations on Stripe objects, including connecting to Stripe, retrieving, creating, updating, and deleting records, and managing invoices, all through Kognitos' natural language processing capabilities. This section provides an overview of the Stripe-Kognitos integration and outlines the prerequisites for using Stripe on Kognitos.

Prerequisites for Using Kognitos with Stripe

Before you can start using Kognitos to interact with Stripe, there are several prerequisites that need to be met:

Stripe Account: You need to have an active Stripe account. If you do not have one, you can sign up for a Stripe account to get started.
API Key: Obtain your Stripe API key, which is required for Kognitos to communicate with Stripe. You can find this in your Stripe dashboard under "Developers" > "API keys".

Once these prerequisites are met, you are ready to start leveraging the power of Kognitos to enhance your Stripe experience, making it more accessible, efficient, and customizable.

Setting Up Stripe Connection

Connecting to Stripe

To interact with Stripe using Kognitos, establishing a secure connection to your Stripe instance is the first critical step. This section outlines the credentials required for this connection and provides a detailed, step-by-step guide to connect successfully.

Required Credentials

To connect to Stripe, you will need the following credential:

Stripe API Key: The API key for your Stripe account. This key is used to authenticate and authorize your requests to Stripe.

Step-by-Step Connection Process

Gather Credentials: Ensure you have your Stripe API key.
Navigate to the Departments tab of Kognitos and search for Microsoft Outlook
Click on + New Book button on the right of the Departments page
Search for Stripe Pay and then click on the book which is shown

Add in the credentials when you are prompted

Connection Established: Once the connection is successfully established, you are ready to perform various operations on Stripe. You can now fetch data, create new records, update existing ones, delete records, and manage invoices.

Working with Stripe Objects

Interacting with Stripe objects is a core functionality when integrating Stripe with Kognitos. This section covers how to fetch data, create and modify Stripe objects, and delete them when necessary.

Fetching Data

To fetch data from Stripe, you can use the following commands:

get a customer from stripe whose email is "[email protected]"

get an invoice from stripe whose status is "open"

Creating and Modifying Stripe Objects

Adding New Records

To add a new record to Stripe, you need to specify the type of object you're creating and provide the necessary field values.

Example:

create a customer in stripe with
  the email is "[email protected]"
  the name is "John Doe"

This command creates a new customer with the specified email and name.

create a price in stripe with
  the unit_amount is 1000
  the currency is "usd"
  the product is "12232232"

This command creates a new price with the specified unit amount, currency, and product ID.

Adding Items to Invoices

To add an item to an invoice, use the following command:

add a item to the invoice with
  the customer is "cus_123ABC"
  the amount is 1500
  the currency is "usd"

This command adds an item to the specified invoice with the given customer, amount, and currency.

Sending Invoices

To send an invoice, use the following command:

send the invoice

Deleting Stripe Objects

Single Deletion

To delete a specific Stripe object, you need to specify the object and its ID.

Example:

delete a customer in stripe with
  the id is "cus_123ABC"

This command deletes the customer with the specified ID.

delete an invoice in stripe with
  the id is "sub_123456789"

This command deletes the invoice with the specified ID.

By following these guidelines, you can effectively manage Stripe objects in Kognitos, from fetching and creating records to updating and deleting them as needed.

Glossary of Terms

API Key: A unique identifier used to authenticate requests associated with your Stripe account.
Customer: A Stripe object representing a customer who can be billed for products and services.
Invoice: A Stripe object representing a bill for a customer, which can include multiple items.
Price: A Stripe object representing the cost of a product or service.
Product: A Stripe object representing a product or service that can be sold to customers.

This documentation provides a comprehensive guide to using Kognitos with Stripe, enabling you to manage your Stripe operations efficiently and effectively.