Stripe Integration Documentation

Purpose

The Stripe Integration for Vantage is designed to facilitate interactions with the Stripe payment platform, enabling users to manage various financial operations such as handling charges, customers, invoices, balance transactions, and events. This integration streamlines the payment processing experience and allows businesses to effectively track and manage their financial activities through automated API interactions.

Settings

The Stripe Integration's settings mainly revolve around API interactions and data handling capabilities. Below are the detailed settings:

API Settings

• Setting Name: apiKey
  • Input Type: String
  • Description: This setting is used to provide the authorization key required for accessing the Stripe API. It authenticates requests to ensure data safety and security. Changing this value will affect all API calls made by the integration, potentially leading to unauthorized errors if the key is incorrect.
  • Default Value: (Not explicitly defined in code but typically required to be set by the user)

How It Works

The integration sets the API base URL for Stripe as https://api.stripe.com/v1. The integration performs actions like:

1. Making API Calls: Sending GET requests to various Stripe endpoints to retrieve data related to charges, customers, invoices, and events.
2. Building Queries: The private method #buildQuery formats parameters to adhere to Stripe's API requirements. It excludes any undefined or null values and formats date ranges appropriately.
3. Handling Responses: The integration processes the responses returned by the Stripe API, extracting relevant data and pagination information.

Data It Expects

The integration can handle several types of data, which are primarily parameterized in functions:

• Charge Data: Including customer ID, limit on number of results, and identifiers for pagination.
• Customer Data: Email filtering, along with pagination controls.
• Event Data: Filtering based on types defined in StripeEventTypesEnum, and created date range.
• Invoice Data: Customer ID, invoice status from defined statuses in StripeInvoiceStatus, and pagination for results.
• Balance Transaction Data: Basic queries for balance-related information such as limits.
• Payout Data: Similar to balance transactions, focusing on results defined by pagination.

Use Cases & Examples

Use Case 1: Charge Management

A company needs to track and manage all charges associated with its customers. Through the Stripe Integration, the business can easily retrieve charges, analyze payment trends, and manage disputes.

Use Case 2: Customer Data Retrieval

A subscription-based service might want to identify customers who have outdated payment information. Using the integration, the service can search customers efficiently based on email or retrieve their details and update records accordingly.

Use Case 3: Invoice Processing

An online store requires a mechanism to send and track invoices. The integration allows the store to pull a list of invoices for a specific customer, check their payment status, and determine follow-up actions.

Detailed Example: Configuring for Charge Management

To configure the the Stripe integration for managing customer charges, the code can utilize the listCharges method. Below is a sample configuration:

const the Stripe integration = new the Stripe integration({ apiKey: 'your_stripe_api_key' });

const config = {
  customerId: 'cus_12345',
  limit: 50,
  starting_after: null,
  ending_before: null,
};

the Stripe integration.listCharges(config).then(charges => {
  console.log('Customer Charges:', charges);
}).catch(error => {
  console.error('Error fetching charges:', error);
});

In this configuration:

• The customerId is specified to filter charges for a specific customer.
• The limit is set to 50 to control the number of records returned.
• Pagination controls are set to null to start from the first record.

This use case exemplifies how the integration can facilitate efficient charge management while maximizing the capabilities of the Stripe API.