Validate a group
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Unique group ID
Body
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.
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.
Response
The id of the group.
The shared identifier of the group. If null, it will create a group. If not null, it will join the group.
Wether the order is in live mode or test mode.
The id of the organization.
The id of the customer.
The email of the creator of the group.
The status of the group.
OPEN
, COMPLETED
, CANCELED
, EXPIRED
Additional metadata for the order.
The reminder email sent status of the group.
NOT_SENT
, MIDWAY_SENT
, DAY3_SENT
, DAY2_BEFORE_END_SENT
The id of the user who created the customer.
The id of the user who last updated the customer.