import { Payment } from './Payment'; export interface GroupPayment { /** * ID of the Group Payment object. String starting with **gp_**. */ id: `gp_${string}`; /** * Amount of the group payment, in units defined by `currency`. Decimal, including the correct number of decimal places for the currency exponent, as defined in ISO 2417:2015. If the amount is a whole number, use an integer and not a decimal. */ amount: number; /** * Indicates the total amount of failed payments that have not been replaced. Response only. */ amount_to_replace: string; /** * Reason for cancellation of the group payment. Response only. */ cancel_reason: string; /** * Country where the payment methods are supported. Two-letter ISO 3166-1 ALPHA-2 code. Response only. */ country: string; /** * Country where the payment methods are supported. Two-letter ISO 3166-1 ALPHA-2 code. Response only. */ country_code: string; /** * Currency of the payments. Three-letter ISO 4217 code. */ currency: string; /** * Currency of the payments. Three-letter ISO 4217 code. Response only. */ currency_code: string; /** * Description of the group payment. */ description: string; /** * End of the time allowed for customers to make this payment, in [*Unix time*](ref:glossary). Response only. */ expiration: number; /** * Merchant-defined ID. Limited to 255 characters. */ merchant_reference_id: string; /** * A JSON object defined by the client. */ metadata: object; /** * Array of Payment objects. All payments must have the same currency and must be supported in the same country. * * For more information, see [Payment Object](ref:payment-object). */ payments: (Partial)[]; /** * Reason for cancellation of the group payment. */ reason: string; /** * Indicates the status of the group payment operation. One of the following values: * * **active** - The group payment was created and one or more payments are still open. * * **canceled** - The group payment was canceled. * * **closed** - All payments in the group payment are complete. * * Response only. */ status: 'active' | 'canceled' | 'closed'; } //# sourceMappingURL=GroupPayment.d.ts.map