---
title: "Transaction Event"
method: POST
path: "transaction"
tags: ["Webhook Events"]
---

# Transaction Event

`POST transaction` (webhook)

Sales, auths, captures, voids, refunds, and credits. Each transaction type can be filtered by successful, failed, and unknown transactions.

## Headers

- `Webhook-Signature` string, required

## Payload

- object
  - `event_id` string, required: Event ID
  - `event_type` 'transaction.sale.success' | 'transaction.sale.failure' | 'transaction.sale.unknown' | 'transaction.auth.success' | 'transaction.auth.failure' | 'transaction.auth.unknown' | 'transaction.capture.success' | 'transaction.capture.failure' | 'transaction.capture.unknown' | 'transaction.void.success' | 'transaction.void.failure' | 'transaction.void.unknown' | 'transaction.refund.success' | 'transaction.refund.failure' | 'transaction.refund.unknown' | 'transaction.credit.success' | 'transaction.credit.failure' | 'transaction.credit.unknown' | 'transaction.validate.success' | 'transaction.validate.failure' | 'transaction.validate.unknown', required: Transaction Event Type
  - `event_body` object, required: Transaction Details
    - `merchant` Merchant: Merchant Details
      - `id` string: Merchant identifier
      - `name` string: Merchant name
    - `features` Features: Features associated with the transaction
      - `is_test_mode` boolean: Test mode status
    - `transaction_id` string: Transaction ID
    - `transaction_type` 'cc' | 'ck' | 'cs': Transaction Type (cc - credit card, ck - check, cs - cash sale)
    - `condition` 'pending' | 'pendingsettlement' | 'in_progress' | 'abandoned' | 'failed' | 'canceled' | 'complete' | 'unknown': Transaction condition
    - `processor_id` string: Processor ID
    - `ponumber` string: Purchase order number
    - `order_description` string: Order description
    - `order_id` string: Order ID
    - `customerid` string: Customer ID
    - `customertaxid` string: Customer tax ID
    - `website` string: Website URL
    - `shipping` string: Shipping amount
    - `currency` string: Currency code
    - `tax` string: Tax amount
    - `surcharge` string: Surcharge amount.
    - `convenience_fee` string: Convenience Fee amount.
    - `misc_fee` string: Miscellaneous Fee amount.
    - `misc_fee_name` string: Miscellaneous Fee Name.
    - `cash_discount` string: How much less a customer paid due to a cash discount. Format: x.xx, only applicable to cash and check transactions
    - `tip` string: The final tip amount, included in the transaction, associated with the purchase
    - `requested_amount` string, decimal: Requested amount
    - `shipping_carrier` 'ups' | 'fedex' | 'dhl' | 'usps' | '': Shipping carrier.
    - `tracking_number` string: Shipping tracking number.
    - `shipping_date` string: Shipping date.
    - `partial_payment_id` string: A numeric identifier which is used when submitting subsequent transactions.
    - `partial_payment_balance` string: The payment's remaining balance.
    - `platform_id` string: Platform ID associated with the transaction.
    - `authorization_code` string: Transaction authorization code.
    - `social_security_number` string: Customer's social security number.
    - `drivers_license_number` string: Driver's license number.
    - `drivers_license_state` string: The state that issued the customer's driver's license.
    - `drivers_license_dob` string: Driver's license date of birth.
    - `duty_amount` string: Duty amount.
    - `discount_amount` string: Discount amount.
    - `national_tax_amount` string: National tax amount.
    - `summary_commodity_code` string: Summary commodity code.
    - `alternate_tax_amount` string, decimal: Alternate tax amount.
    - `vat_tax_amount` string, decimal: VAT tax amount.
    - `vat_tax_rate` string, decimal: VAT tax rate.
    - `billing_address` BillingAddress: Billing Address details
      - `first_name` string: The first name of the person associated with the billing address.
      - `last_name` string: The last name of the person associated with the billing address.
      - `address_1` string: The first line of the street address.
      - `address_2` string: The second line of the street address.
      - `company` string: The name of the company associated with the billing address.
      - `city` string: The name of the city associated with the billing address.
      - `state` string: The name of the state or province associated with the billing address. Format: `CC`
      - `postal_code` string: The postal code or zip code associated with the billing address.
      - `country` string: The name of the country associated with the billing address. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC`
      - `email` string, email: The email address associated with the billing address.
      - `phone` string, phone: The phone number associated with the billing address.
      - `cell_phone` string, phone: The cell phone number associated with the billing address.
      - `fax` string, phone: The fax number associated with the billing address.
    - `shipping_address` ShippingAddress: Shipping Address details.
      - `first_name` string: The first name of the person associated with the shipping address.
      - `last_name` string: The last name of the person associated with the shipping address.
      - `address_1` string: The first line of the street address.
      - `address_2` string: The second line of the street address.
      - `company` string: The name of the company associated with the shipping address.
      - `city` string: The city of the shipping address.
      - `state` string: The state or province of the shipping address. Format: `CC`
      - `postal_code` string: The postal or zip code of the shipping address.
      - `country` string: The country of the shipping address. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC`
      - `email` string: The email address associated with the shipping address.
      - `phone` string: The phone number associated with the shipping address.
      - `fax` string: The fax number associated with the shipping address.
    - `card` CardDetails: Details related to the credit card used in the transaction. Available for credit card transactions only.
      - `cc_number` string: Masked credit card number
      - `cc_exp` string: Credit card expiration date
      - `cavv` string: Cardholder Authentication Verification Value
      - `cavv_result` string: Cardholder Authentication Verification Value result
      - `xid` string: Cardholder authentication transaction id
      - `eci` '01' | '02' | '05' | '06' | '07' | '08' | '09' | '': Electronic Commerce Indicator
      - `avs_response` string: Address Verification Service response
      - `csc_response` string: Card Security Code response
      - `cardholder_auth` 'verified' | 'attempted' | '': Cardholder Authentication response
      - `cc_start_date` string: Credit card start date
      - `cc_issue_number` string: Credit card issue number
      - `card_balance` string: Card balance
      - `card_available_balance` string: Card available balance
      - `entry_mode` '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8': The type of transaction data to be processed. <details> <summary>Possible values:</summary> | Code | Description | |:------|:--------------------| | 0 | Unknown | | 1 | Invalid | | 2 | NFC MSD | | 3 | Swiped | | 4 | Keyed | | 5 | EMV ICC | | 6 | NFC EMV | | 7 | Keyed - Fallback | | 8 | Swiped - Fallback | </details>
      - `cc_bin` string: Credit card BIN (first 6 digits)
      - `cc_type` string: Credit card type (visa, ..)
      - `feature_token` string: Feature token
    - `check` CheckDetails: Details about a check payment. Available for ACH transactions only.
      - `check_account` string: The customer's bank account number.
      - `check_aba` string: The customer's bank routing number.
      - `check_name` string: The customer's name.
      - `account_holder_type` 'business' | 'personal': The customer's ACH account entity.
      - `account_type` 'checking' | 'savings': The customer's ACH account type.
      - `sec_code` 'PPD' | 'WEB' | 'TEL' | 'CCD': ACH standard entry class codes.
    - `emv_meta_data` EmvMetaData: Details about the EMV transaction
      - `application_id` string: EMV Application ID
      - `application_label` string: EMV Application Label
      - `application_preferred_name` string: EMV Application Preferred Name
      - `transaction_status_info` string: Transaction Status Information
      - `application_pan_sequence_number` string: EMV Application PAN Sequence Number
      - `customer_verification_method` 'signature' | 'offline_pin' | 'online_pin' | 'none' | 'offline_pin_signature' | 'consumer_device' | 'consumer_device_plus_signature' | '': EMV Customer Verification Method
    - `action` TransactionAction: Transaction Action details
      - `amount` string, decimal: Amount of the transaction
      - `action_type` 'auth' | 'capture' | 'sale' | 'void' | 'refund' | 'credit' | 'return' | 'validate': Type of transaction
      - `date` string, date-time: Date of the transaction
      - `success` '0' | '1': Transaction Success Flag (0 - Failed, 1 - Success)
      - `ip_address` string, ipv4: IP Address of the transaction
      - `source` 'api' | 'batch_upload' | 'mobile' | 'quickclick' | 'quickbooks' | 'recurring' | 'swipe' | 'virtual_terminal' | 'internal': Source of the transaction
      - `api_method` string: API Method used for the transaction (direct_post, ..)
      - `username` string: Username
      - `response_text` 'APPROVED' | 'SUCCESS' | 'DECLINE': Transaction Response Text
      - `response_code` string: Response Code (100 - OK, 200 - Declined)
      - `processor_response_text` string: Processor Response Text
      - `processor_response_code` string: Processor Response Code
      - `tap_to_mobile` boolean: Tap to Mobile Flag
      - `device_license_number` string: Mobile Device License Number
      - `device_nickname` string: Mobile Device Nickname
    - `merchant_defined_fields` object: Merchant defined fields

## Acknowledgement `200`

Return a 200 status to indicate that the data was received successfully

---

[API](https://skmtc.dev/nmi/apis/payments-api.md) - [All operations](https://skmtc.dev/nmi/apis/payments-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nmi/apis/payments-api/revisions/c03727f27e27?raw)