Function __global->get_transaction_form_fields
Definitions
sources/ecommerce.php
- Get a form for transacting local payments.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $type_code | ID_TEXT | required parameter | N/A | N/A | The product codename |
| $item_name | SHORT_TEXT | required parameter | N/A | N/A | The item name |
| $purchase_id | ID_TEXT | required parameter | N/A | N/A | The purchase ID |
| $price | REAL | required parameter | N/A | N/A | Transaction price in money (excluding tax and shipping) |
| $tax_derivation | array | required parameter | N/A | N/A | Transaction tax derivation |
| $tax | REAL | required parameter | N/A | N/A | Transaction tax in money (including shipping tax) |
| $tax_tracking | array | required parameter | N/A | N/A | Transaction tax tracking ID |
| $shipping_cost | REAL | required parameter | N/A | N/A | Transaction shipping cost in money |
| $shipping_tax | REAL | required parameter | N/A | N/A | Transaction shipping tax in money |
| $currency | ID_TEXT | required parameter | N/A | N/A | The currency to use |
| $price_points | integer | required parameter | N/A | N/A | Transaction price in points (only for first transaction) |
| $length | ?integer | required parameter | N/A | N/A | The length (null: not a subscription) |
| $length_units | ID_TEXT | required parameter | N/A | N/A | The length units |
| $payment_gateway | ?ID_TEXT | Null | N/A | N/A | The payment gateway the payment will go via (null: autodetect) |
| $needs_shipping_address | boolean | False | N/A | N/A | Whether a shipping address is needed |
Return
- A tuple: The form fields, Hidden fields, Confidence logos, Payment processor links
- Type: array
- Set: N/A
- Range: N/A