Function Hook_payment_gateway_authorize->_set_arb_parameters
Definitions
sources/hooks/systems/payment_gateway/authorize.php
- This function defines the parameters needed to make an ARB (Automated Recurring Billing) call.
- Visibility: protected
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $card_type | SHORT_TEXT | No | No | required parameter | "Visa" "Master Card" "Switch" "UK Maestro" "Maestro" "Solo" "Delta" "American Express" "Diners Card" "JCB" | N/A | Card Type |
| $card_number | SHORT_TEXT | No | No | required parameter | N/A | N/A | Card number |
| $card_start_date | SHORT_TEXT | No | No | required parameter | N/A | N/A | Card Start date (blank: none) |
| $card_expiry_date | SHORT_TEXT | No | No | required parameter | N/A | N/A | Card Expiry date (blank: none) |
| $card_cv2 | SHORT_TEXT | No | No | required parameter | N/A | N/A | Card CV2 number (security number) |
| $start_date | SHORT_TEXT | No | No | required parameter | N/A | N/A | Start date |
| $length | ?integer | No | No | required parameter | N/A | N/A | The subscription length in the units. (null: not a subscription) |
| $length_units | ?ID_TEXT | No | No | required parameter | d w m y | N/A | The length units. (null: not a subscription) |
| $trans_expecting_id | ID_TEXT | No | No | required parameter | N/A | N/A | Transaction ID |
| $amount | float | No | No | required parameter | N/A | N/A | Transaction amount |
| $billing_firstname | SHORT_TEXT | No | No | required parameter | N/A | N/A | Cardholder first name |
| $billing_lastname | SHORT_TEXT | No | No | required parameter | N/A | N/A | Cardholder last name |
| $billing_street_address | LONG_TEXT | No | No | required parameter | N/A | N/A | Street address (billing, i.e. AVS) |
| $billing_city | SHORT_TEXT | No | No | required parameter | N/A | N/A | Town/City (billing, i.e. AVS) |
| $billing_state | SHORT_TEXT | No | No | required parameter | N/A | N/A | State (billing, i.e. AVS) |
| $billing_post_code | SHORT_TEXT | No | No | required parameter | N/A | N/A | Postcode/Zip (billing, i.e. AVS) |
| $billing_country | SHORT_TEXT | No | No | required parameter | N/A | N/A | Country (billing, i.e. AVS) |
| $shipping_firstname | SHORT_TEXT | No | No | required parameter | N/A | N/A | First name (shipping) |
| $shipping_lastname | SHORT_TEXT | No | No | required parameter | N/A | N/A | Last name (shipping) |
| $shipping_street_address | LONG_TEXT | No | No | required parameter | N/A | N/A | Street address (shipping) |
| $shipping_city | SHORT_TEXT | No | No | required parameter | N/A | N/A | Town/City (shipping) |
| $shipping_state | SHORT_TEXT | No | No | required parameter | N/A | N/A | State (shipping) |
| $shipping_post_code | SHORT_TEXT | No | No | required parameter | N/A | N/A | Postcode/Zip (shipping) |
| $shipping_country | SHORT_TEXT | No | No | required parameter | N/A | N/A | Country (shipping) |
| $shipping_email | SHORT_TEXT | No | No | required parameter | N/A | N/A | E-mail address (shipping) |
Preview
Code (PHP)
/**
* This function defines the parameters needed to make an ARB (Automated Recurring Billing) call.
*
* @param SHORT_TEXT $card_type Card Type
* @set "Visa" "Master Card" "Switch" "UK Maestro" "Maestro" "Solo" "Delta" "American Express" "Diners Card" "JCB"
* @param SHORT_TEXT $card_number Card number
* @param SHORT_TEXT $card_start_date Card Start date (blank: none)
* @param SHORT_TEXT $card_expiry_date Card Expiry date (blank: none)
* @param SHORT_TEXT $card_cv2 Card CV2 number (security number)
* @param SHORT_TEXT $start_date Start date
* @param ?integer $length The subscription length in the units. (null: not a subscription)
* @param ?ID_TEXT $length_units The length units. (null: not a subscription)
* @set d w m y
* @param ID_TEXT $trans_expecting_id Transaction ID
* @param float $amount Transaction amount
* @param SHORT_TEXT $billing_firstname Cardholder first name
* @param SHORT_TEXT $billing_lastname Cardholder last name
* @param LONG_TEXT $billing_street_address Street address (billing, i.e. AVS)
* @param SHORT_TEXT $billing_city Town/City (billing, i.e. AVS)
* @param SHORT_TEXT $billing_state State (billing, i.e. AVS)
* @param SHORT_TEXT $billing_post_code Postcode/Zip (billing, i.e. AVS)
* @param SHORT_TEXT $billing_country Country (billing, i.e. AVS)
* @param SHORT_TEXT $shipping_firstname First name (shipping)
* @param SHORT_TEXT $shipping_lastname Last name (shipping)
* @param LONG_TEXT $shipping_street_address Street address (shipping)
* @param SHORT_TEXT $shipping_city Town/City (shipping)
* @param SHORT_TEXT $shipping_state State (shipping)
* @param SHORT_TEXT $shipping_post_code Postcode/Zip (shipping)
* @param SHORT_TEXT $shipping_country Country (shipping)
* @param SHORT_TEXT $shipping_email E-mail address (shipping)
*/
protected function _set_arb_parameters(string $card_type, string $card_number, string $card_start_date, string $card_expiry_date, string $card_cv2, string $start_date, ?int $length, ?string $length_units, string $trans_expecting_id, float $amount, string $billing_firstname, string $billing_lastname, string $billing_street_address, string $billing_city, string $billing_state, string $billing_post_code, string $billing_country, string $shipping_firstname, string $shipping_lastname, string $shipping_street_address, string $shipping_city, string $shipping_state, string $shipping_post_code, string $shipping_country, string $shipping_email)
* This function defines the parameters needed to make an ARB (Automated Recurring Billing) call.
*
* @param SHORT_TEXT $card_type Card Type
* @set "Visa" "Master Card" "Switch" "UK Maestro" "Maestro" "Solo" "Delta" "American Express" "Diners Card" "JCB"
* @param SHORT_TEXT $card_number Card number
* @param SHORT_TEXT $card_start_date Card Start date (blank: none)
* @param SHORT_TEXT $card_expiry_date Card Expiry date (blank: none)
* @param SHORT_TEXT $card_cv2 Card CV2 number (security number)
* @param SHORT_TEXT $start_date Start date
* @param ?integer $length The subscription length in the units. (null: not a subscription)
* @param ?ID_TEXT $length_units The length units. (null: not a subscription)
* @set d w m y
* @param ID_TEXT $trans_expecting_id Transaction ID
* @param float $amount Transaction amount
* @param SHORT_TEXT $billing_firstname Cardholder first name
* @param SHORT_TEXT $billing_lastname Cardholder last name
* @param LONG_TEXT $billing_street_address Street address (billing, i.e. AVS)
* @param SHORT_TEXT $billing_city Town/City (billing, i.e. AVS)
* @param SHORT_TEXT $billing_state State (billing, i.e. AVS)
* @param SHORT_TEXT $billing_post_code Postcode/Zip (billing, i.e. AVS)
* @param SHORT_TEXT $billing_country Country (billing, i.e. AVS)
* @param SHORT_TEXT $shipping_firstname First name (shipping)
* @param SHORT_TEXT $shipping_lastname Last name (shipping)
* @param LONG_TEXT $shipping_street_address Street address (shipping)
* @param SHORT_TEXT $shipping_city Town/City (shipping)
* @param SHORT_TEXT $shipping_state State (shipping)
* @param SHORT_TEXT $shipping_post_code Postcode/Zip (shipping)
* @param SHORT_TEXT $shipping_country Country (shipping)
* @param SHORT_TEXT $shipping_email E-mail address (shipping)
*/
protected function _set_arb_parameters(string $card_type, string $card_number, string $card_start_date, string $card_expiry_date, string $card_cv2, string $start_date, ?int $length, ?string $length_units, string $trans_expecting_id, float $amount, string $billing_firstname, string $billing_lastname, string $billing_street_address, string $billing_city, string $billing_state, string $billing_post_code, string $billing_country, string $shipping_firstname, string $shipping_lastname, string $shipping_street_address, string $shipping_city, string $shipping_state, string $shipping_post_code, string $shipping_country, string $shipping_email)
