Properties
| Name | Type | Required | Description |
|---|---|---|---|
| amount | float |
❌ | 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_to_replace | float |
❌ | Indicates the total amount of failed payments that have not been replaced. Response only. |
| cancel_reason | str |
❌ | Reason for cancellation of the group payment. Response only. |
| country | str |
❌ | Country where the payment methods are supported. Two-letter ISO 3166-1 ALPHA-2 code. Response only. |
| currency | str |
❌ | Currency of the payments. Three-letter ISO 4217 code. |
| description | str |
❌ | Description of the group payment. |
| expiration | float |
❌ | End of the time allowed for customers to make this payment, in Unix time. Response only. |
| id_ | str |
❌ | ID of the Group Payment object. String starting with gp_. |
| merchant_reference_id | str |
❌ | Merchant-defined ID. Limited to 255 characters. |
| metadata | dict |
❌ | A JSON object defined by the client. |
| payments | List[Payment] |
❌ | |
| status | str |
❌ | Indicates the status of the group payment operation |