Retrieve 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.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
Fields to expand related entities. For example, ["organization"].
Maximum number of items to retrieve. Default is 25.
Number of items to skip before starting to collect the result set.
Field to order the results by, followed by ":asc" or ":desc". For example, "createdAt:desc".
Search term to filter the results. Supports multiple terms with "~" for partial matches.
Query parameters for additional filtering, sorting, and expansion.
Response
The ID of the customer. This field is required and must be a valid customer ID.
The ID of the payment intent associated with this payment group. This field is required and must be a valid payment intent ID.
Additional metadata for the payment group. This can include any additional information needed to process the payment group.
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.