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
$length ?integer No No Null N/A N/A The subscription length in the units. (null: not a subscription)
$length_units ?ID_TEXT No No Null d w m y N/A The length units. (null: not a subscription)

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  ?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
 * @return array A tuple: success (boolean), message (string), raw message (string), transaction ID (string)
 */
public function do_local_transaction(?int $length = null, ?string $length_units = null) : array