payment_methods
Generate a list of active payment methods
Example
[%payment_methods%]
[%param *header%]
<h4>Payment Methods</h4>
[%/param%]
[%param *body%]
<p>[@name@]</p>
[%/param%]
[%param *footer%]
[%/param%]
[%/payment_methods%]Usage
The payment_methods tag generates a list of active payment methods as defined by the control panel. This can be used to either generate a list of icons like we do by default in the footer, or present a list of options the customer can interact with during checkout.
Parameters
| Name | Options | Description |
|---|---|---|
| type:'' | String | Specifies which type of payment types to print |
| id:'' | Integer | Specific ID number of the payment method |
| sortby:'' | `sortorder`, `name` | Determines what to sort the payment methods by |
| charge_type:'' | `acc`, `acccredit`, `bank`, `bpay`, `cc`, `web` | `acc` - Customer Account Credit `acccredit` - Customer Commission Credit `bank` - Bank Cheque, Bank Deposit `bpay` - Bpay (electronic bill payment system) `cc` - Credit Card `web` - AfterPay, PayPal Express, Stripe, zipPay |
| show_account:'' | `1`/`0` | A boolean that when set to true |
| repeat_only:'' | `1`/`0` | A boolean that when set to true |
| no_surcharge:'' | `1`/`0` | If `1`, hide payment method if it has a surcharge |
| group_id:'' | Customer Group ID | When specified the payment methods displayed will be limited what is visible for that group. Setting to `-1` will display all payment methods no matter if it has been assigned to that group |
| ifempty:'' | HTML & b@se tags | If their are no active payment methods this block is printed in place of the `header`, `body` & `footer` |
| *header | HTML & b@se tags | Renders a single usable space above the body |
| *body | HTML & b@se tags | Runs an array for each option in the tag |
| *footer | HTML & b@se tags | Renders a single usable space below the body |
Data Tags (header/footer)
| Data Tag | Example | Description |
|---|---|---|
| `[@total@]`, `[@total_showing@]` | 7 | Total number of payment methods displayed |
payment_methods Data Tags
| Data Tag | Payment Field | Example | Description |
|---|---|---|---|
| `[@allow_preauth@]` | – | 0 | Allows pre-authorisation |
| `[@charge_type@]` | – | cc | Type of payment method. Options: acc, acccredit, bank, bpay, cc, web |
| `[@count@]` | – | 0 | An automatically increasing count with each run of the `body` param |
| `[@currency_code@]` | Currency | AUD | The currency the payment method uses |
| `[@id@]` | – | 0 | The unique ID for the payment method |
| `[@is_preauth@]` | – | 0 | Is pre-authorised |
| `[@is_repeat_payment@]` | – | 0 | Is pre-authorised |
| `[@max_balance@]` | Max Spend | 1000 | Maximum amount that this payment method accepts |
| `[@min_balance@]` | Min Spend | 0 | Minimum amount that this payment method accepts |
| `[@name@]` | Name | Visa | Name of the payment method |
| `[@payment_desc_type@]` | – | visa | The short description type of payment |
| `[@payment_desc_type_count@]` | – | 0 | An automatically increasing count for each **payment_desc_type** |
| `[@payment_description@]` | Checkout description | You will be prompted for your card details at the next step of checkout. | This message appears to customers when they select this payment option at checkout |
| `[@processor_icon_type@]` | – | visa | Payment processor icon. Options: afterpay-1, cheque, directdeposit, mastercard, paypal, visa, zippay |
| `[@processor_icon_url@]` | – | https://cdn.neto.com.au/assets/neto-cdn/payment-icons/1.0.0/visa.svg | Web address of the payment processor icon |
| `[@repeat_pay@]` | – | n | `y` or `n` value depending on whether that payment type supports repeat billing |
| `[@sortorder@]` | Sort order | 9 | Sort order of the payment method (descending) |
| `[@use_store_card@]` | – | n | if `y`, payment method can used with 'stored credit card' (i.e. token) |