# amwal-pos



<!-- Auto Generated Below -->


## Properties

| Property                   | Attribute                     | Description                                                                          | Type      | Default                           |
| -------------------------- | ----------------------------- | ------------------------------------------------------------------------------------ | --------- | --------------------------------- |
| `addressRequired`          | `address-required`            | Address and payment options                                                          | `boolean` | `false`                           |
| `amount`                   | `amount`                      | The current amount entered                                                           | `string`  | `''`                              |
| `apiBaseUrl`               | `api-base-url`                | API base URL                                                                         | `string`  | `'https://backend.sa.amwal.tech'` |
| `authToken`                | `auth-token`                  | API Authorization token                                                              | `string`  | `''`                              |
| `callbackUrl`              | `callback-url`                | Callback URL for payment completion                                                  | `string`  | `undefined`                       |
| `currency`                 | `currency`                    | The currency used for the transaction.                                               | `"SAR"`   | `undefined`                       |
| `customerCity`             | `customer-city`               |                                                                                      | `string`  | `undefined`                       |
| `customerCountry`          | `customer-country`            |                                                                                      | `string`  | `undefined`                       |
| `customerEmail`            | `customer-email`              |                                                                                      | `string`  | `undefined`                       |
| `customerFirstName`        | `customer-first-name`         | Customer information                                                                 | `string`  | `undefined`                       |
| `customerLastName`         | `customer-last-name`          |                                                                                      | `string`  | `undefined`                       |
| `customerPhone`            | `customer-phone`              |                                                                                      | `string`  | `undefined`                       |
| `customerPostcode`         | `customer-postcode`           |                                                                                      | `string`  | `undefined`                       |
| `customerState`            | `customer-state`              |                                                                                      | `string`  | `undefined`                       |
| `customerStreet1`          | `customer-street-1`           | Customer address information                                                         | `string`  | `undefined`                       |
| `customerStreet2`          | `customer-street-2`           |                                                                                      | `string`  | `undefined`                       |
| `debug`                    | `debug`                       | Enable debug mode for additional console logs                                        | `boolean` | `false`                           |
| `locale`                   | `locale`                      | The language of the plugin. Supported languages are Arabic ("ar") and English ("en") | `string`  | `'en'`                            |
| `maxAmount`                | `max-amount`                  | Maximum amount allowed                                                               | `number`  | `999999`                          |
| `metadata`                 | `metadata`                    | Custom metadata for the transaction                                                  | `string`  | `undefined`                       |
| `minAmount`                | `min-amount`                  | Minimum amount allowed                                                               | `number`  | `1`                               |
| `onlyShowBankInstallments` | `only-show-bank-installments` |                                                                                      | `boolean` | `false`                           |
| `onlyShowPayInFull`        | `only-show-pay-in-full`       |                                                                                      | `boolean` | `false`                           |
| `passkeyEnabled`           | `passkey-enabled`             |                                                                                      | `boolean` | `false`                           |
| `paymentDescription`       | `payment-description`         | Custom description for payment                                                       | `string`  | `undefined`                       |
| `paymentTitle`             | `payment-title`               | Custom title for payment                                                             | `string`  | `undefined`                       |
| `sendSms`                  | `send-sms`                    |                                                                                      | `boolean` | `false`                           |
| `smsLanguage`              | `sms-language`                |                                                                                      | `string`  | `undefined`                       |
| `storeId`                  | `store-id`                    | Store ID for API calls                                                               | `string`  | `''`                              |


----------------------------------------------

*Built with [StencilJS](https://stenciljs.com/)*
