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
  • Return: array

Parameters

Name Type Default Set Range Description
$trans_expecting_id ID_TEXT required parameter N/A N/A The transaction ID we have generated for this transaction
$cardholder_name SHORT_TEXT required parameter N/A N/A Cardholder name
$card_type SHORT_TEXT required parameter N/A N/A Card Type
$card_number SHORT_TEXT required parameter N/A N/A Card number
$card_start_date SHORT_TEXT required parameter N/A N/A Card Start date (blank: none)
$card_expiry_date SHORT_TEXT required parameter N/A N/A Card Expiry date (blank: none)
$card_cv2 SHORT_TEXT required parameter N/A N/A Card CV2 number (security number)
$amount float required parameter N/A N/A Transaction amount
$currency ID_TEXT required parameter N/A N/A The currency to use
$billing_street_address LONG_TEXT required parameter N/A N/A Street address (billing, i.e. AVS)
$billing_city SHORT_TEXT required parameter N/A N/A Town/City (billing, i.e. AVS)
$billing_county SHORT_TEXT required parameter N/A N/A County (billing, i.e. AVS)
$billing_state SHORT_TEXT required parameter N/A N/A State (billing, i.e. AVS)
$billing_post_code SHORT_TEXT required parameter N/A N/A Postcode/Zip (billing, i.e. AVS)
$billing_country SHORT_TEXT required parameter N/A N/A Country (billing, i.e. AVS)
$shipping_firstname SHORT_TEXT Blank (empty string) N/A N/A First name (shipping)
$shipping_lastname SHORT_TEXT Blank (empty string) N/A N/A Last name (shipping)
$shipping_street_address LONG_TEXT Blank (empty string) N/A N/A Street address (shipping)
$shipping_city SHORT_TEXT Blank (empty string) N/A N/A Town/City (shipping)
$shipping_county SHORT_TEXT Blank (empty string) N/A N/A County (shipping)
$shipping_state SHORT_TEXT Blank (empty string) N/A N/A State (shipping)
$shipping_post_code SHORT_TEXT Blank (empty string) N/A N/A Postcode/Zip (shipping)
$shipping_country SHORT_TEXT Blank (empty string) N/A N/A Country (shipping)
$shipping_email SHORT_TEXT Blank (empty string) N/A N/A E-mail address (shipping)
$shipping_phone SHORT_TEXT Blank (empty string) N/A N/A Phone number (shipping)
$length ?integer Null N/A N/A The subscription length in the units. (null: not a subscription)
$length_units ?ID_TEXT Null N/A N/A The length units. (null: not a subscription)

Return

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