Function Hook_payment_gateway_authorize->do_local_transaction

Definitions

sources/hooks/systems/payment_gateway/authorize.php

  • Perform a local transaction (a transaction where details are taken in locally and sent to the payment API invisibly-to-the-user).
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$trans_expecting_id ID_TEXT No No required parameter N/A N/A The transaction ID we have generated for this transaction
$cardholder_name SHORT_TEXT No No required parameter N/A N/A Cardholder name
$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)
$amount float No No required parameter N/A N/A Transaction amount
$currency ID_TEXT No No required parameter N/A N/A The currency to use
$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_county SHORT_TEXT No No required parameter N/A N/A County (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 Blank (empty string) N/A N/A First name (shipping)
$shipping_lastname SHORT_TEXT No No Blank (empty string) N/A N/A Last name (shipping)
$shipping_street_address LONG_TEXT No No Blank (empty string) N/A N/A Street address (shipping)
$shipping_city SHORT_TEXT No No Blank (empty string) N/A N/A Town/City (shipping)
$shipping_county SHORT_TEXT No No Blank (empty string) N/A N/A County (shipping)
$shipping_state SHORT_TEXT No No Blank (empty string) N/A N/A State (shipping)
$shipping_post_code SHORT_TEXT No No Blank (empty string) N/A N/A Postcode/Zip (shipping)
$shipping_country SHORT_TEXT No No Blank (empty string) N/A N/A Country (shipping)
$shipping_email SHORT_TEXT No No Blank (empty string) N/A N/A E-mail address (shipping)
$shipping_phone SHORT_TEXT No No Blank (empty string) N/A N/A Phone number (shipping)

Returns

  • A tuple: success (boolean), message (string), raw message (string), transaction ID (string)
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Perform a local transaction (a transaction where details are taken in locally and sent to the payment API invisibly-to-the-user).
 *
 * @param  ID_TEXT $trans_expecting_id The transaction ID we have generated for this transaction
 * @param  SHORT_TEXT $cardholder_name Cardholder name
 * @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  float $amount Transaction amount
 * @param  ID_TEXT $currency The currency to use
 * @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_county County (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_county County (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)
 * @param  SHORT_TEXT $shipping_phone Phone number (shipping)
 * @return array A tuple: success (boolean), message (string), raw message (string), transaction ID (string)
 */
public function do_local_transaction(string $trans_expecting_id, string $cardholder_name, string $card_type, string $card_number, string $card_start_date, string $card_expiry_date, string $card_cv2, float $amount, string $currency, string $billing_street_address, string $billing_city, string $billing_county, 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_county = '', string $shipping_state = '', string $shipping_post_code = '', string $shipping_country = '', string $shipping_email = '', string $shipping_phone = '') : array