API Docs

Dashboard

Support


      Retrieves the participants of a specific payment group using its unique identifier. 
      This endpoint returns detailed information about each participant in the payment group.
    

Retrieve participants

The ID of the customer. This field is required and must be a valid customer ID.

The expiration date and time of the payment group. Must be between the minimum and maximum payment group duration.

The midpoint date and time of the payment group for reminder purposes. Must be before the expiration date.

The ID of the payment intent associated with this payment group. This field is required and must be a valid payment intent ID.

bearer

Understand general concepts, base url, and mode.

Introduction

Authentification

Troubleshoot problems with this comprehensive breakdown of all error codes.

Errors

Understand how to manipulate object and collection with parameters

Request parameters


      Retrieves a list of all payment intents for the specified organization and livemode. 
      This endpoint supports filtering, sorting, and pagination through query parameters.
    

List payments


      Creates a new payment intent for the specified organization and livemode. 
 
      It processes the provided data and stores the payment intent details.
    

Create payment


      Fetches the details of a specific payment intent using its unique identifier. 
      This endpoint supports both KohortPay and KohortRef, allowing retrieval of detailed payment intent information for further processing or auditing.
    

Retrieve payment


      Cancels a specific payment intent using its unique identifier. 
      This endpoint is applicable for both KohortPay and KohortRef, allowing you to invalidate a payment intent before processing completes.
    

Cancel payment


      Retrieves all payment groups for the specified organization and livemode. 
      This endpoint supports filtering, sorting, and pagination through query parameters.
    

List payment groups


      Creates a new payment group for the specified organization and livemode. 
      This endpoint allows the creation of a payment group with associated metadata, 
      expiration time, and customer information.
    

Create payment group


      Retrieves the details of a specific payment group using its unique identifier. 
      This endpoint supports both standard and share IDs, allowing retrieval of detailed 
      payment group information for further processing or auditing.
    

Retrieve payment group


      Updates the details of an existing payment group using its unique identifier. 
      This endpoint allows updating metadata and other properties of the payment group.
    

Update payment group


      Cancels an existing payment group using its unique identifier. 
      This endpoint marks the payment group as canceled and prevents further actions.
    

Cancel payment group


      Expires an existing payment group using its unique identifier. 
      This endpoint marks the payment group as expired and prevents further actions.
    

Expire payment group


      Validates an existing payment group using its unique identifier. 
      This endpoint ensures that the payment group meets all necessary criteria for validation.
    

Validate payment group

Retrieves a list of all customers for the specified organization and livemode. Supports filtering, sorting, and pagination.

List customers

Creates a new customer for the specified organization and livemode.

Create customer

Retrieves the details of a specific customer using their unique identifier.

Retrieve customer

Deletes a specific customer from the system by their unique identifier. This action is irreversible.

Delete customer

Updates the details of an existing customer.

Update customer

Blocks a specific customer, preventing further actions.

Block customer

Unblocks a specific customer, allowing further actions.

Unblock customer

Retrieves a list of all checkout sessions for the specified organization and livemode. This endpoint is used for both KohortPay and KohortRef. For KohortPay, the sessions include the platform’s own payment methods. For KohortRef, sessions use existing brand payment methods.

List sessions

Creates a new checkout session for both KohortPay and KohortRef. For KohortPay, the platform provides its own payment methods. For KohortRef, existing brand payment methods are used.

Create session


      Retrieves a specific checkout session by its ID for the given organization and livemode. 
    

Retrieve session

Expires a checkout session for the specified organization and livemode. This endpoint is used for both KohortPay and KohortRef.

API Reference

Payments

Payment Groups

Customers

Checkout sessions

Retrieve participants

Authorizations

Path Parameters

Response