shopp_{gateway}_{event}

called when a new OrderEvent is created for a particular payment gateway.

add_action( 'shopp_{gateway}_{event}', [callback] );

@param OrderEventMessage $Msg the OrderEventMessage object generating the event

Description

called when a new OrderEvent is created for a particular payment gateway.

Built-in order events

  • authAuthOrderEvent triggers the gateway to initiate a payment authorization.
  • authedAuthedOrderEvent triggered by the gateway to indicate a successful payment authorization.
  • rebillRebillOrderEvent triggered to adjust the running balance for an order to accommodate a new recurring payment event. Debits the order, so the RecapturedOrderEvent can credit the order.
  • auth-failAuthFailOrderEvent triggered by the gateway to indicate a failure to authorize a payment.
  • captureCaptureOrderEvent triggers the gateway to initiate a capture on a previously authorized transaction.
  • capture-failCaptureFailOrderEvent triggered by the gateway on a funds capture failure.
  • capturedCapturedOrderEvent triggered by the gateway to indicate successful funds capture.
  • recapture-failRecaptureFailOrderEvent triggered by the gateway on a funds recapture failure.
  • recapturedRecapturedOrderEvent triggered by the gateway to indicate success funds recapture.
  • refundRefundOrderEvent triggers the gateway to initiate a refund.
  • refund-failRefundFailOrderEvent triggered by the gateway to indicate a refund failure.
  • refundedRefundedOrderEvent triggered by the gateway to indicate a successful refund.
  • voidVoidOrderEvent triggered to indicate a voided order.
  • void-failVoidFailOrderEvent triggered to indicate a void failure.
  • voidedVoidedOrderEvent triggered to indicate a successful voided order.
  • decryptDecryptOrderEvent triggered to indicate payment card decryption has taken place, logging the user account that accessed the information.
  • shippedShippedOrderEvent triggered to indicate that an order shipped.
  • downloadDownloadOrderEvent triggered to indicate that a download asset associated with an order has been downloaded.

The gateway portion of the action is replaced by the lowercase classname of the gateway selected to process the order. For example, the ManualProcessing addon would have actions such as:

  • shopp_manualprocessing_authed
  • shopp_manualprocessing_captured
  • shopp_manualprocessing_refunded
  • shopp_manualprocessing_voided
  • shopp_manualprocessing_decrypt

Example

// add_action('shopp_{gateway}_{action}', 'my_function');
add_action('shopp_manualprocessing_decrypt', 'shopp_mp_decrypt_action');

// the DecryptOrderEvent event object
function shopp_mp_decrypt_action ( $Msg ) {
    // your actions here
}

See Also

You must be logged in to post a comment.

© Ingenesis Limited. Shopp™ is a registered trademark of Ingenesis Limited.

Skip to toolbar