Webhook Fields for Online Payments in Lighthouse Business Manager

Description: Webhook events are actions that trigger the sending of relevant data. The events are built and maintained by Shift4. 

For an in-depth guide on Online Payments Webhooks, view the Online Payments Webhooks Guide.

---

Webhook Event Fields: Dispute

NAME	TYPE	DESCRIPTION
transactionSequenceNumber	String	• The unique sequence number for the transaction.
acquirerMerchantId	String	• The acquirer's identification number for the merchant.
processingDate	String	• The date that the transaction was processed by the acquirer (format YYYY-MM-DD).
transactionDate	String	• The date that the transaction occurred.
cardExpirationDate	Date	• Expiration date of card (format YYMM).
fundingDate	String	• The date the transaction was paid via ACH (format YYYY-MM-DD).
authCode	String	• The authorization code passed with the settlement record.
transactionTypeCode	String	• Indicates the type of transaction.
posEntryMode	String	• The point of sale entry mode for the transaction.
cardAccountNumber	String	• The masked value of the payment card number used for the transaction.
transactionAmount	Float	• The total amount for the transaction.
authorizedAmount	Float	• The authorized amount for the transaction.
cashbackAmount	Int	• The cashback amount for the transaction.
merchantCategoryCode	String	• The standard industry code for a specific industry or business.
cardBrand	String	• The type of card used in the transaction.
cardProductType	String	• Indicates if the card is credit or debit.
batchNumber	String	• A unique identifier for a given batch for a given customer.
networkReferenceNumber	String	• An identification number for a credit card transaction assigned by the acquirer.
authorizationSource	String	• The given authorization source of the transaction.
authorizationDate	DateTime	• The date the transaction was authorized.

NAME	TYPE	DESCRIPTION
mailPhoneIndicator	String	• Indicates if a transaction is mail order or telephone order.
debitCreditIndicator	String	• Indicates whether the amount is a debit, credit, or non-monetary.
catIndicator	String	• Indicator if the terminal was cardholder activated.
invoiceNumber	String	• Invoice number (if provided by the gateway).
terminalId	String	• Terminal ID (if provided by the gateway).
currencyCode	String	• International standard currency code.
authCurrencyCode	String	• The authorization currency code.
visaProductCode	String	• The combination of codes provided by Visa to indicate the type of card at multiple levels.
dbaName	String	• The DBA name of the merchant.
avsResponseCode	String	• AVS response code (if provided by the gateway).
cvv2ResponseCode	String	• CVV2 response (if provided by the gateway).
transactionTime	DateTime	• Identifies the timestamp of a transaction based on GMT.
rejectReason	String	• Identifies the reason for if a transaction was rejected.
authResponseCode	String	• The authorization response code.
providerPath	String	• The name of the acquirer.
estimatedBankDate	DateTime	• The ACH posting date.
associationNumber	String	• Identifier number for the acquirer.
adjustmentAmount	String	• Total amount for the transaction.
adjustmentType	String	• The type of case involved.
adjustmentDescription	String	• Description of adjustment.
regulatedIndicator	String	• Regulated indicator.
billingDescriptor	String	• Identifies the billing descriptor.
issuingBank	String	• Identifies the issuing bank.
issuingBankCountry	String	• Identifies the issuing bank's country of card used.

NAME	TYPE	DESCRIPTION
fundsTransferGroup	String	• Specific identifier of the transaction group (reference for a line amount associated with the bank).
interchangeCode	String	• Code that indicates the interchange rate.
fileNumber	String	• File date of the batch.
airlineTicketNum	String	• Airline confirmation code or number.
token	String	• A unique key that identifies the transaction.
receiptNumber	String	• Receipt text provided by the gateway.
disputeRecordNumber	String	• The unique number assigned by the system to every case.
disputeAmount	Int	• The amount of the retrieval or dispute.
chargebackReferenceNumber	String	• An internal reference number assigned by the card issuer.
initialReportDate	String	• The post date as reported by the issuer.
originalTransactionDate	String	• The original transaction date as reported by the issuer.
chargebackActionCode	String	• The type of item involved.
issuerAdjustmentReasonCode	String	• The reason code for retrievals or disputes from the card brands.
resolutionTo	String	• The institution against which the case was resolved.
recordType	String	• Indicates whether a record is a regular dispute or a dispute reversal.
firstChargebackFlag	String	• The type of case involved.
event	String	• Either: Dispute, Refund, Sale

Webhook Event Fields: Refund

