Function Hook_payment_gateway_authorize->store_shipping_address

Definitions

sources/hooks/systems/payment_gateway/authorize.php

  • Store shipping address for a transaction.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: int

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$trans_expecting_id ID_TEXT No No required parameter N/A N/A Expected transaction ID
$txn_id ID_TEXT No No required parameter N/A N/A Transaction ID

Returns

  • Address ID
  • Type: AUTO_LINK
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Store shipping address for a transaction.
 *
 * @param  ID_TEXT $trans_expecting_id Expected transaction ID
 * @param  ID_TEXT $txn_id Transaction ID
 * @return AUTO_LINK Address ID
 */
public function store_shipping_address(string $trans_expecting_id, string $txn_id) : int