Webhook Events

Webhook Events: Properties and descriptions

Definitions for the properties of the webhook events you may receive, along with summaries of the specific message types and when they would be triggered, may be found below. Purchase events are notifications related to the payments you make to suppliers with cards or ACHs created by the Issuing API calls or ConnexPay's Bridge UI (User Interface) and samples of the respective messages can be found here and here, while references for the events related to payouts made through our Push to Card functionality are located here. Sale events are triggered by the processing of transactions from your consumers' credit cards or ACHs with the ConnexPay Sales APIs and those samples are located here. Lastly, examples of the notifications for Funding events will be here.

Every webhook notification delivered by CXP eventing will pass a common set of fields within its body, as noted in the below table. The specific elements within the data payload may vary based on the type of event being described and will be outlined with the message samples.

Purchase Property	Description
id	Globally unique identifier (GUID) of the webhook event
subject	Your assigned Merchant GUID or parent organization GUID
data	Subsection of the notification containing relevant descriptions and identifiers,
eventType	Type of event
eventTime	Time of event received at CXP Eventing
dataVersion	Current schema version

Purchase Events

Purchase Card Events

Purchase Card Events are the notifications related to the issuing or modification of virtual, lodge, and physical credit cards to complete a payment to your supplier. An incomingTransactionCode token will be presented in these events to link to the associated sale. The possible events are as follows:

Purchase Card Event	When it occurs and important notes
purchase.card.issued	A card has been successfully issued
purchase.card.terminated	A card has been successfully terminated
purchase.card.adjusted	A card has been adjusted, such as changing the reload amount or the purchase type

Purchase Transactions Events

Purchase Transaction Events are related to these created cards, but specific to their interactions at the transaction level. The bolded events below are the ones most commonly occurring and tracked by ConnexPay clients. In addition, the following notes are applicable to all of the purchase card events:

• The cardGUID value for the issued purchase card will be present for linking back to your system of record. • A precedingRelatedToken GUID will be included for events that follow in succession from a prior event, such as the settlement of a previous successful authorization. • The remaining amount on the card that may be used for additional authorizations as a result of the event is contained in the availableBalance field.

Purchase Transaction Event	When it occurs and important notes
purchase.card.auth.approved	A card authorization attempt has been approved. When a supplier receives a card for payment, they will attempt to authorize the transaction amount and based on rules and settings it may be approved. • Labeled as Type "authorization" with a Status of "Pending" in ConnexPay Bridge. • The amount approved for authorization will be deducted from the available to authorize amount for that card and overall program (if ATA), until authorization expiration or settlement is received. The remaining amount on the card that may be used for additional authorizations is also contained in the availableBalance field.
purchase.card.auth.declined	A card authorization attempt has been declined. When a supplier receives a card for payment, they will attempt to authorize the transaction amount and based on rules and settings it may be declined. • Labeled as Type "authorization" with a Status of "Declined" in ConnexPay Bridge. • An authMessage field will pass the description of the decline reasoning.
purchase.card.auth.reversal.settled	A previously approved authorization has been voided by the supplier prior to completing the settlement process. • Labeled as Type "authorization.reversal" with a Status of "Cleared" in ConnexPay Bridge.
purchase.card.auth.reversal.issuerexpiration	A previously approved card authorization has expired due to no settlement or reversal being received. • Labeled as Type "authorization.reversal.issuerexpiration" with a Status of "Cleared" in ConnexPay Bridge.. • If a card has been manually terminated prior to the expiration event, the notification will not be sent.
purchase.card.auth.settled	A settlement for fully processing a transaction on a card has been received. • Labeled as Type "authorization.clearing" with a Status of "Completion" in ConnexPay Bridge. • The settlement amount replaces the authorized amount for calculating the available to authorize amount for that card (and overall program if ATA).
purchase.card.return.auth.declined	An attempt to return funds to a card after settlement occurred has been rejected. • Labeled as Type "refund.authorization" with a Status of "Declined" in ConnexPay Bridge.
purchase.card.return.auth.approved	An attempt to return funds to a card after settlement occurred has been approved but not yet completed. • Labeled as Type "refund.authorization" with a Status of "Pending" in ConnexPay Bridge.
purchase.card.return.auth.settled	An attempt to return funds to a card after settlement occurred has been approved and completed. • Labeled as Type "refund.authorization.clearing" with a Status of "Completion" in ConnexPay Bridge.
purchase.card.return.auth.reversal.settled	The approval of an attempt to return funds to a card after settlement occurred has been reversed. • Labeled as Type "refund.authorization.reversal" with a Status of "Cleared" in ConnexPay Bridge.
purchase.card.blacklist.added	An account has successfully been added to the stop payment service.
purchase.card.blacklist.pending	An account is pending being added to the stop payment service.
purchase.card.blacklist.removed	An account has been removed from the stop payment service.
purchase.card.blacklist.updated	An account has been updated on the stop payment service.