NAME	TYPE	DESCRIPTION
transactionSequenceNumber	String	• The unique sequence number for the transaction.
acquirerMerchantId	String	• The acquirer's identification number for the merchant.
processingDate	String	• The date that the transaction was processed by the acquirer (format YYYY-MM-DD).
transactionDate	String	• The date that the transaction occurred.
cardExpirationDate	Date	• Expiration date of card (format YYMM).
fundingDate	String	• The date the transaction was paid via ACH (format YYYY-MM-DD).
authCode	String	• The authorization code passed with the settlement record.
transactionTypeCode	String	• Indicates the type of transaction.
posEntryMode	String	• The point of sale entry mode for the transaction.
cardAccountNumber	String	• The masked value of the payment card number used for the transaction.
transactionAmount	Float	• The total amount for the transaction.
authorizedAmount	Float	• The authorized amount for the transaction.
cashbackAmount	Int	• The cashback amount for the transaction.
merchantCategoryCode	String	• The standard industry code for a specific industry or business.
cardBrand	String	• The type of card used in the transaction.
cardProductType	String	• Indicates if the card is credit or debit.
batchNumber	String	• A unique identifier for a given batch for a given customer.
networkReferenceNumber	String	• An identification number for a credit card transaction assigned by the acquirer.
authorizationSource	String	• The given authorization source of the transaction.
authorizationDate	DateTime	• The date the transaction was authorized.
mailPhoneIndicator	String	• Indicates if a transaction is mail order or telephone order.
debitCreditIndicator	String	• Indicates whether the amount is a debit, credit, or non-monetary.
catIndicator	String	• Indicator if the terminal was cardholder activated.
NAME	TYPE	DESCRIPTION
invoiceNumber	String	• Invoice number (if provided by the gateway).
terminalId	String	• Terminal ID (if provided by the gateway).
currencyCode	String	• International standard currency code.
authCurrencyCode	String	• The authorization currency code.
visaProductCode	String	• The combination of codes provided by Visa to indicate the type of card at multiple levels.
dbaName	String	• The DBA name of the merchant.
avsResponseCode	String	• AVS response code (if provided by the gateway).
cvv2ResponseCode	String	• CVV2 response (if provided by the gateway).
transactionTime	DateTime	• Identifies the timestamp of a transaction based on GMT.
rejectReason	String	• Identifies the reason for if a transaction was rejected.
authResponseCode	String	• The authorization response code.
providerPath	String	• The name of the acquirer.
estimatedBankDate	DateTime	• The ACH posting date.
associationNumber	String	• Identifier number for the acquirer.
adjustmentAmount	String	• Total amount for the transaction.
adjustmentType	String	• The type of case involved.
adjustmentDescription	String	• Description of adjustment.
regulatedIndicator	String	• Regulated indicator.
billingDescriptor	String	• Identifies the billing descriptor.
issuingBank	String	• Identifies the issuing bank.
issuingBankCountry	String	• Identifies the issuing bank's country of card used.
fundsTransferGroup	String	• Specific identifier of the transaction group (reference for a line amount associated with the bank).
interchangeCode	String	• Code that indicates the interchange rate.

NAME	TYPE	DESCRIPTION
fileNumber	String	• File date of the batch.
airlineTicketNum	String	• Airline confirmation code or number.
token	String	• A unique key that identifies the transaction.
receiptNumber	String	• Receipt text provided by the gateway.
event	String	• Either: Dispute, Refund, Sale

Webhook Event Fields: Sale

NAME	TYPE	DESCRIPTION
transactionSequenceNumber	String	• The unique sequence number for the transaction.
acquirerMerchantId	String	• The acquirer's identification number for the merchant.
processingDate	String	• The date that the transaction was processed by the acquirer (format YYYY-MM-DD).
transactionDate	String	• The date that the transaction occurred.
cardExpirationDate	Date	• Expiration date of card (format YYMM).
fundingDate	String	• The date the transaction was paid via ACH (format YYYY-MM-DD).
authCode	String	• The authorization code passed with the settlement record.
transactionTypeCode	String	• Indicates the type of transaction.
posEntryMode	String	• The point of sale entry mode for the transaction.
cardAccountNumber	String	• The masked value of the payment card number used for the transaction.
transactionAmount	Float	• The total amount for the transaction.
authorizedAmount	Float	• The authorized amount for the transaction.
cashbackAmount	Int	• The cashback amount for the transaction.
merchantCategoryCode	String	• The standard industry code for a specific industry or business.
cardBrand	String	• The type of card used in the transaction.
cardProductType	String	• Indicates if the card is credit or debit.
batchNumber	String	• A unique identifier for a given batch for a given customer.
networkReferenceNumber	String	• An identification number for a credit card transaction assigned by the acquirer.
authorizationSource	String	• The given authorization source of the transaction.
authorizationDate	DateTime	• The date the transaction was authorized.
mailPhoneIndicator	String	• Indicates if a transaction is mail order or telephone order.
debitCreditIndicator	String	• Indicates whether the amount is a debit, credit, or non-monetary.
catIndicator	String	• Indicator if the terminal was cardholder activated.

NAME	TYPE	DESCRIPTION
invoiceNumber	String	• Invoice number (if provided by the gateway).
terminalId	String	• Terminal ID (if provided by the gateway).
currencyCode	String	• International standard currency code.
authCurrencyCode	String	• The authorization currency code.
visaProductCode	String	• The combination of codes provided by Visa to indicate the type of card at multiple levels.
dbaName	String	• The DBA name of the merchant.
avsResponseCode	String	• AVS response code (if provided by the gateway).
cvv2ResponseCode	String	• CVV2 response (if provided by the gateway).
transactionTime	DateTime	• Identifies the timestamp of a transaction based on GMT.
rejectReason	String	• Identifies the reason for if a transaction was rejected.
authResponseCode	String	• The authorization response code.
providerPath	String	• The name of the acquirer.
estimatedBankDate	DateTime	• The ACH posting date.
associationNumber	String	• Identifier number for the acquirer.
adjustmentAmount	String	• Total amount for the transaction.
adjustmentType	String	• The type of case involved.
adjustmentDescription	String	• Description of adjustment.
regulatedIndicator	String	• Regulated indicator.
billingDescriptor	String	• Identifies the billing descriptor.
issuingBank	String	• Identifies the issuing bank.
issuingBankCountry	String	• Identifies the issuing bank's country of card used.
fundsTransferGroup	String	• Specific identifier of the transaction group (reference for a line amount associated with the bank).
interchangeCode	String	• Code that indicates the interchange rate.
fileNumber	String	• File date of the batch.
NAME	TYPE	DESCRIPTION
airlineTicketNum	String	• Airline confirmation code or number.
token	String	• A unique key that identifies the transaction.
receiptNumber	String	• Receipt text provided by the gateway.
event	String	• Either: Dispute, Refund, Sale

Please proceed to the next article on this topic: Adding a Webhook.