---
title: "Recurring Event"
method: POST
path: "recurring"
tags: ["Webhook Events"]
---

# Recurring Event

`POST recurring` (webhook)

Events related to Recurring transactions (plans, subscriptions).

## Headers

- `Webhook-Signature` string, required

## Payload

- object
  - `event_id` string, required: Event ID
  - `event_type` 'recurring.plan.add' | 'recurring.plan.update' | 'recurring.plan.delete' | 'recurring.subscription.add' | 'recurring.subscription.update' | 'recurring.subscription.delete', required: Recurring Event Type
  - `event_body` RecurringEventBody, required: Details about Subscription.
    - `merchant` Merchant, required: Merchant Details
      - `id` string: Merchant identifier
      - `name` string: Merchant name
    - `features` Features, required: Features associated with the transaction
      - `is_test_mode` boolean: Test mode status
    - `subscription_id` string: Subscription ID
    - `subscription_type` 'cc' | 'ck': Subscription Type (cc - Credit Card, ck - Check)
    - `processor_id` string: Processor ID
    - `next_charge_date` string, date: Next Charge Date
    - `completed_payments` string, number: Completed Payments
    - `attempted_payments` string, number: Attempted Payments
    - `remaining_payments` string: Remaining Payments (`Until canceled` or number of remaining payments)
    - `ponumber` string: PO Number
    - `order_id` string: Order ID
    - `order_description` string: Order Description
    - `shipping` string: Shipping Details
    - `tax` string: Tax Details
    - `website` string: Website Details
    - `plan` object, required: Plan Details
      - `id` string: Plan ID
      - `name` string: Plan Name
      - `amount` string: Plan Amount
      - `day_frequency` string: Day Frequency
      - `payments` string: Payments Details
      - `month_frequency` string, number: Month Frequency
      - `day_of_month` string, number: Day of Month
    - `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.
    - `card` RecurringCardDetails: 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, ..)
    - `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.

## 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)