Push to Card Events

Push to Card Events relate to the creation and administration of payments made to recipients through Push to Card functionality. The following event types are supported:

Push to Card Events	When it occurs and important notes
purchase.card.payout.approved	A Push to Card payout has been created.
purchase.card.payout.cancelled	All payments within a payout have been deactivated/canceled.
purchase.card.payment.deactivated	An individual payment within a payout has been canceled.
purchase.card.payment.expired	An individual payment within a payout has expired.
purchase.card.payment.payout	An individual payment within a payout has been successfully claimed by the recipient.
purchase.card.payment.failed	An individual payment within a payout failed at time of disbursement (card expired / do not honor)

Purchase ACH Events

Purchase ACH Events are triggered when ACH is used as the method of payment at the individual transaction level. The following is applicable to all of the purchase ACH events in the table further below:

• A paymentGUID value for the ACH payment will be present for tracking purposes.
• An incomingTransactionCode token will be present to link to the associated sale.

Purchase ACH Events	When it occurs and important notes
purchase.ach.pending	An ACH purchase is created.
purchase.ach.notyetprocessed	An ACH purchase transaction has not yet begun to be processed
purchase.ach.processing	An ACH transaction is currently processing. ACH transactions are briefly in this status when the batches are processed each afternoon.
purchase.ach.processed	An ACH transaction has been successfully processed.
purchase.ach.cancelled	An ACH purchase transaction has been cancelled.
purchase.ach.noc	An ACH Notice of Change has been received. A Notice of Change occurs when previously valid ACH information has become outdated and must be updated for future requests.

Sale Events

Sale Card Events

Sale Card Events are the notifications created during the processing of your consumers' credit cards (including payments made with ApplePay and GooglePay) with ConnexPay and our Sales APIs. The events that may occur are:

Sale Card Event	When it occurs and important notes
sale.card.auth.approved	A card authorization in your sale processing has been approved.
sale.card.authonly.approved	A card authorization only in your sale processing has been approved.
sale.card.auth.declined	A card authorization in your sale processing has been declined.
sale.card.auth.voided	A previously approved card authorization in the processing of your sale has been voided.
sale.card.authonly.voided	A previously approved card authorization only in the processing of your sale has been voided.
sale.card.return.auth.approved	An attempted return of a prior card authorization in your sale processing has been approved.

Sale 3DS Events

Sale 3DS Events are the notifications created during 3DS authentication in the processing of your consumers' credit cards (including payments made with ApplePay and GooglePay)with ConnexPay and our Sales APIs. The events that may occur are:

Sale Card Event	When it occurs and important notes
sale.3ds.approved	A 3ds authentication during your sale processing has been approved.
sale.3ds.pending.fingerprint	A 3ds authentication during your sale processing is pending a device fingerprint validation.
sale.3ds.pending.challenge	A 3ds authentication during your sale processing is pending a cardholder challenge.
sale.3ds.declined	A 3ds authentication during your sale processing has been declined.

Sale ACH Events

Sale ACH Events are the notifications created during the processing of your consumers' ACH payments with ConnexPay and our Sales APIs. The events that may occur are:

Event	Triggered when...
sale.ach.pending	The immediate status when an ACH payment is created.
sale.ach.processed	The payment has been successfully processed
sale.ach.processing	An ACH payment is currently processing. ACH transactions may be in this state briefly as ACH batches are processed.
sale.ach.return.pending	The immediate status when an ACH return is created.
sale.ach.return.processed	The return has been successfully processed
sale.ach.return.denied	ACH return denied by ConnexPay's processor, typically because the bank account is no longer a valid account.
sale.ach.return.pendingpayment	The return is waiting on a payment method / funding source to continue - should not see
sale.ach.return.processing	An ACH return is currently processing. ACH return transactions may be in this state briefly as ACH batches are processed.

Funding Events

Event	Triggered when...
sale.cash.balance.funding	An event is processed to withdraw or deposit funds with your merchant cash balance.