| Property | Description | Returns |
|---|---|---|
| type | string | |
| currencyCode | Returns the ISO 4217 currency code configured for this element (e.g. 'USD'). | string |
| currency | Returns the currency object configured for this element. | Currency |
| amounts | Returns the preset payment amounts configured for this element, hydrated as major-unit decimal strings. | array |
| amountsAsMoney | Returns the preset payment amounts configured for this element, hydrated as Money objects. | array |
| settings | array | |
| mode | Returns the payment capture mode: 'authorizeCapture' or 'authorizeOnly'. | string |
| paymentMethodIds | Returns the IDs of the payment methods configured for this element. | array |
| taxCategoryId | Returns the tax category ID configured for this element, if any. | int |
| allowCustomAmount | Returns whether the user is permitted to enter a custom payment amount. | bool |
| entity | string | |
| id | int | |
| name | Gets element name. It could be used in html to identify input, e.g. ' '. | string |
| help | Gets help text for the element. It could be used as a tooltip or in HTML as a title attribute, e.g. ' '. | string |
| editor | string | |
| text | Text for the element that usually is used for element's label | string |
| defaultValue | string | |
| placeholder | string | |
| required | bool | |
| regex | string | |
| position | int | |
| revision | FormRevision | |
| step | Step | |
| validationRules | Collection (ValidationRule) | |
| validationConditions | Collection (ValidationCondition) | |
| parent | ElementGroup | |
| elementId | string |
Forms\Models\Api\PaymentElement
Entity for collecting payment