---
updatedAt: 2026-09-02T15:10:31.000Z
agentTools:
  projectIndex: https://docs.nmi.com/llms.txt
---

# Query API (Classic)

<details>
<summary>Methodology</summary>

**Overview**

While our online reporting interface allows merchants to quickly and easily retrieve detailed information about past transactions, a need for additional flexibility may be required. For example, a merchant may have custom accounting software that requires up-to-date information about the settlement status of all credit card transactions every day.

This document describes how developers can query our reporting engine directly to retrieve transaction reports in a machine readable format. Once the data has been retrieved, it can then be parsed and imported into a variety of software applications.

**Communication**

The communication protocol used to send messages to the Payment Gateway is through the HTTP protocol over an SSL connection (HTTPS). The format you must use is name/value pairs delimited by ampersand.

| URL                                     | Example Post Data                                     |
|:----------------------------------------|:------------------------------------------------------|
| `https://sandbox.nmi.com/api/query.php`  | `security_key=security_key&transaction_id=123456789`  |

You should POST your request to the Query API. The name/value pairs that are accepted by the Payment Gateway can be found in the 'Variables' section of this API.

The Query API can be tested with live credentials or a dedicated test account only. Please contact your Merchant Service Provider for more information.

The Query API will respond in Universal Time Coordinated (UTC).

</details>

<details>
<summary>Example Response</summary>

**Query with no report_type or report_type "transaction"**

```xml
<nm_response>
    <transaction>
        <transaction_id>2612675976</transaction_id>
        <partial_payment_id></partial_payment_id>
        <partial_payment_balance></partial_payment_balance>
        <platform_id></platform_id>
        <transaction_type>cc</transaction_type>
        <condition>complete</condition>
        <order_id>1234567890</order_id>
        <authorization_code>123456</authorization_code>
        <ponumber></ponumber>
        <order_description></order_description>
        <first_name>John</first_name>
        <last_name>Smith</last_name>
        <address_1>123 Main St</address_1>
        <address_2>Apt B</address_2>
        <company></company>
        <city>New York City</city>
        <state>NY</state>
        <postal_code>10001</postal_code>
        <country>US</country>
        <email>johnsmith@example.com</email>
        <phone>1234567890</phone>
        <fax></fax>
        <cell_phone></cell_phone>
        <customertaxid></customertaxid>
        <customerid></customerid>
        <website></website>
        <shipping_first_name></shipping_first_name>
        <shipping_last_name></shipping_last_name>
        <shipping_address_1></shipping_address_1>
        <shipping_address_2></shipping_address_2>
        <shipping_company></shipping_company>
        <shipping_city></shipping_city>
        <shipping_state></shipping_state>
        <shipping_postal_code></shipping_postal_code>
        <shipping_country></shipping_country>
        <shipping_email></shipping_email>
        <shipping_carrier></shipping_carrier>
        <tracking_number></tracking_number>
        <shipping_date></shipping_date>
        <shipping>1.00</shipping>
        <shipping_phone></shipping_phone>
        <cc_number>4xxxxxxxxxxx1111</cc_number>
        <cc_hash>f6c609e195d9d4c185dcc8ca662f0180</cc_hash>
        <cc_exp>1215</cc_exp>
        <cavv></cavv>
        <cavv_result></cavv_result>
        <xid></xid>
        <eci></eci>
        <directory_server_id></directory_server_id>
        <three_ds_version></three_ds_version>
        <avs_response>N</avs_response>
        <csc_response>M</csc_response>
        <cardholder_auth></cardholder_auth>
        <cc_start_date></cc_start_date>
        <cc_issue_number></cc_issue_number>
        <check_account></check_account>
        <check_hash></check_hash>
        <check_aba></check_aba>
        <check_name></check_name>
        <account_holder_type></account_holder_type>
        <account_type></account_type>
        <sec_code></sec_code>
        <drivers_license_number></drivers_license_number>
        <drivers_license_state></drivers_license_state>
        <drivers_license_dob></drivers_license_dob>
        <social_security_number></social_security_number>
        <processor_id>processora</processor_id>
        <tax>1.00</tax>
        <currency>USD</currency>
        <surcharge></surcharge>
        <convenience_fee></convenience_fee>
        <misc_fee></misc_fee>
        <misc_fee_name></misc_fee_name>
        <cash_discount></cash_discount>
        <tip></tip>
        <card_balance></card_balance>
        <card_available_balance></card_available_balance>
        <entry_mode>Keyed</entry_mode>
        <cc_bin>411111</cc_bin>
        <cc_type>visa</cc_type>
        <signature_image>
            iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAAXNSR0IArs4c6QAAAARnQU1BAA
                Cxjwv8YQUAAAAJcEhZcwAAEnQA
            ABJ0Ad5mH3gAAACGSURBVDhPlZGBEoAgCEO1//9nG83mxMrr3dkBG0hVW2vFqLX26CYbPIc7yS
                AVe8LBq5u4elyV4M0NXIoGXYqA
            w4QqMAwJCRu+Az7HSlvgHtexlFKwGrLjG/h/rESmhrhRnLCKwjiNeLYv5QsXOoNSig8IsNYaZ0
                tXJoGU9hU1k18XlZLOQHTenf7I
            cf3BwAAAABJRU5ErkJggg==
        </signature_image>
        <product>
            <sku>RS-100</sku>
            <quantity>1.0000</quantity>
            <description>Red Shirt</description>
            <amount>10.0000</amount>
        </product>
        <action>
            <amount>11.00</amount>
            <action_type>sale</action_type>
            <date>20150312215205</date>
            <success>1</success>
            <ip_address>1.1.1.1</ip_address>
            <source>virtual_terminal</source>
            <api_method></api_method>
            <username>demo</username>
            <response_text>SUCCESS</response_text>
            <batch_id>0</batch_id>
            <processor_batch_id></processor_batch_id>
            <response_code>100</response_code>
            <processor_response_text>NO MATCH</processor_response_text>
            <processor_response_code>00</processor_response_code>
            <requested_amount>11.00</requested_amount>
            <device_license_number></device_license_number>
            <device_nickname></device_nickname>
        </action>
        <action>
            <amount>11.00</amount>
            <action_type>level3</action_type>
            <date>20150312215205</date>
            <success>1</success>
            <ip_address>1.1.1.1</ip_address>
            <source>virtual_terminal</source>
            <api_method></api_method>
            <username>demo</username>
            <response_text></response_text>
            <batch_id>0</batch_id>
            <processor_batch_id></processor_batch_id>
            <response_code>100</response_code>
            <processor_response_text></processor_response_text>
            <processor_response_code></processor_response_code>
            <device_license_number></device_license_number>
            <device_nickname></device_nickname>
        </action>
        <action>
            <amount>11.00</amount>
            <action_type>settle</action_type>
            <date>20150313171503</date>
            <success>1</success>
            <ip_address></ip_address>
            <source>internal</source>
            <api_method></api_method>
            <username></username>
            <response_text>ACCEPTED</response_text>
            <batch_id>76158269</batch_id>
            <processor_batch_id>782</processor_batch_id>
            <response_code>100</response_code>
            <processor_response_text></processor_response_text>
            <processor_response_code>0000000000021980</processor_response_code>
            <device_license_number></device_license_number>
            <device_nickname></device_nickname>
        </action>
    </transaction>
</nm_response>
```
</details>

<details>
<summary>Example Response With Processor Details</summary>

**Query with report_type "profile" and processor_details "true"**

```xml
<nm_response>
    <protected>false</protected>
    <is_gateway>false</is_gateway>
    <merchant>
        <company>Test Company</company>
        <email>johnsmith@example.com</email>
        <phone>123-456-7890</phone>
        <url></url>
        <address1>123 Fake St</address1>
        <address2></address2>
        <city>Beverly Hills</city>
        <state>CA</state>
        <zip>90210</zip>
        <country>US</country>
        <timezone>America/New_York (GMT-05:00) Eastern Time (US & Canada)</timezone>
        <card_schemes>Visa,Mastercard,American Express,Discover,Diner's Club,JCB,Maestro,Banco Popular,Isracard,Hipercard,Credomatic Card,EBT</card_schemes>
    </merchant>
    <gateway>
        <company>Test Reseller</company>
        <url></url>
        <email>johnsmith@example.com</email>
        <phone>123-456-7890</phone>
        <primary_color>36175F</primary_color>
        <complimentary_color_1>F1577B</complimentary_color_1>
        <complimentary_color_2>26CC9D</complimentary_color_2>
    </gateway>
    <merchant_defined_fields></merchant_defined_fields>
    <merchant_favicon>iVBORw0KGgoAAAANSUhEUgAAALQAAAC0CAMAAAAKE/YAAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAACfUExURUdwTPX19fX19fb29vn5+fX19fX19fb29vX19fX19fb29vb29v////b29vX19f////n5+fX19fn5+fX19ff39/X19fb29vX19fb29vX19f////X19fX19fb29vX19fb29vX19fX19fb29mRkZBcXF/X19e7u7hsbGx8fH0dHR8rKytjY2IWFhb6+vqysrDk5OTg4OFBQUCgoKCEhISIiIjOJ5RMAAAAjdFJOUwD83x8tUeeStfk9rAbl7w8wzDHsINJ82Y42CcFnf/0/9v4+JiMvSAAAAqRJREFUeNrt3dlSwkAUBNBhkSTsyCqr4lyRffP/v81dS0wmQCnc1u5Hn85DhAxV022MK+1ht+XXk9VATpSgmqz7re6wbY7MVa9zMuw3fKd3dbi41mjKmdNs1A4iX+b6oiD93OXe5LIvauKX9yKXvIQoSsIrxZsvMqIsmYsYct4ThfHyLnOqIipTSUWb0wVRmkI6ypwtitoUsxHma1Gc61B1uiiqUwx5QlIFUZ7Ct//GfEXUp7L7yecJQLyd70GByJfvxlIGA50poT0cOw9IOYGCTny+qfoCE//jnCJAeT/L5JDQubcz7A0Suv962m0IVBov6CYWuvnym4yA5flXnB4auveE7qChO8a0AzR00DYDgcvAdPHQXdPCQ7eQXpY+X5rqeOi6SeKhk6aKh66aiI/pyWy92tpzZrtazybhH9Qm9M+LpdWR5SKMF4aejq2ejKd7oecbqymb+R7o+cjqymgei55urLZspnHosdWXcQx6YTVm4UYvVaKXTvTE6szEhZ4pRc9c6LVS9NqFXilFr1zorVL01oW2WkM00Uei77XGhb7VGqKJJppoookmmmiiiSaaaKKJJloTeqQ1/FmMaKKJJppoookm+qfQd78aookmmmiiiSaaaKKJ/ttonlyIJhrgYEs00UQTTTTR/wPNdw+iMS6cPfy5q32Qlyghr6tCXgyGvIKNedkdslYAs8ABsioDs5QEs/4Fs2hHe6VRJFp1TIBnDjBruiAL0SCr5yBL/iDrFCGLKwErQoeYZayQtbeYBcOQVc6QpdmY9eSQRfCQlfuY4waQMxKYgx2Q0yiYIzSQcz+Yw0qYE1aQY2GYs2yYA3iYU4OYo46Y85mYQ6WYk7Cg47uYM8evg9Iqzo2HDEqDTneDjqS/zdEPzjNHP3DP0T8C4oBc15g2YiAAAAAASUVORK5CYII=</merchant_favicon>
    <account_details>
        <account_status>active</account_status>
        <test_mode_enabled>false</test_mode_enabled>
    </account_details>
</nm_response>
```
</details>

<div class="alert alert-blue">
  ### **Never Use Real API Keys**

Use Sandbox keys with the Try It feature. Do not enter production API keys when testing.

</div>

<Accordion title="Overview">
While our online reporting interface gives merchants quick access to detailed transaction history, some workflows require additional flexibility. For example, a merchant using custom accounting tools may need automated, daily updates on the settlement status of all credit card transactions.

This reference outlines how developers can query our reporting engine directly to retrieve transaction data in a consistent, machine readable format. After retrieval, the data can be parsed and integrated into internal systems, accounting platforms, or other third party applications.
</Accordion>

<Accordion title="Communication">
  The Query API uses standard HTTPS communication and accepts requests as URL encoded name–value pairs separated by ampersands.

  | URL                                    | Example Post Data                                    |
  | :------------------------------------- | :--------------------------------------------------- |
  | `https://sandbox.nmi.com/api/query.php` | `security_key=security_key&transaction_id=123456789` |

  Send all requests to the Query API using the POST method. The full list of supported name–value pairs is documented in the Variables section below.

  The Query API can be accessed using live credentials or a dedicated test account. If you need test credentials, contact your Merchant Service Provider.

  All responses from the Query API are returned in Coordinated Universal Time (UTC).
</Accordion>

<Accordion title="Example Response">
  **Query with no report\_type or report\_type "transaction"**

  ```xml
  <nm_response>
      <transaction>
          <transaction_id>2612675976</transaction_id>
          <partial_payment_id></partial_payment_id>
          <partial_payment_balance></partial_payment_balance>
          <platform_id></platform_id>
          <transaction_type>cc</transaction_type>
          <condition>complete</condition>
          <order_id>1234567890</order_id>
          <authorization_code>123456</authorization_code>
          <ponumber></ponumber>
          <order_description></order_description>
          <first_name>John</first_name>
          <last_name>Smith</last_name>
          <address_1>123 Main St</address_1>
          <address_2>Apt B</address_2>
          <company></company>
          <city>New York City</city>
          <state>NY</state>
          <postal_code>10001</postal_code>
          <country>US</country>
          <email>johnsmith@example.com</email>
          <phone>1234567890</phone>
          <fax></fax>
          <cell_phone></cell_phone>
          <customertaxid></customertaxid>
          <customerid></customerid>
          <website></website>
          <shipping_first_name></shipping_first_name>
          <shipping_last_name></shipping_last_name>
          <shipping_address_1></shipping_address_1>
          <shipping_address_2></shipping_address_2>
          <shipping_company></shipping_company>
          <shipping_city></shipping_city>
          <shipping_state></shipping_state>
          <shipping_postal_code></shipping_postal_code>
          <shipping_country></shipping_country>
          <shipping_email></shipping_email>
          <shipping_carrier></shipping_carrier>
          <tracking_number></tracking_number>
          <shipping_date></shipping_date>
          <shipping>1.00</shipping>
          <shipping_phone></shipping_phone>
          <cc_number>4xxxxxxxxxxx1111</cc_number>
          <cc_hash>f6c609e195d9d4c185dcc8ca662f0180</cc_hash>
          <cc_exp>1215</cc_exp>
          <cavv></cavv>
          <cavv_result></cavv_result>
          <xid></xid>
          <eci></eci>
          <directory_server_id></directory_server_id>
          <three_ds_version></three_ds_version>
          <avs_response>N</avs_response>
          <csc_response>M</csc_response>
          <cardholder_auth></cardholder_auth>
          <cc_start_date></cc_start_date>
          <cc_issue_number></cc_issue_number>
          <check_account></check_account>
          <check_hash></check_hash>
          <check_aba></check_aba>
          <check_name></check_name>
          <account_holder_type></account_holder_type>
          <account_type></account_type>
          <sec_code></sec_code>
          <drivers_license_number></drivers_license_number>
          <drivers_license_state></drivers_license_state>
          <drivers_license_dob></drivers_license_dob>
          <social_security_number></social_security_number>
          <processor_id>processora</processor_id>
          <tax>1.00</tax>
          <currency>USD</currency>
          <surcharge></surcharge>
          <convenience_fee></convenience_fee>
          <misc_fee></misc_fee>
          <misc_fee_name></misc_fee_name>
          <cash_discount></cash_discount>
          <tip></tip>
          <card_balance></card_balance>
          <card_available_balance></card_available_balance>
          <entry_mode>Keyed</entry_mode>
          <cc_bin>411111</cc_bin>
        	<cc_type>visa</cc_type>
          <network_token_used>Y</network_token_used><network_token_cryptogram_created>true</network_token_cryptogram_created>
        	<network_token_created>true</network_token_created> 
          <signature_image>      iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAACGSURBVDhPlZGBEoAgCEO1//9nG83mxMrr3dkBG0hVW2vFqLX26CYbPIc7ySAVe8LBq5u4elyV4M0NXIoGXYqAw4QqMAwJCRu+Az7HSlvgHtexlFKwGrLjG/h/rESmhrhRnLCKwjiNeLYv5QsXOoNSig8IsNYaZ0tXJoGU9hU1k18XlZLOQHTenf7Icf3BwAAAABJRU5ErkJggg==
          </signature_image>
          <product>
              <sku>RS-100</sku>
              <quantity>1.0000</quantity>
              <description>Red Shirt</description>
              <amount>10.0000</amount>
          </product>
          <action>
              <amount>11.00</amount>
              <action_type>sale</action_type>
              <date>20150312215205</date>
              <success>1</success>
              <ip_address>1.1.1.1</ip_address>
              <source>virtual_terminal</source>
              <api_method></api_method>
              <username>demo</username>
              <response_text>SUCCESS</response_text>
              <batch_id>0</batch_id>
              <processor_batch_id></processor_batch_id>
              <response_code>100</response_code>
              <processor_response_text>NO MATCH</processor_response_text>
              <processor_response_code>00</processor_response_code>
              <requested_amount>11.00</requested_amount>
              <device_license_number></device_license_number>
              <device_nickname></device_nickname>
          </action>
          <action>
              <amount>11.00</amount>
              <action_type>level3</action_type>
              <date>20150312215205</date>
              <success>1</success>
              <ip_address>1.1.1.1</ip_address>
              <source>virtual_terminal</source>
              <api_method></api_method>
              <username>demo</username>
              <response_text></response_text>
              <batch_id>0</batch_id>
              <processor_batch_id></processor_batch_id>
              <response_code>100</response_code>
              <processor_response_text></processor_response_text>
              <processor_response_code></processor_response_code>
              <device_license_number></device_license_number>
              <device_nickname></device_nickname>
          </action>
          <action>
              <amount>11.00</amount>
              <action_type>settle</action_type>
              <date>20150313171503</date>
              <success>1</success>
              <ip_address></ip_address>
              <source>internal</source>
              <api_method></api_method>
              <username></username>
              <response_text>ACCEPTED</response_text>
              <batch_id>76158269</batch_id>
              <processor_batch_id>782</processor_batch_id>
              <response_code>100</response_code>
              <processor_response_text></processor_response_text>
              <processor_response_code>0000000000021980</processor_response_code>
              <device_license_number></device_license_number>
              <device_nickname></device_nickname>
          </action>
      </transaction>
  </nm_response>
  ```
</Accordion>

<Accordion title="Example Response With Processor Details">
  **Query with report\_type "profile" and processor\_details "true"**

  ```xml
  <nm_response>
      <protected>false</protected>
      <is_gateway>false</is_gateway>
      <merchant>
          <company>Test Company</company>
          <email>johnsmith@example.com</email>
          <phone>123-456-7890</phone>
          <url></url>
          <address1>123 Fake St</address1>
          <address2></address2>
          <city>Beverly Hills</city>
          <state>CA</state>
          <zip>90210</zip>
          <country>US</country>
          <timezone>America/New_York (GMT-05:00) Eastern Time (US & Canada)</timezone>
          <card_schemes>Visa,Mastercard,American Express,Discover,Diner's Club,JCB,Maestro,Banco Popular,Isracard,Hipercard,Credomatic Card,EBT</card_schemes>
      </merchant>
      <gateway>
          <company>Test Reseller</company>
          <url></url>
          <email>johnsmith@example.com</email>
          <phone>123-456-7890</phone>
          <primary_color>36175F</primary_color>
          <complimentary_color_1>F1577B</complimentary_color_1>
          <complimentary_color_2>26CC9D</complimentary_color_2>
      </gateway>
      <merchant_defined_fields></merchant_defined_fields>
      <merchant_favicon>iVBORw0KGgoAAAANSUhEUgAAALQAAAC0CAMAAAAKE/YAAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAACfUExURUdwTPX19fX19fb29vn5+fX19fX19fb29vX19fX19fb29vb29v////b29vX19f////n5+fX19fn5+fX19ff39/X19fb29vX19fb29vX19f////X19fX19fb29vX19fb29vX19fX19fb29mRkZBcXF/X19e7u7hsbGx8fH0dHR8rKytjY2IWFhb6+vqysrDk5OTg4OFBQUCgoKCEhISIiIjOJ5RMAAAAjdFJOUwD83x8tUeeStfk9rAbl7w8wzDHsINJ82Y42CcFnf/0/9v4+JiMvSAAAAqRJREFUeNrt3dlSwkAUBNBhkSTsyCqr4lyRffP/v81dS0wmQCnc1u5Hn85DhAxV022MK+1ht+XXk9VATpSgmqz7re6wbY7MVa9zMuw3fKd3dbi41mjKmdNs1A4iX+b6oiD93OXe5LIvauKX9yKXvIQoSsIrxZsvMqIsmYsYct4ThfHyLnOqIipTSUWb0wVRmkI6ypwtitoUsxHma1Gc61B1uiiqUwx5QlIFUZ7Ct//GfEXUp7L7yecJQLyd70GByJfvxlIGA50poT0cOw9IOYGCTny+qfoCE//jnCJAeT/L5JDQubcz7A0Suv962m0IVBov6CYWuvnym4yA5flXnB4auveE7qChO8a0AzR00DYDgcvAdPHQXdPCQ7eQXpY+X5rqeOi6SeKhk6aKh66aiI/pyWy92tpzZrtazybhH9Qm9M+LpdWR5SKMF4aejq2ejKd7oecbqymb+R7o+cjqymgei55urLZspnHosdWXcQx6YTVm4UYvVaKXTvTE6szEhZ4pRc9c6LVS9NqFXilFr1zorVL01oW2WkM00Uei77XGhb7VGqKJJppoookmmmiiiSaaaKKJJloTeqQ1/FmMaKKJJppoookm+qfQd78aookmmmiiiSaaaKKJ/ttonlyIJhrgYEs00UQTTTTR/wPNdw+iMS6cPfy5q32Qlyghr6tCXgyGvIKNedkdslYAs8ABsioDs5QEs/4Fs2hHe6VRJFp1TIBnDjBruiAL0SCr5yBL/iDrFCGLKwErQoeYZayQtbeYBcOQVc6QpdmY9eSQRfCQlfuY4waQMxKYgx2Q0yiYIzSQcz+Yw0qYE1aQY2GYs2yYA3iYU4OYo46Y85mYQ6WYk7Cg47uYM8evg9Iqzo2HDEqDTneDjqS/zdEPzjNHP3DP0T8C4oBc15g2YiAAAAAASUVORK5CYII=</merchant_favicon>
      <account_details>
          <account_status>active</account_status>
          <test_mode_enabled>false</test_mode_enabled>
      </account_details>
  </nm_response>
  ```
</Accordion>

# OpenAPI definition

````json
{
  "openapi": "3.1.0",
  "info": {
    "version": "1.0.0",
    "title": "Payments API",
    "description": "Our payments platform exposes two generations of API.\n\n**For new integrations, use the REST API** — JSON endpoints under `/v5/payments`, `/v5/subscriptions`, `/v5/plans`, and `/v5/customers` — paired with the **[Payment Component](../docs/payment-component)** (npm packages / [Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology)) for card capture and tokenization.\n\nThe **Classic** DirectPost (`transact.php`) and Query (`query.php`) endpoints are documented here for existing Classic integrations. If you're migrating from the Classic API, follow the [Classic API migration playbook](../docs/payment-migration-playbook).",
    "x-logo": {
      "url": "https://www.nmi.com/app/themes/nmi/images/NMI_Logo_Primary.webp"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.nmi.com/api"
    }
  ],
  "security": [],
  "tags": [
    {
      "name": "Data and Transaction Reporting",
      "description": "Query API (query.php) for retrieving transaction, subscription, and invoice data. Intended for existing Classic integrations."
    },
    {
      "name": "Webhook Events",
      "description": "Here you can find information about webhook events"
    }
  ],
  "externalDocs": {
    "url": "https://www.postman.com/nmi-integration-support/workspace/nmi-public-documentation/request/5480015-f4b0ec7b-bd84-4094-98c2-67c0b6508a7f",
    "description": "Public Documentation (Postman)"
  },
  "paths": {
    "/query.php": {
      "post": {
        "tags": [
          "Data and Transaction Reporting"
        ],
        "summary": "Query API (Classic)",
        "description": "<details>\n<summary>Methodology</summary>\n\n**Overview**\n\nWhile our online reporting interface allows merchants to quickly and easily retrieve detailed information about past transactions, a need for additional flexibility may be required. For example, a merchant may have custom accounting software that requires up-to-date information about the settlement status of all credit card transactions every day.\n\nThis document describes how developers can query our reporting engine directly to retrieve transaction reports in a machine readable format. Once the data has been retrieved, it can then be parsed and imported into a variety of software applications.\n\n**Communication**\n\nThe communication protocol used to send messages to the Payment Gateway is through the HTTP protocol over an SSL connection (HTTPS). The format you must use is name/value pairs delimited by ampersand.\n\n| URL                                     | Example Post Data                                     |\n|:----------------------------------------|:------------------------------------------------------|\n| `https://sandbox.nmi.com/api/query.php`  | `security_key=security_key&transaction_id=123456789`  |\n\nYou should POST your request to the Query API. The name/value pairs that are accepted by the Payment Gateway can be found in the 'Variables' section of this API.\n\nThe Query API can be tested with live credentials or a dedicated test account only. Please contact your Merchant Service Provider for more information.\n\nThe Query API will respond in Universal Time Coordinated (UTC).\n\n</details>\n\n<details>\n<summary>Example Response</summary>\n\n**Query with no report_type or report_type \"transaction\"**\n\n```xml\n<nm_response>\n    <transaction>\n        <transaction_id>2612675976</transaction_id>\n        <partial_payment_id></partial_payment_id>\n        <partial_payment_balance></partial_payment_balance>\n        <platform_id></platform_id>\n        <transaction_type>cc</transaction_type>\n        <condition>complete</condition>\n        <order_id>1234567890</order_id>\n        <authorization_code>123456</authorization_code>\n        <ponumber></ponumber>\n        <order_description></order_description>\n        <first_name>John</first_name>\n        <last_name>Smith</last_name>\n        <address_1>123 Main St</address_1>\n        <address_2>Apt B</address_2>\n        <company></company>\n        <city>New York City</city>\n        <state>NY</state>\n        <postal_code>10001</postal_code>\n        <country>US</country>\n        <email>johnsmith@example.com</email>\n        <phone>1234567890</phone>\n        <fax></fax>\n        <cell_phone></cell_phone>\n        <customertaxid></customertaxid>\n        <customerid></customerid>\n        <website></website>\n        <shipping_first_name></shipping_first_name>\n        <shipping_last_name></shipping_last_name>\n        <shipping_address_1></shipping_address_1>\n        <shipping_address_2></shipping_address_2>\n        <shipping_company></shipping_company>\n        <shipping_city></shipping_city>\n        <shipping_state></shipping_state>\n        <shipping_postal_code></shipping_postal_code>\n        <shipping_country></shipping_country>\n        <shipping_email></shipping_email>\n        <shipping_carrier></shipping_carrier>\n        <tracking_number></tracking_number>\n        <shipping_date></shipping_date>\n        <shipping>1.00</shipping>\n        <shipping_phone></shipping_phone>\n        <cc_number>4xxxxxxxxxxx1111</cc_number>\n        <cc_hash>f6c609e195d9d4c185dcc8ca662f0180</cc_hash>\n        <cc_exp>1215</cc_exp>\n        <cavv></cavv>\n        <cavv_result></cavv_result>\n        <xid></xid>\n        <eci></eci>\n        <directory_server_id></directory_server_id>\n        <three_ds_version></three_ds_version>\n        <avs_response>N</avs_response>\n        <csc_response>M</csc_response>\n        <cardholder_auth></cardholder_auth>\n        <cc_start_date></cc_start_date>\n        <cc_issue_number></cc_issue_number>\n        <check_account></check_account>\n        <check_hash></check_hash>\n        <check_aba></check_aba>\n        <check_name></check_name>\n        <account_holder_type></account_holder_type>\n        <account_type></account_type>\n        <sec_code></sec_code>\n        <drivers_license_number></drivers_license_number>\n        <drivers_license_state></drivers_license_state>\n        <drivers_license_dob></drivers_license_dob>\n        <social_security_number></social_security_number>\n        <processor_id>processora</processor_id>\n        <tax>1.00</tax>\n        <currency>USD</currency>\n        <surcharge></surcharge>\n        <convenience_fee></convenience_fee>\n        <misc_fee></misc_fee>\n        <misc_fee_name></misc_fee_name>\n        <cash_discount></cash_discount>\n        <tip></tip>\n        <card_balance></card_balance>\n        <card_available_balance></card_available_balance>\n        <entry_mode>Keyed</entry_mode>\n        <cc_bin>411111</cc_bin>\n        <cc_type>visa</cc_type>\n        <signature_image>\n            iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAAXNSR0IArs4c6QAAAARnQU1BAA\n                Cxjwv8YQUAAAAJcEhZcwAAEnQA\n            ABJ0Ad5mH3gAAACGSURBVDhPlZGBEoAgCEO1//9nG83mxMrr3dkBG0hVW2vFqLX26CYbPIc7yS\n                AVe8LBq5u4elyV4M0NXIoGXYqA\n            w4QqMAwJCRu+Az7HSlvgHtexlFKwGrLjG/h/rESmhrhRnLCKwjiNeLYv5QsXOoNSig8IsNYaZ0\n                tXJoGU9hU1k18XlZLOQHTenf7I\n            cf3BwAAAABJRU5ErkJggg==\n        </signature_image>\n        <product>\n            <sku>RS-100</sku>\n            <quantity>1.0000</quantity>\n            <description>Red Shirt</description>\n            <amount>10.0000</amount>\n        </product>\n        <action>\n            <amount>11.00</amount>\n            <action_type>sale</action_type>\n            <date>20150312215205</date>\n            <success>1</success>\n            <ip_address>1.1.1.1</ip_address>\n            <source>virtual_terminal</source>\n            <api_method></api_method>\n            <username>demo</username>\n            <response_text>SUCCESS</response_text>\n            <batch_id>0</batch_id>\n            <processor_batch_id></processor_batch_id>\n            <response_code>100</response_code>\n            <processor_response_text>NO MATCH</processor_response_text>\n            <processor_response_code>00</processor_response_code>\n            <requested_amount>11.00</requested_amount>\n            <device_license_number></device_license_number>\n            <device_nickname></device_nickname>\n        </action>\n        <action>\n            <amount>11.00</amount>\n            <action_type>level3</action_type>\n            <date>20150312215205</date>\n            <success>1</success>\n            <ip_address>1.1.1.1</ip_address>\n            <source>virtual_terminal</source>\n            <api_method></api_method>\n            <username>demo</username>\n            <response_text></response_text>\n            <batch_id>0</batch_id>\n            <processor_batch_id></processor_batch_id>\n            <response_code>100</response_code>\n            <processor_response_text></processor_response_text>\n            <processor_response_code></processor_response_code>\n            <device_license_number></device_license_number>\n            <device_nickname></device_nickname>\n        </action>\n        <action>\n            <amount>11.00</amount>\n            <action_type>settle</action_type>\n            <date>20150313171503</date>\n            <success>1</success>\n            <ip_address></ip_address>\n            <source>internal</source>\n            <api_method></api_method>\n            <username></username>\n            <response_text>ACCEPTED</response_text>\n            <batch_id>76158269</batch_id>\n            <processor_batch_id>782</processor_batch_id>\n            <response_code>100</response_code>\n            <processor_response_text></processor_response_text>\n            <processor_response_code>0000000000021980</processor_response_code>\n            <device_license_number></device_license_number>\n            <device_nickname></device_nickname>\n        </action>\n    </transaction>\n</nm_response>\n```\n</details>\n\n<details>\n<summary>Example Response With Processor Details</summary>\n\n**Query with report_type \"profile\" and processor_details \"true\"**\n\n```xml\n<nm_response>\n    <protected>false</protected>\n    <is_gateway>false</is_gateway>\n    <merchant>\n        <company>Test Company</company>\n        <email>johnsmith@example.com</email>\n        <phone>123-456-7890</phone>\n        <url></url>\n        <address1>123 Fake St</address1>\n        <address2></address2>\n        <city>Beverly Hills</city>\n        <state>CA</state>\n        <zip>90210</zip>\n        <country>US</country>\n        <timezone>America/New_York (GMT-05:00) Eastern Time (US & Canada)</timezone>\n        <card_schemes>Visa,Mastercard,American Express,Discover,Diner's Club,JCB,Maestro,Banco Popular,Isracard,Hipercard,Credomatic Card,EBT</card_schemes>\n    </merchant>\n    <gateway>\n        <company>Test Reseller</company>\n        <url></url>\n        <email>johnsmith@example.com</email>\n        <phone>123-456-7890</phone>\n        <primary_color>36175F</primary_color>\n        <complimentary_color_1>F1577B</complimentary_color_1>\n        <complimentary_color_2>26CC9D</complimentary_color_2>\n    </gateway>\n    <merchant_defined_fields></merchant_defined_fields>\n    <merchant_favicon>iVBORw0KGgoAAAANSUhEUgAAALQAAAC0CAMAAAAKE/YAAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAACfUExURUdwTPX19fX19fb29vn5+fX19fX19fb29vX19fX19fb29vb29v////b29vX19f////n5+fX19fn5+fX19ff39/X19fb29vX19fb29vX19f////X19fX19fb29vX19fb29vX19fX19fb29mRkZBcXF/X19e7u7hsbGx8fH0dHR8rKytjY2IWFhb6+vqysrDk5OTg4OFBQUCgoKCEhISIiIjOJ5RMAAAAjdFJOUwD83x8tUeeStfk9rAbl7w8wzDHsINJ82Y42CcFnf/0/9v4+JiMvSAAAAqRJREFUeNrt3dlSwkAUBNBhkSTsyCqr4lyRffP/v81dS0wmQCnc1u5Hn85DhAxV022MK+1ht+XXk9VATpSgmqz7re6wbY7MVa9zMuw3fKd3dbi41mjKmdNs1A4iX+b6oiD93OXe5LIvauKX9yKXvIQoSsIrxZsvMqIsmYsYct4ThfHyLnOqIipTSUWb0wVRmkI6ypwtitoUsxHma1Gc61B1uiiqUwx5QlIFUZ7Ct//GfEXUp7L7yecJQLyd70GByJfvxlIGA50poT0cOw9IOYGCTny+qfoCE//jnCJAeT/L5JDQubcz7A0Suv962m0IVBov6CYWuvnym4yA5flXnB4auveE7qChO8a0AzR00DYDgcvAdPHQXdPCQ7eQXpY+X5rqeOi6SeKhk6aKh66aiI/pyWy92tpzZrtazybhH9Qm9M+LpdWR5SKMF4aejq2ejKd7oecbqymb+R7o+cjqymgei55urLZspnHosdWXcQx6YTVm4UYvVaKXTvTE6szEhZ4pRc9c6LVS9NqFXilFr1zorVL01oW2WkM00Uei77XGhb7VGqKJJppoookmmmiiiSaaaKKJJloTeqQ1/FmMaKKJJppoookm+qfQd78aookmmmiiiSaaaKKJ/ttonlyIJhrgYEs00UQTTTTR/wPNdw+iMS6cPfy5q32Qlyghr6tCXgyGvIKNedkdslYAs8ABsioDs5QEs/4Fs2hHe6VRJFp1TIBnDjBruiAL0SCr5yBL/iDrFCGLKwErQoeYZayQtbeYBcOQVc6QpdmY9eSQRfCQlfuY4waQMxKYgx2Q0yiYIzSQcz+Yw0qYE1aQY2GYs2yYA3iYU4OYo46Y85mYQ6WYk7Cg47uYM8evg9Iqzo2HDEqDTneDjqS/zdEPzjNHP3DP0T8C4oBc15g2YiAAAAAASUVORK5CYII=</merchant_favicon>\n    <account_details>\n        <account_status>active</account_status>\n        <test_mode_enabled>false</test_mode_enabled>\n    </account_details>\n</nm_response>\n```\n</details>",
        "operationId": "query",
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "security_key": {
                    "required": true,
                    "type": "string",
                    "description": "API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys"
                  },
                  "condition": {
                    "type": "string",
                    "description": "A combination of values can be passed and should be separated by commas. \n\nFor example, to retrieve all transactions pending settlement or complete, the following could be used: \n\n`condition=pendingsettlement,complete`\n\n<details>\n<summary>Conditions</summary>\n\n| Condition          | Description                                                                                                                                                       |\n|:-------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| pending            | 'Auth Only' transactions that are awaiting capture.                                                                                                               |\n| pendingsettlement  | Transaction is awaiting settlement.                                                                                                                               |\n| in_progress        | Three-Step Redirect API transaction has not yet been completed. The transaction <br>condition will change to 'abandoned' if 24 hours pass with no further action. |\n| abandoned          | Three-Step Redirect API transaction has not been completed, and has timed out.                                                                                    |\n| failed             | Transaction has failed.                                                                                                                                           |\n| canceled           | Transaction has been voided.                                                                                                                                      |\n| complete           | Transaction has settled.                                                                                                                                          |\n| unknown            | An unknown error was encountered while processing this transaction.                                                                                               |\n\n</details>",
                    "enum": [
                      "pending",
                      "pendingsettlement",
                      "in_progress",
                      "abandoned",
                      "failed",
                      "canceled",
                      "complete",
                      "unknown"
                    ]
                  },
                  "transaction_type": {
                    "type": "string",
                    "description": "Retrieves only transactions with the specified transaction type.\n\n<details>\n<summary>Transaction Types</summary>\n\n| Transaction Type  | Description                 |\n|:------------------|:----------------------------|\n| cc                | A credit card transaction.  |\n| ck                | A check transaction.        |\n| cs                | A cash transaction.         |\n\n</details>",
                    "enum": [
                      "cc",
                      "ck",
                      "cs"
                    ]
                  },
                  "action_type": {
                    "type": "string",
                    "description": "Retrieves only transactions with the specified action types. A combination of the values can be used and <br>should be separated by commas.\n\nFor example, to retrieve all transactions with credit or refund actions, use the following:\n\n`action_type=refund,credit`\n\n<details>\n<summary>Action Types</summary>\n\n| Action Type  | Description                                                                                      |\n|:-------------|:-------------------------------------------------------------------------------------------------|\n| sale         | Sale transactions.                                                                               |\n| refund       | Refund transactions.                                                                             |\n| credit       | Credit transactions.                                                                             |\n| auth         | 'Auth Only' transactions.                                                                        |\n| capture      | Captured transactions.                                                                           |\n| void         | Voided transactions.                                                                             |\n| return       | Electronic Check (ACH) transactions that have returned, as well as credit card <br>chargebacks.  |\n| validate     | Validated transactions.                                                                          |\n\n</details>",
                    "enum": [
                      "sale",
                      "refund",
                      "credit",
                      "auth",
                      "capture",
                      "void",
                      "return",
                      "validate"
                    ]
                  },
                  "source": {
                    "type": "string",
                    "description": "Retrieves only transactions with a particular 'transaction source'. A combination of the values can be used <br>and should be separated by commas.\n\nFor example, to retrieve all transactions with api or recurring actions, use the following:\n\n`source=api,recurring`\n\n<details>\n<summary>Sources</summary>\n\n| Source           | Description                                                                                       |\n|:-----------------|:--------------------------------------------------------------------------------------------------|\n| api              | API transactions.                                                                                 |\n| batch_upload     | Batch Upload transactions.                                                                        |\n| mobile           | Mobile (iProcess) transactions.                                                                   |\n| quickclick       | QuickClick transactions.                                                                          |\n| quickbooks       | QuickBooks SyncPay transactions.                                                                  |\n| recurring        | Recurring transactions when using Recurring module.                                               |\n| swipe            | Swipe transactions.                                                                               |\n| virtual_terminal | Virtual Terminal transactions.                                                                    |\n| internal         | Internal transactions. Typically indicates settlement.                                            |\n\n</details>",
                    "enum": [
                      "api",
                      "batch_upload",
                      "mobile",
                      "quickclick",
                      "quickbooks",
                      "recurring",
                      "swipe",
                      "virtual_terminal",
                      "internal"
                    ]
                  },
                  "transaction_id": {
                    "type": "string",
                    "description": "Specify a transaction ID or a comma separated list of transaction IDs to retrieve information on.<br>Alternatively, provide a Subscription ID to retrieve processed (approved and declined) transactions <br>associated with it."
                  },
                  "subscription_id": {
                    "type": "string",
                    "description": "Set a specific subscription record or comma separated list of records. Using this with a transaction search <br>will return all transactions associated with this subscription. This will return this subscription's payment/plan <br>information when used with `report_type=recurring`."
                  },
                  "invoice_id": {
                    "type": "string",
                    "description": "Set a specific Invoice ID. Should only be used when `report_type=invoicing`."
                  },
                  "partial_payment_id": {
                    "type": "string",
                    "description": "Retrieves only transactions with the specified partial payment ID."
                  },
                  "order_id": {
                    "type": "string",
                    "description": "Retrieves only transactions with the specified Order ID."
                  },
                  "first_name": {
                    "type": "string",
                    "description": "Retrieves only transactions with the specified first name."
                  },
                  "last_name": {
                    "type": "string",
                    "description": "Retrieves only transactions with the specified last name."
                  },
                  "address1": {
                    "type": "string",
                    "description": "Retrieves only transactions with the specified specified address."
                  },
                  "city": {
                    "type": "string",
                    "description": "Retrieves only transactions with the specified city."
                  },
                  "state": {
                    "type": "string",
                    "description": "Retrieves only transactions with the specified state.\n  \nFormat: `CC`"
                  },
                  "zip": {
                    "type": "string",
                    "description": "Retrieves only transactions with the specified zip/postal code."
                  },
                  "phone": {
                    "type": "string",
                    "description": "Retrieves only transactions with the specified phone number."
                  },
                  "fax": {
                    "type": "string",
                    "description": "Retrieves only transactions with the specified fax number."
                  },
                  "order_description": {
                    "type": "string",
                    "description": "Retrieves only transactions with the specified order description."
                  },
                  "drivers_license_number": {
                    "type": "string",
                    "description": "Retrieves only transactions with the specified driver's license number."
                  },
                  "drivers_license_dob": {
                    "type": "string",
                    "description": "Retrieves only transactions with the specified driver's license date of birth."
                  },
                  "drivers_license_state": {
                    "type": "string",
                    "description": "Retrieves only transactions with the specified driver's license state."
                  },
                  "email": {
                    "type": "string",
                    "description": "Retrieves only transactions with the specified billing email address."
                  },
                  "cc_number": {
                    "type": "string",
                    "enum": [
                      "4111111111111111",
                      "5431111111111111",
                      "6011000991300009",
                      "341111111111111",
                      "30205252489926",
                      "3541963594572595",
                      "6799990100000000019",
                      "1111",
                      "0009",
                      "9926",
                      "2595",
                      "0019"
                    ],
                    "description": "Retrieves only transactions with the specified credit card number.\nYou can use either the full number or the last 4 digits of the credit card number.\n**Note:** The last four digits in the test card number for Visa, MasterCard, and American Express are identical. In order to receive type-specific transactions, use the full test card number.\n\n<details>\n<summary>Allowed Card Numbers:</summary>\n\n| Card Type                            | Test Card Number    |\n|:-------------------------------------|:--------------------|\n| Visa                                 | 4111111111111111    |\n| MasterCard                           | 5431111111111111    |\n| Discover                             | 6011000991300009    |\n| American Express                     | 341111111111111     |\n| Diner's Club                         | 30205252489926      |\n| JCB                                  | 3541963594572595    |\n| Maestro                              | 6799990100000000019 |\n| Visa, MasterCard, & American Express | 1111                |\n| Discover                             | 0009                |\n| Diner's Club                         | 9926                |\n| JCB                                  | 2595                |\n| Maestro                              | 0019                |\n\n</details>"
                  },
                  "merchant_defined_field_1": {
                    "type": "string",
                    "description": "Retrieves only transactions with the specified merchant defined field value.<br>Replace the '1' with a field number (1-20) (Example: `merchant_defined_field_12=value`)"
                  },
                  "start_date": {
                    "type": "string",
                    "format": "date-time",
                    "description": "Only transactions that have been modified on or after this date will be retrieved.<br>Note that any actions performed on a transaction will cause the modified date to be updated.<br><br>Format: `YYYYMMDDhhmmss`"
                  },
                  "end_date": {
                    "type": "string",
                    "format": "date-time",
                    "description": "Only transactions that have been modified on or before this date will be retrieved.<br>Note that any actions performed on a transaction will cause the modified date to be updated.<br><br>Format: `YYYYMMDDhhmmss`"
                  },
                  "report_type": {
                    "type": "string",
                    "enum": [
                      "receipt",
                      "customer_vault",
                      "recurring",
                      "recurring_plans",
                      "invoicing",
                      "gateway_processors",
                      "account_updater",
                      "test_mode_status",
                      "profile"
                    ],
                    "description": "Sets the report type.\n\n* If you would like to query the Customer Vault to view what customer information is stored in the Customer Vault, you must set the customer_vault variable.\n* If you omit the customer_vault_id, the system will return all customers that are stored in the vault.\n* If you include a customer_vault_id, it will return the customer record associated with that ID.\n\nExample: `report_type=customer_vault&customer_vault _id=123456789`\n\n<details>\n<summary>Report Types</summary>\n\n| Report Type        | Description                                                                                                                                                                            |\n|:-------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| receipt            | Will return an html receipt for a specified transaction id.                                                                                                                            |\n| customer_vault     | Set the Query API to return Customer Vault data.                                                                                                                                       |\n| recurring          | Set the Query API to return subscription data.                                                                                                                                         |\n| recurring_plans    | Set the Query API to return plan data.                                                                                                                                                 |\n| invoicing          | Set the Query API to return invoicing data.                                                                                                                                            |\n| gateway_processors | Will return Processor details a user has permissions for. Specify a \"user\" by <br>querying with that security key.                                                                     |\n| account_updater    | Will return Customer Vault data that has been updated using the <br>Account Updater service.                                                                                           |\n| test_mode_status   | Will return whether the account has test mode active or inactive.                                                                                                                      |\n| profile            | Return merchant profile (company, email, address, timezone, defined fields, <br>gateway, favicon, status). It will also return card_schemes with <br>'processor_details' set to 'true' |\n\n</details>"
                  },
                  "mobile_device_license": {
                    "type": "string",
                    "description": "Retrieves only transactions processed using the specified mobile device.\n\n* The device IDs for this parameter are available in the License Manager.\n* Use 'any_mobile' to retrieve all mobile transactions.\n* A combination of the values can be used and should be separated by commas.\n* Can not be used with 'mobile_device_nickname'.\n\nExample 1: `mobile_device_license=D91AC56A-4242-3131-2323-2AE4AA6DB6EB`\n<br>Example 2: `mobile_device_license=any_mobile`\n"
                  },
                  "mobile_device_nickname": {
                    "type": "string",
                    "description": "Retrieves only transactions processed using mobile devices with the specified nickname.\n\n* The nicknames for this parameter are available in the License Manager.\n* Can not be used with 'mobile_device_license'.\n\nExample (URL encoded): `mobile_device_nickname=Jim's%20iPhone`\n"
                  },
                  "customer_vault_id": {
                    "type": "string",
                    "description": "Set a specific Customer Vault record. Should only be used when `report_type=customer_vault`."
                  },
                  "date_search": {
                    "type": "string",
                    "enum": [
                      "created",
                      "updated"
                    ],
                    "description": "Allows Customer Vault information to be returned based on the 'created' or 'updated' date.\n\n* If you would like to query the Customer Vault to view when customer information was created or updated, you must set the report_type variable with the customer_vault value.\n* If you omit the report_type variable, the system will ignore the date_search variable.\n\nExample: `report_type=customer_vault&date_search=created,updated&start_date=20170101000000&end_date=20201231232359`\n\n| Value    | Description                                                             |\n|:---------|:------------------------------------------------------------------------|\n| created  | Will return Customer Vault data created during a specified date range.  |\n| updated  | Will return Customer Vault data updated during a specified date range.  |"
                  },
                  "result_limit": {
                    "type": "integer",
                    "description": "Determines the maximum number of results that may return for the current query."
                  },
                  "page_number": {
                    "type": "integer",
                    "description": "Determines which \"page\" of results are returned. For example, `result_limit=100&page_number=0` will return the first 100 results. Using `page_number=1` will return the next 100 results. Default - `0`."
                  },
                  "result_order": {
                    "type": "string",
                    "enum": [
                      "standard",
                      "reverse"
                    ],
                    "description": "Determines order of in which results are returned. Default - `standard`.\n\n<details>\n<summary>Result Orders</summary>\n\n| Result Order     | Description                                 |\n|:-----------------|:--------------------------------------------|\n| standard         | Returns the results from oldest to newest.  |\n| reverse          | Returns the results from newest to oldest.  |"
                  },
                  "invoice_status": {
                    "type": "string",
                    "description": "Specify a comma separated list of what invoice statuses will return when using an \"invoicing\" report type.<br><br>Example: `invoice_status=open,closed,paid`",
                    "enum": [
                      "open",
                      "paid",
                      "closed",
                      "past_due"
                    ]
                  },
                  "processor_details": {
                    "type": "string",
                    "description": "Can be use with `\"report_type\"=\"profile\"`, this will include merchant `\"card_schemes\"` in the response"
                  },
                  "additionalProperties": {
                    "type": "string",
                    "description": "Up to 20 `merchant_defined_field_#` are allowed."
                  }
                }
              },
              "examples": {
                "CompletedCreditCardTransactions": {
                  "$ref": "#/components/examples/CompletedCreditCardTransactions"
                },
                "PendingTransactions": {
                  "$ref": "#/components/examples/PendingTransactions"
                },
                "CustomerVault": {
                  "$ref": "#/components/examples/CustomerVault"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "ok",
            "content": {
              "application/xml": {
                "schema": {
                  "oneOf": [
                    {
                      "$ref": "#/components/schemas/QueryResponse"
                    },
                    {
                      "$ref": "#/components/schemas/QueryCustomerVaultResponse"
                    },
                    {
                      "$ref": "#/components/schemas/QueryRecurringResponse"
                    },
                    {
                      "$ref": "#/components/schemas/QueryRecurringPlanResponse"
                    },
                    {
                      "$ref": "#/components/schemas/QueryInvoicingResponse"
                    },
                    {
                      "$ref": "#/components/schemas/QueryGatewayProcessorResponse"
                    },
                    {
                      "$ref": "#/components/schemas/QueryProfileWithProcessorDetailsResponse"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  },
  "webhooks": {
    "transaction": {
      "post": {
        "tags": [
          "Webhook Events"
        ],
        "security": [],
        "summary": "Transaction Event",
        "description": "Sales, auths, captures, voids, refunds, and credits. Each transaction type can be filtered by successful, failed, and unknown transactions.",
        "operationId": "transactionEvent",
        "parameters": [
          {
            "$ref": "#/components/parameters/WebhookSignature"
          }
        ],
        "requestBody": {
          "description": "Event about a transaction",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "event_id",
                  "event_type",
                  "event_body"
                ],
                "properties": {
                  "event_id": {
                    "type": "string",
                    "description": "Event ID"
                  },
                  "event_type": {
                    "type": "string",
                    "enum": [
                      "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"
                    ],
                    "description": "Transaction Event Type"
                  },
                  "event_body": {
                    "type": "object",
                    "title": "Event Body",
                    "description": "Transaction Details",
                    "properties": {
                      "merchant": {
                        "$ref": "#/components/schemas/Merchant"
                      },
                      "features": {
                        "$ref": "#/components/schemas/Features"
                      },
                      "transaction_id": {
                        "type": "string",
                        "description": "Transaction ID"
                      },
                      "transaction_type": {
                        "type": "string",
                        "enum": [
                          "cc",
                          "ck",
                          "cs"
                        ],
                        "description": "Transaction Type (cc - credit card, ck - check, cs - cash sale)"
                      },
                      "condition": {
                        "type": "string",
                        "enum": [
                          "pending",
                          "pendingsettlement",
                          "in_progress",
                          "abandoned",
                          "failed",
                          "canceled",
                          "complete",
                          "unknown"
                        ],
                        "description": "Transaction condition"
                      },
                      "processor_id": {
                        "type": "string",
                        "description": "Processor ID"
                      },
                      "ponumber": {
                        "type": "string",
                        "description": "Purchase order number"
                      },
                      "order_description": {
                        "type": "string",
                        "description": "Order description"
                      },
                      "order_id": {
                        "type": "string",
                        "description": "Order ID"
                      },
                      "customerid": {
                        "type": "string",
                        "description": "Customer ID"
                      },
                      "customertaxid": {
                        "type": "string",
                        "description": "Customer tax ID"
                      },
                      "website": {
                        "type": "string",
                        "description": "Website URL"
                      },
                      "shipping": {
                        "type": "string",
                        "description": "Shipping amount"
                      },
                      "currency": {
                        "type": "string",
                        "description": "Currency code"
                      },
                      "tax": {
                        "type": "string",
                        "description": "Tax amount"
                      },
                      "surcharge": {
                        "type": "string",
                        "description": "Surcharge amount."
                      },
                      "convenience_fee": {
                        "type": "string",
                        "description": "Convenience Fee amount."
                      },
                      "misc_fee": {
                        "type": "string",
                        "description": "Miscellaneous Fee amount."
                      },
                      "misc_fee_name": {
                        "type": "string",
                        "description": "Miscellaneous Fee Name."
                      },
                      "cash_discount": {
                        "type": "string",
                        "description": "How much less a customer paid due to a cash discount. Format: x.xx, only applicable to cash and check transactions"
                      },
                      "tip": {
                        "type": "string",
                        "description": "The final tip amount, included in the transaction, associated with the purchase"
                      },
                      "requested_amount": {
                        "type": "string",
                        "format": "decimal",
                        "description": "Requested amount"
                      },
                      "shipping_carrier": {
                        "type": "string",
                        "enum": [
                          "ups",
                          "fedex",
                          "dhl",
                          "usps",
                          ""
                        ],
                        "description": "Shipping carrier."
                      },
                      "tracking_number": {
                        "type": "string",
                        "description": "Shipping tracking number."
                      },
                      "shipping_date": {
                        "type": "string",
                        "description": "Shipping date."
                      },
                      "partial_payment_id": {
                        "type": "string",
                        "description": "A numeric identifier which is used when submitting subsequent transactions."
                      },
                      "partial_payment_balance": {
                        "type": "string",
                        "description": "The payment's remaining balance."
                      },
                      "platform_id": {
                        "type": "string",
                        "description": "Platform ID associated with the transaction."
                      },
                      "authorization_code": {
                        "type": "string",
                        "description": "Transaction authorization code."
                      },
                      "social_security_number": {
                        "type": "string",
                        "description": "Customer's social security number."
                      },
                      "drivers_license_number": {
                        "type": "string",
                        "description": "Driver's license number."
                      },
                      "drivers_license_state": {
                        "type": "string",
                        "description": "The state that issued the customer's driver's license."
                      },
                      "drivers_license_dob": {
                        "type": "string",
                        "description": "Driver's license date of birth."
                      },
                      "duty_amount": {
                        "type": "string",
                        "description": "Duty amount."
                      },
                      "discount_amount": {
                        "type": "string",
                        "description": "Discount amount."
                      },
                      "national_tax_amount": {
                        "type": "string",
                        "description": "National tax amount."
                      },
                      "summary_commodity_code": {
                        "type": "string",
                        "description": "Summary commodity code."
                      },
                      "alternate_tax_amount": {
                        "type": "string",
                        "format": "decimal",
                        "description": "Alternate tax amount."
                      },
                      "vat_tax_amount": {
                        "type": "string",
                        "format": "decimal",
                        "description": "VAT tax amount."
                      },
                      "vat_tax_rate": {
                        "type": "string",
                        "format": "decimal",
                        "description": "VAT tax rate."
                      },
                      "billing_address": {
                        "$ref": "#/components/schemas/BillingAddress"
                      },
                      "shipping_address": {
                        "$ref": "#/components/schemas/ShippingAddress"
                      },
                      "card": {
                        "$ref": "#/components/schemas/CardDetails"
                      },
                      "check": {
                        "$ref": "#/components/schemas/CheckDetails"
                      },
                      "emv_meta_data": {
                        "$ref": "#/components/schemas/EmvMetaData"
                      },
                      "action": {
                        "$ref": "#/components/schemas/TransactionAction"
                      },
                      "merchant_defined_fields": {
                        "type": "object",
                        "description": "Merchant defined fields",
                        "additionalProperties": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              },
              "examples": {
                "AuthSuccess": {
                  "$ref": "#/components/examples/auth-success"
                },
                "AuthFailed": {
                  "$ref": "#/components/examples/auth-failed"
                },
                "CaptureSuccess": {
                  "$ref": "#/components/examples/capture-success"
                },
                "SaleSuccess": {
                  "$ref": "#/components/examples/sale-success"
                },
                "SaleFailure": {
                  "$ref": "#/components/examples/sale-failure"
                },
                "VoidSuccess": {
                  "$ref": "#/components/examples/void-success"
                },
                "RefundSuccess": {
                  "$ref": "#/components/examples/refund-success"
                },
                "ValidateSuccess": {
                  "$ref": "#/components/examples/validate-success"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Return a 200 status to indicate that the data was received successfully"
          }
        }
      }
    },
    "recurring": {
      "post": {
        "tags": [
          "Webhook Events"
        ],
        "security": [],
        "summary": "Recurring Event",
        "description": "Events related to Recurring transactions (plans, subscriptions).",
        "operationId": "recurringEvent",
        "parameters": [
          {
            "$ref": "#/components/parameters/WebhookSignature"
          }
        ],
        "requestBody": {
          "description": "Recurring Event",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "event_id",
                  "event_type",
                  "event_body"
                ],
                "properties": {
                  "event_id": {
                    "type": "string",
                    "description": "Event ID"
                  },
                  "event_type": {
                    "type": "string",
                    "enum": [
                      "recurring.plan.add",
                      "recurring.plan.update",
                      "recurring.plan.delete",
                      "recurring.subscription.add",
                      "recurring.subscription.update",
                      "recurring.subscription.delete"
                    ],
                    "description": "Recurring Event Type"
                  },
                  "event_body": {
                    "$ref": "#/components/schemas/RecurringEventBody"
                  }
                }
              },
              "examples": {
                "PlanAdded": {
                  "$ref": "#/components/examples/plan-added"
                },
                "PlanUpdated": {
                  "$ref": "#/components/examples/plan-updated"
                },
                "PlanDeleted": {
                  "$ref": "#/components/examples/plan-deleted"
                },
                "SubscriptionAdded": {
                  "$ref": "#/components/examples/subscription-added"
                },
                "SubscriptionUpdated": {
                  "$ref": "#/components/examples/subscription-updated"
                },
                "SubscriptionDeleted": {
                  "$ref": "#/components/examples/subscription-deleted"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Return a 200 status to indicate that the data was received successfully"
          }
        }
      }
    },
    "settlement": {
      "post": {
        "tags": [
          "Webhook Events"
        ],
        "security": [],
        "summary": "Settlement Event",
        "description": "Events related to Settlement.",
        "operationId": "settlementEvent",
        "parameters": [
          {
            "$ref": "#/components/parameters/WebhookSignature"
          }
        ],
        "requestBody": {
          "description": "Settlement Event",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "event_id",
                  "event_type",
                  "event_body"
                ],
                "properties": {
                  "event_id": {
                    "type": "string",
                    "description": "Event ID"
                  },
                  "event_type": {
                    "type": "string",
                    "enum": [
                      "settlement.batch.complete",
                      "settlement.batch.failure"
                    ],
                    "description": "Settlement Event Type"
                  },
                  "event_body": {
                    "$ref": "#/components/schemas/SettlementEventBody"
                  }
                }
              },
              "examples": {
                "SettlementCompleted": {
                  "$ref": "#/components/examples/settlement-completed"
                },
                "SettlementFailed": {
                  "$ref": "#/components/examples/settlement-failed"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Return a 200 status to indicate that the data was received successfully"
          }
        }
      }
    },
    "acu": {
      "post": {
        "tags": [
          "Webhook Events"
        ],
        "security": [],
        "summary": "Automatic Card Updater Event",
        "description": "Events related to Automatic Card Updater.",
        "operationId": "acuEvent",
        "parameters": [
          {
            "$ref": "#/components/parameters/WebhookSignature"
          }
        ],
        "requestBody": {
          "description": "Automatic Card Updater (ACU) Event",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "event_id",
                  "event_type",
                  "event_body"
                ],
                "properties": {
                  "event_id": {
                    "type": "string",
                    "description": "Event ID"
                  },
                  "event_type": {
                    "type": "string",
                    "enum": [
                      "acu.summary.automaticallyupdated",
                      "acu.summary.contactcustomer",
                      "acu.summary.closedaccount"
                    ],
                    "description": "Automatic Card Updater (ACU) Event Type"
                  },
                  "event_body": {
                    "oneOf": [
                      {
                        "$ref": "#/components/schemas/AcuAutoUpdatedEventBody"
                      },
                      {
                        "$ref": "#/components/schemas/AcuClosedAccountEventBody"
                      },
                      {
                        "$ref": "#/components/schemas/AcuContactCustomerEventBody"
                      }
                    ]
                  }
                }
              },
              "examples": {
                "AcuAutomaticallyUpdated": {
                  "$ref": "#/components/examples/acu.summary.automaticallyupdated"
                },
                "AcuClosedAccount": {
                  "$ref": "#/components/examples/acu.summary.closedaccount"
                },
                "AcuContactCustomer": {
                  "$ref": "#/components/examples/acu.summary.contactcustomer"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Return a 200 status to indicate that the data was received successfully"
          }
        }
      }
    },
    "chargeback": {
      "post": {
        "tags": [
          "Webhook Events"
        ],
        "security": [],
        "summary": "Chargeback Event",
        "description": "Events related to Chargebacks.",
        "operationId": "chargebackEvent",
        "parameters": [
          {
            "$ref": "#/components/parameters/WebhookSignature"
          }
        ],
        "requestBody": {
          "description": "Chargeback Event",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "event_id",
                  "event_type",
                  "event_body"
                ],
                "properties": {
                  "event_id": {
                    "type": "string",
                    "description": "Chargeback Event ID"
                  },
                  "event_type": {
                    "type": "string",
                    "enum": [
                      "chargeback.batch.complete"
                    ],
                    "description": "Chargeback Event Type"
                  },
                  "event_body": {
                    "type": "object",
                    "required": [
                      "merchant",
                      "processor",
                      "count",
                      "chargeback_amount",
                      "chargebacks"
                    ],
                    "description": "Chargeback Event Body",
                    "properties": {
                      "merchant": {
                        "$ref": "#/components/schemas/Merchant"
                      },
                      "processor": {
                        "type": "object",
                        "title": "Processor",
                        "description": "Processor information",
                        "required": [
                          "id",
                          "name",
                          "type"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "description": "Processor ID"
                          },
                          "name": {
                            "type": "string",
                            "description": "Processor Name"
                          },
                          "type": {
                            "type": "string",
                            "description": "Processor Type"
                          }
                        }
                      },
                      "count": {
                        "type": "integer",
                        "description": "Number of chargebacks"
                      },
                      "chargeback_amount": {
                        "type": "string",
                        "description": "Total chargebacks amount"
                      },
                      "chargebacks": {
                        "type": "array",
                        "title": "Chargebacks",
                        "description": "List of chargebacks",
                        "items": {
                          "type": "object",
                          "required": [
                            "id",
                            "date",
                            "customer_name",
                            "cc_number",
                            "amount",
                            "reason"
                          ],
                          "properties": {
                            "id": {
                              "type": "string",
                              "description": "Chargeback ID"
                            },
                            "date": {
                              "type": "string",
                              "description": "Chargeback Date"
                            },
                            "customer_name": {
                              "type": "string",
                              "description": "Customer Name"
                            },
                            "cc_number": {
                              "type": "string",
                              "description": "Masked Credit Card Number"
                            },
                            "amount": {
                              "type": "string",
                              "description": "Chargeback Amount"
                            },
                            "reason": {
                              "type": "string",
                              "description": "Chargeback Reason"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              },
              "examples": {
                "ChargebackBatchCompleted": {
                  "$ref": "#/components/examples/chargeback.batch.complete"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Return a 200 status to indicate that the data was received successfully"
          }
        }
      }
    }
  },
  "components": {
    "examples": {
      "CompletedCreditCardTransactions": {
        "summary": "Completed Credit Card Transaction",
        "description": "Retrieves completed credit card `sale` transactions",
        "value": {
          "condition": "complete",
          "transaction_type": "cc",
          "action_type": "sale",
          "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm"
        }
      },
      "PendingTransactions": {
        "summary": "Pending Transaction",
        "description": "Retrieves pending transactions",
        "value": {
          "condition": "pending",
          "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm"
        }
      },
      "CustomerVault": {
        "summary": "Customer Vault",
        "description": "Retrieves customer profiles. Pass `customer_vault_id` parameter to filter by specific customer.",
        "value": {
          "report_type": "customer_vault",
          "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm"
        }
      },
      "auth-success": {
        "summary": "Successful Authorization",
        "description": "This transaction was successfully authorized.",
        "value": {
          "event_id": "322ac05a-cf6c-4c16-948a-3048d007f742",
          "event_type": "transaction.auth.success",
          "event_body": {
            "merchant": {
              "id": "944025",
              "name": "Test merchant account"
            },
            "features": {
              "is_test_mode": true
            },
            "transaction_id": "8584341675",
            "transaction_type": "cc",
            "condition": "pending",
            "processor_id": "ccprocessora",
            "ponumber": "",
            "order_description": "",
            "order_id": "",
            "customerid": "",
            "customertaxid": "",
            "website": "",
            "shipping": "",
            "currency": "USD",
            "tax": "",
            "surcharge": "",
            "convenience_fee": "",
            "misc_fee": "",
            "misc_fee_name": "",
            "cash_discount": "",
            "tip": "",
            "requested_amount": "10.00",
            "shipping_carrier": "",
            "tracking_number": "",
            "shipping_date": "",
            "partial_payment_id": "",
            "partial_payment_balance": "",
            "platform_id": "",
            "authorization_code": "123456",
            "social_security_number": "",
            "drivers_license_number": "",
            "drivers_license_state": "",
            "drivers_license_dob": "",
            "duty_amount": "0.00",
            "discount_amount": "0.00",
            "national_tax_amount": "0.00",
            "summary_commodity_code": "",
            "alternate_tax_amount": "0.00",
            "vat_tax_amount": "0.00",
            "vat_tax_rate": "0.00",
            "billing_address": {
              "first_name": "",
              "last_name": "",
              "address_1": "",
              "address_2": "",
              "company": "",
              "city": "",
              "state": "",
              "postal_code": "",
              "country": "",
              "email": "",
              "phone": "",
              "cell_phone": "",
              "fax": ""
            },
            "shipping_address": {
              "first_name": "",
              "last_name": "",
              "address_1": "",
              "address_2": "",
              "company": "",
              "city": "",
              "state": "",
              "postal_code": "",
              "country": "",
              "email": "",
              "phone": "",
              "fax": ""
            },
            "card": {
              "cc_number": "411111******1111",
              "cc_exp": "1025",
              "cavv": "",
              "cavv_result": "",
              "xid": "",
              "eci": "",
              "avs_response": "",
              "csc_response": "M",
              "cardholder_auth": "",
              "cc_start_date": "",
              "cc_issue_number": "",
              "card_balance": "",
              "card_available_balance": "",
              "entry_mode": "4",
              "cc_bin": "",
              "cc_type": "Visa",
              "feature_token": ""
            },
            "merchant_defined_fields": {},
            "action": {
              "amount": "10.00",
              "action_type": "auth",
              "date": "20230801113700",
              "success": "1",
              "ip_address": "123.123.123.123",
              "source": "api",
              "api_method": "direct_post",
              "username": "test",
              "response_text": "SUCCESS",
              "response_code": "100",
              "processor_response_text": "",
              "tap_to_mobile": false,
              "processor_response_code": "",
              "device_license_number": "",
              "device_nickname": ""
            }
          }
        }
      },
      "auth-failed": {
        "summary": "Failed Authorization",
        "description": "The authorization request was declined by the processor.",
        "value": {
          "event_id": "322ac05a-cf6c-4c16-948a-3048d007f742",
          "event_type": "transaction.auth.failure",
          "event_body": {
            "merchant": {
              "id": "944025",
              "name": "Test merchant account"
            },
            "features": {
              "is_test_mode": true
            },
            "transaction_id": "8597004002",
            "transaction_type": "cc",
            "condition": "failed",
            "processor_id": "ccprocessora",
            "ponumber": "",
            "order_description": "",
            "order_id": "",
            "customerid": "",
            "customertaxid": "",
            "website": "",
            "shipping": "",
            "currency": "USD",
            "tax": "",
            "surcharge": "",
            "convenience_fee": "",
            "misc_fee": "",
            "misc_fee_name": "",
            "cash_discount": "",
            "tip": "",
            "requested_amount": "0.50",
            "shipping_carrier": "",
            "tracking_number": "",
            "shipping_date": "",
            "partial_payment_id": "",
            "partial_payment_balance": "",
            "platform_id": "",
            "authorization_code": "123456",
            "social_security_number": "",
            "drivers_license_number": "",
            "drivers_license_state": "",
            "drivers_license_dob": "",
            "duty_amount": "0.00",
            "discount_amount": "0.00",
            "national_tax_amount": "0.00",
            "summary_commodity_code": "",
            "alternate_tax_amount": "0.00",
            "vat_tax_amount": "0.00",
            "vat_tax_rate": "0.00",
            "billing_address": {
              "first_name": "",
              "last_name": "",
              "address_1": "",
              "address_2": "",
              "company": "",
              "city": "",
              "state": "",
              "postal_code": "",
              "country": "",
              "email": "",
              "phone": "",
              "cell_phone": "",
              "fax": ""
            },
            "shipping_address": {
              "first_name": "",
              "last_name": "",
              "address_1": "",
              "address_2": "",
              "company": "",
              "city": "",
              "state": "",
              "postal_code": "",
              "country": "",
              "email": "",
              "phone": "",
              "fax": ""
            },
            "card": {
              "cc_number": "411111******1111",
              "cc_exp": "1025",
              "cavv": "",
              "cavv_result": "",
              "xid": "",
              "eci": "",
              "avs_response": "",
              "csc_response": "M",
              "cardholder_auth": "",
              "cc_start_date": "",
              "cc_issue_number": "",
              "card_balance": "",
              "card_available_balance": "",
              "entry_mode": "4",
              "cc_bin": "",
              "cc_type": "Visa",
              "feature_token": ""
            },
            "merchant_defined_fields": {},
            "action": {
              "amount": "10.00",
              "action_type": "auth",
              "date": "20230801113700",
              "success": "0",
              "ip_address": "123.123.123.123",
              "source": "api",
              "api_method": "direct_post",
              "username": "test",
              "response_text": "DECLINE",
              "response_code": "200",
              "processor_response_text": "",
              "tap_to_mobile": false,
              "processor_response_code": "",
              "device_license_number": "",
              "device_nickname": ""
            }
          }
        }
      },
      "capture-success": {
        "summary": "Transaction captured successfully",
        "description": "Transaction captured successfully",
        "value": {
          "event_id": "e5267749-c235-45c9-b93e-21f4379b94d1",
          "event_type": "transaction.capture.success",
          "event_body": {
            "merchant": {
              "id": "944025",
              "name": "Test merchant account"
            },
            "features": {
              "is_test_mode": true
            },
            "transaction_id": "8584341675",
            "transaction_type": "cc",
            "condition": "pendingsettlement",
            "processor_id": "ccprocessora",
            "ponumber": "",
            "order_description": "",
            "order_id": "",
            "customerid": "",
            "customertaxid": "",
            "website": "",
            "shipping": "0.00",
            "currency": "USD",
            "tax": "0.00",
            "surcharge": "",
            "convenience_fee": "",
            "misc_fee": "",
            "misc_fee_name": "",
            "cash_discount": "",
            "tip": "",
            "requested_amount": "10.00",
            "shipping_carrier": "",
            "tracking_number": "",
            "shipping_date": "",
            "partial_payment_id": "",
            "partial_payment_balance": "",
            "platform_id": "",
            "authorization_code": "123456",
            "social_security_number": "",
            "drivers_license_number": "",
            "drivers_license_state": "",
            "drivers_license_dob": "",
            "duty_amount": "0.00",
            "discount_amount": "0.00",
            "national_tax_amount": "0.00",
            "summary_commodity_code": "",
            "alternate_tax_amount": "0.00",
            "vat_tax_amount": "0.00",
            "vat_tax_rate": "0.00",
            "billing_address": {
              "first_name": "",
              "last_name": "",
              "address_1": "",
              "address_2": "",
              "company": "",
              "city": "",
              "state": "",
              "postal_code": "",
              "country": "",
              "email": "",
              "phone": "",
              "cell_phone": "",
              "fax": ""
            },
            "shipping_address": {
              "first_name": "",
              "last_name": "",
              "address_1": "",
              "address_2": "",
              "company": "",
              "city": "",
              "state": "",
              "postal_code": "",
              "country": "",
              "email": "",
              "phone": "",
              "fax": ""
            },
            "card": {
              "cc_number": "411111******1111",
              "cc_exp": "1025",
              "cavv": "",
              "cavv_result": "",
              "xid": "",
              "eci": "",
              "avs_response": "",
              "csc_response": "M",
              "cardholder_auth": "",
              "cc_start_date": "",
              "cc_issue_number": "",
              "card_balance": "",
              "card_available_balance": "",
              "entry_mode": "4",
              "cc_bin": "",
              "cc_type": "Visa",
              "feature_token": ""
            },
            "merchant_defined_fields": {},
            "action": {
              "amount": "10.00",
              "action_type": "capture",
              "date": "20230801113955",
              "success": "1",
              "ip_address": "123.123.123.123",
              "source": "api",
              "api_method": "direct_post",
              "username": "test",
              "response_text": "SUCCESS",
              "response_code": "100",
              "processor_response_text": "",
              "tap_to_mobile": false,
              "processor_response_code": "",
              "device_license_number": "",
              "device_nickname": ""
            }
          }
        }
      },
      "sale-success": {
        "summary": "Sale transaction was successful",
        "description": "Sale transaction was successful",
        "value": {
          "event_id": "2aa1bb86-c790-4231-a46e-7cc544a8dc5c",
          "event_type": "transaction.sale.success",
          "event_body": {
            "merchant": {
              "id": "944025",
              "name": "Test merchant account"
            },
            "features": {
              "is_test_mode": true
            },
            "transaction_id": "8584364761",
            "transaction_type": "cc",
            "condition": "pendingsettlement",
            "processor_id": "ccprocessora",
            "ponumber": "",
            "order_description": "",
            "order_id": "",
            "customerid": "",
            "customertaxid": "",
            "website": "",
            "shipping": "",
            "currency": "USD",
            "tax": "",
            "surcharge": "",
            "convenience_fee": "",
            "misc_fee": "",
            "misc_fee_name": "",
            "cash_discount": "",
            "tip": "",
            "requested_amount": "10.00",
            "shipping_carrier": "",
            "tracking_number": "",
            "shipping_date": "",
            "partial_payment_id": "",
            "partial_payment_balance": "",
            "platform_id": "",
            "authorization_code": "123456",
            "social_security_number": "",
            "drivers_license_number": "",
            "drivers_license_state": "",
            "drivers_license_dob": "",
            "duty_amount": "0.00",
            "discount_amount": "0.00",
            "national_tax_amount": "0.00",
            "summary_commodity_code": "",
            "alternate_tax_amount": "0.00",
            "vat_tax_amount": "0.00",
            "vat_tax_rate": "0.00",
            "billing_address": {
              "first_name": "",
              "last_name": "",
              "address_1": "",
              "address_2": "",
              "company": "",
              "city": "",
              "state": "",
              "postal_code": "",
              "country": "",
              "email": "",
              "phone": "",
              "cell_phone": "",
              "fax": ""
            },
            "shipping_address": {
              "first_name": "",
              "last_name": "",
              "address_1": "",
              "address_2": "",
              "company": "",
              "city": "",
              "state": "",
              "postal_code": "",
              "country": "",
              "email": "",
              "phone": "",
              "fax": ""
            },
            "card": {
              "cc_number": "411111******1111",
              "cc_exp": "1025",
              "cavv": "",
              "cavv_result": "",
              "xid": "",
              "eci": "",
              "avs_response": "",
              "csc_response": "M",
              "cardholder_auth": "",
              "cc_start_date": "",
              "cc_issue_number": "",
              "card_balance": "",
              "card_available_balance": "",
              "entry_mode": "4",
              "cc_bin": "",
              "cc_type": "Visa",
              "feature_token": ""
            },
            "merchant_defined_fields": {},
            "action": {
              "amount": "10.00",
              "action_type": "sale",
              "date": "20230801114200",
              "success": "1",
              "ip_address": "123.123.123.123",
              "source": "api",
              "api_method": "direct_post",
              "username": "test",
              "response_text": "SUCCESS",
              "response_code": "100",
              "processor_response_text": "",
              "tap_to_mobile": false,
              "processor_response_code": "",
              "device_license_number": "",
              "device_nickname": ""
            }
          }
        }
      },
      "sale-failure": {
        "summary": "Sale transaction failed",
        "description": "Sale transaction failed",
        "value": {
          "event_id": "a4807d52-4e40-4e93-92e2-b6d2dad3ddd9",
          "event_type": "transaction.sale.failure",
          "event_body": {
            "merchant": {
              "id": "944025",
              "name": "Test merchant account"
            },
            "features": {
              "is_test_mode": true
            },
            "transaction_id": "8584372177",
            "transaction_type": "cc",
            "condition": "failed",
            "processor_id": "ccprocessora",
            "ponumber": "",
            "order_description": "",
            "order_id": "",
            "customerid": "",
            "customertaxid": "",
            "website": "",
            "shipping": "",
            "currency": "USD",
            "tax": "",
            "surcharge": "",
            "convenience_fee": "",
            "misc_fee": "",
            "misc_fee_name": "",
            "cash_discount": "",
            "tip": "",
            "requested_amount": "0.50",
            "shipping_carrier": "",
            "tracking_number": "",
            "shipping_date": "",
            "partial_payment_id": "",
            "partial_payment_balance": "",
            "platform_id": "",
            "authorization_code": "",
            "social_security_number": "",
            "drivers_license_number": "",
            "drivers_license_state": "",
            "drivers_license_dob": "",
            "duty_amount": "0.00",
            "discount_amount": "0.00",
            "national_tax_amount": "0.00",
            "summary_commodity_code": "",
            "alternate_tax_amount": "0.00",
            "vat_tax_amount": "0.00",
            "vat_tax_rate": "0.00",
            "billing_address": {
              "first_name": "",
              "last_name": "",
              "address_1": "",
              "address_2": "",
              "company": "",
              "city": "",
              "state": "",
              "postal_code": "",
              "country": "",
              "email": "",
              "phone": "",
              "cell_phone": "",
              "fax": ""
            },
            "shipping_address": {
              "first_name": "",
              "last_name": "",
              "address_1": "",
              "address_2": "",
              "company": "",
              "city": "",
              "state": "",
              "postal_code": "",
              "country": "",
              "email": "",
              "phone": "",
              "fax": ""
            },
            "card": {
              "cc_number": "411111******1111",
              "cc_exp": "1025",
              "cavv": "",
              "cavv_result": "",
              "xid": "",
              "eci": "",
              "avs_response": "",
              "csc_response": "M",
              "cardholder_auth": "",
              "cc_start_date": "",
              "cc_issue_number": "",
              "card_balance": "",
              "card_available_balance": "",
              "entry_mode": "4",
              "cc_bin": "",
              "cc_type": "Visa",
              "feature_token": ""
            },
            "merchant_defined_fields": {},
            "action": {
              "amount": "0.50",
              "action_type": "sale",
              "date": "20230801114355",
              "success": "0",
              "ip_address": "123.123.123.123",
              "source": "api",
              "api_method": "direct_post",
              "username": "test",
              "response_text": "DECLINE",
              "response_code": "200",
              "processor_response_text": "",
              "tap_to_mobile": false,
              "processor_response_code": "",
              "device_license_number": "",
              "device_nickname": ""
            }
          }
        }
      },
      "void-success": {
        "summary": "Void transaction was successful",
        "description": "Void transaction was successful",
        "value": {
          "event_id": "56fce295-ee70-46a1-83c2-1f423c43c34c",
          "event_type": "transaction.void.success",
          "event_body": {
            "merchant": {
              "id": "944025",
              "name": "Test merchant account"
            },
            "features": {
              "is_test_mode": true
            },
            "transaction_id": "8584341675",
            "transaction_type": "cc",
            "condition": "canceled",
            "processor_id": "ccprocessora",
            "ponumber": "",
            "order_description": "",
            "order_id": "",
            "customerid": "",
            "customertaxid": "",
            "website": "",
            "shipping": "0.00",
            "currency": "USD",
            "tax": "0.00",
            "surcharge": "",
            "convenience_fee": "",
            "misc_fee": "",
            "misc_fee_name": "",
            "cash_discount": "",
            "tip": "",
            "requested_amount": "10.00",
            "shipping_carrier": "",
            "tracking_number": "",
            "shipping_date": "",
            "partial_payment_id": "",
            "partial_payment_balance": "",
            "platform_id": "",
            "authorization_code": "123456",
            "social_security_number": "",
            "drivers_license_number": "",
            "drivers_license_state": "",
            "drivers_license_dob": "",
            "duty_amount": "0.00",
            "discount_amount": "0.00",
            "national_tax_amount": "0.00",
            "summary_commodity_code": "",
            "alternate_tax_amount": "0.00",
            "vat_tax_amount": "0.00",
            "vat_tax_rate": "0.00",
            "billing_address": {
              "first_name": "",
              "last_name": "",
              "address_1": "",
              "address_2": "",
              "company": "",
              "city": "",
              "state": "",
              "postal_code": "",
              "country": "",
              "email": "",
              "phone": "",
              "cell_phone": "",
              "fax": ""
            },
            "shipping_address": {
              "first_name": "",
              "last_name": "",
              "address_1": "",
              "address_2": "",
              "company": "",
              "city": "",
              "state": "",
              "postal_code": "",
              "country": "",
              "email": "",
              "phone": "",
              "fax": ""
            },
            "card": {
              "cc_number": "411111******1111",
              "cc_exp": "1025",
              "cavv": "",
              "cavv_result": "",
              "xid": "",
              "eci": "",
              "avs_response": "",
              "csc_response": "M",
              "cardholder_auth": "",
              "cc_start_date": "",
              "cc_issue_number": "",
              "card_balance": "",
              "card_available_balance": "",
              "entry_mode": "4",
              "cc_bin": "",
              "cc_type": "Visa",
              "feature_token": ""
            },
            "merchant_defined_fields": {},
            "action": {
              "amount": "10.00",
              "action_type": "void",
              "date": "20230801115329",
              "success": "1",
              "ip_address": "123.123.123.123",
              "source": "api",
              "api_method": "direct_post",
              "username": "test",
              "response_text": "SUCCESS",
              "response_code": "100",
              "processor_response_text": "",
              "tap_to_mobile": false,
              "processor_response_code": "",
              "device_license_number": "",
              "device_nickname": ""
            }
          }
        }
      },
      "refund-success": {
        "summary": "Transaction refunded successfully",
        "description": "Transaction refunded successfully",
        "value": {
          "event_id": "e5267749-c235-45c9-b93e-21f4379b94d1",
          "event_type": "transaction.refund.success",
          "event_body": {
            "merchant": {
              "id": "944025",
              "name": "Test merchant account"
            },
            "features": {
              "is_test_mode": true
            },
            "transaction_id": "8597047042",
            "transaction_type": "cc",
            "condition": "pendingsettlement",
            "processor_id": "ccprocessora",
            "ponumber": "",
            "order_description": "",
            "order_id": "",
            "customerid": "",
            "customertaxid": "",
            "website": "",
            "shipping": "0.00",
            "currency": "USD",
            "tax": "0.00",
            "surcharge": "",
            "convenience_fee": "",
            "misc_fee": "",
            "misc_fee_name": "",
            "cash_discount": "",
            "tip": "",
            "requested_amount": "-1.50",
            "shipping_carrier": "",
            "tracking_number": "",
            "shipping_date": "",
            "partial_payment_id": "",
            "partial_payment_balance": "",
            "platform_id": "",
            "authorization_code": "123456",
            "social_security_number": "",
            "drivers_license_number": "",
            "drivers_license_state": "",
            "drivers_license_dob": "",
            "duty_amount": "0.00",
            "discount_amount": "0.00",
            "national_tax_amount": "0.00",
            "summary_commodity_code": "",
            "alternate_tax_amount": "0.00",
            "vat_tax_amount": "0.00",
            "vat_tax_rate": "0.00",
            "billing_address": {
              "first_name": "",
              "last_name": "",
              "address_1": "",
              "address_2": "",
              "company": "",
              "city": "",
              "state": "",
              "postal_code": "",
              "country": "",
              "email": "",
              "phone": "",
              "cell_phone": "",
              "fax": ""
            },
            "shipping_address": {
              "first_name": "",
              "last_name": "",
              "address_1": "",
              "address_2": "",
              "company": "",
              "city": "",
              "state": "",
              "postal_code": "",
              "country": "",
              "email": "",
              "phone": "",
              "fax": ""
            },
            "card": {
              "cc_number": "411111******1111",
              "cc_exp": "1025",
              "cavv": "",
              "cavv_result": "",
              "xid": "",
              "eci": "",
              "avs_response": "",
              "csc_response": "",
              "cardholder_auth": "",
              "cc_start_date": "",
              "cc_issue_number": "",
              "card_balance": "",
              "card_available_balance": "",
              "entry_mode": "4",
              "cc_bin": "",
              "cc_type": "Visa",
              "feature_token": ""
            },
            "merchant_defined_fields": {},
            "action": {
              "amount": "-1.50",
              "action_type": "refund",
              "date": "20230804155935",
              "success": "1",
              "ip_address": "123.123.123.123",
              "source": "api",
              "api_method": "direct_post",
              "username": "test",
              "response_text": "SUCCESS",
              "response_code": "100",
              "processor_response_text": "",
              "tap_to_mobile": false,
              "processor_response_code": "",
              "device_license_number": "",
              "device_nickname": ""
            }
          }
        }
      },
      "validate-success": {
        "summary": "Validate transaction was successful",
        "description": "Validate transaction was successful",
        "value": {
          "event_id": "7c19bb37-8679-4ffb-b431-41ae49d8ff75",
          "event_type": "transaction.validate.success",
          "event_body": {
            "merchant": {
              "id": "944025",
              "name": "Test merchant account"
            },
            "features": {
              "is_test_mode": true
            },
            "transaction_id": "8584364761",
            "transaction_type": "cc",
            "condition": "complete",
            "processor_id": "ccprocessora",
            "ponumber": "",
            "order_description": "",
            "order_id": "",
            "customerid": "",
            "customertaxid": "",
            "website": "",
            "shipping": "",
            "currency": "USD",
            "tax": "",
            "surcharge": "",
            "convenience_fee": "",
            "misc_fee": "",
            "misc_fee_name": "",
            "cash_discount": "",
            "tip": "",
            "requested_amount": "",
            "shipping_carrier": "",
            "tracking_number": "",
            "shipping_date": "",
            "partial_payment_id": "",
            "partial_payment_balance": "",
            "platform_id": "",
            "authorization_code": "",
            "social_security_number": "",
            "drivers_license_number": "",
            "drivers_license_state": "",
            "drivers_license_dob": "",
            "duty_amount": "0.00",
            "discount_amount": "0.00",
            "national_tax_amount": "0.00",
            "summary_commodity_code": "",
            "alternate_tax_amount": "0.00",
            "vat_tax_amount": "0.00",
            "vat_tax_rate": "0.00",
            "billing_address": {
              "first_name": "",
              "last_name": "",
              "address_1": "",
              "address_2": "",
              "company": "",
              "city": "",
              "state": "",
              "postal_code": "",
              "country": "",
              "email": "",
              "phone": "",
              "cell_phone": "",
              "fax": ""
            },
            "shipping_address": {
              "first_name": "",
              "last_name": "",
              "address_1": "",
              "address_2": "",
              "company": "",
              "city": "",
              "state": "",
              "postal_code": "",
              "country": "",
              "email": "",
              "phone": "",
              "fax": ""
            },
            "card": {
              "cc_number": "411111******1111",
              "cc_exp": "1025",
              "cavv": "",
              "cavv_result": "",
              "xid": "",
              "eci": "",
              "avs_response": "",
              "csc_response": "M",
              "cardholder_auth": "",
              "cc_start_date": "",
              "cc_issue_number": "",
              "card_balance": "",
              "card_available_balance": "",
              "entry_mode": "4",
              "cc_bin": "",
              "cc_type": "Visa",
              "feature_token": ""
            },
            "merchant_defined_fields": {},
            "action": {
              "amount": "0",
              "action_type": "validate",
              "date": "20230804160357",
              "success": "1",
              "ip_address": "123.123.123.123",
              "source": "api",
              "api_method": "direct_post",
              "username": "test",
              "response_text": "SUCCESS",
              "response_code": "100",
              "processor_response_text": "",
              "tap_to_mobile": false,
              "processor_response_code": "",
              "device_license_number": "",
              "device_nickname": ""
            }
          }
        }
      },
      "plan-added": {
        "summary": "Recurring Plan Added",
        "description": "Recurring Plan has been added",
        "value": {
          "event_id": "35f56738-4755-4cd9-9068-ea9e83d60d2e",
          "event_type": "recurring.plan.add",
          "event_body": {
            "merchant": {
              "id": "944025",
              "name": "Test merchant account"
            },
            "features": {
              "is_test_mode": true
            },
            "plan": {
              "id": "TestPlanId1",
              "name": "Test Plan",
              "amount": "10.00",
              "day_frequency": "",
              "payments": "Until canceled",
              "month_frequency": "1",
              "day_of_month": "15"
            }
          }
        }
      },
      "plan-updated": {
        "summary": "Recurring Plan Updated",
        "description": "Recurring Plan has been updated",
        "value": {
          "event_id": "35f56738-4755-4cd9-9068-ea9e83d60d2e",
          "event_type": "recurring.plan.update",
          "event_body": {
            "merchant": {
              "id": "944025",
              "name": "Test merchant account"
            },
            "features": {
              "is_test_mode": true
            },
            "plan": {
              "id": "",
              "name": "Test Plan Updated",
              "amount": "20.00",
              "day_frequency": "",
              "payments": "Until canceled",
              "month_frequency": "",
              "day_of_month": ""
            }
          }
        }
      },
      "plan-deleted": {
        "summary": "Recurring Plan Deleted",
        "description": "Recurring Plan has been deleted",
        "value": {
          "event_id": "35f56738-4755-4cd9-9068-ea9e83d60d2e",
          "event_type": "recurring.plan.delete",
          "event_body": {
            "merchant": {
              "id": "944025",
              "name": "Test merchant account"
            },
            "features": {
              "is_test_mode": true
            },
            "plan": {
              "id": "TestPlanId1",
              "name": "Test Plan Updated",
              "amount": "20.00",
              "day_frequency": "15",
              "payments": "Until canceled",
              "month_frequency": "1",
              "day_of_month": "0"
            }
          }
        }
      },
      "subscription-added": {
        "summary": "Subscription Added",
        "description": "A new subscription has been added.",
        "value": {
          "event_id": "5f5706a2-aec2-4d69-b699-32e5745cf1fd",
          "event_type": "recurring.subscription.add",
          "event_body": {
            "merchant": {
              "id": "944025",
              "name": "Test merchant account"
            },
            "features": {
              "is_test_mode": true
            },
            "subscription_id": "8608342724",
            "subscription_type": "cc",
            "processor_id": "",
            "next_charge_date": "1970-01-01",
            "completed_payments": "0",
            "attempted_payments": "0",
            "remaining_payments": "Until canceled",
            "ponumber": "",
            "order_id": "",
            "order_description": "",
            "shipping": "",
            "tax": "",
            "website": "",
            "plan": {
              "id": "TestPlanId1",
              "name": "Test Plan",
              "amount": "10.00",
              "day_frequency": "",
              "payments": "Until canceled",
              "month_frequency": "1",
              "day_of_month": "15"
            },
            "billing_address": {
              "first_name": "John",
              "last_name": "Smith",
              "address_1": "123 Lovely Lane",
              "address_2": "",
              "company": "",
              "city": "New York City",
              "state": "NY",
              "postal_code": "11111",
              "country": "US",
              "email": "",
              "phone": "",
              "cell_phone": "",
              "fax": ""
            },
            "card": {
              "cc_number": "411111******1111",
              "cc_exp": "1025",
              "cavv": "",
              "cavv_result": "",
              "xid": "",
              "eci": "",
              "avs_response": "",
              "csc_response": "",
              "cardholder_auth": "",
              "cc_start_date": "",
              "cc_issue_number": "",
              "card_balance": "",
              "card_available_balance": "",
              "entry_mode": "",
              "cc_bin": "",
              "cc_type": "Visa"
            }
          }
        }
      },
      "subscription-updated": {
        "summary": "Subscription Updated",
        "description": "A new subscription has been updated.",
        "value": {
          "event_id": "9f4c6478-e875-44d5-a83c-e2afebdaab86",
          "event_type": "recurring.subscription.update",
          "event_body": {
            "merchant": {
              "id": "944025",
              "name": "Test merchant account"
            },
            "features": {
              "is_test_mode": true
            },
            "subscription_id": "8608342724",
            "subscription_type": "cc",
            "processor_id": "",
            "next_charge_date": "2023-09-15",
            "completed_payments": "0",
            "attempted_payments": "0",
            "remaining_payments": "Until canceled",
            "ponumber": "",
            "order_id": "",
            "order_description": "",
            "shipping": "0.00",
            "tax": "0.00",
            "website": "",
            "plan": {
              "id": "",
              "name": "",
              "amount": "10.00",
              "day_frequency": "",
              "payments": "Until canceled",
              "month_frequency": "1",
              "day_of_month": "15"
            },
            "billing_address": {
              "first_name": "John",
              "last_name": "Smith",
              "address_1": "123 Lovely Lane",
              "address_2": "",
              "company": "",
              "city": "New York City",
              "state": "NY",
              "postal_code": "11111",
              "country": "US",
              "email": "",
              "phone": "",
              "cell_phone": "",
              "fax": ""
            },
            "card": {
              "cc_number": "411111******1111",
              "cc_exp": "1025",
              "cavv": "",
              "cavv_result": "",
              "xid": "",
              "eci": "",
              "avs_response": "",
              "csc_response": "",
              "cardholder_auth": "",
              "cc_start_date": "",
              "cc_issue_number": "",
              "card_balance": "",
              "card_available_balance": "",
              "entry_mode": "",
              "cc_bin": "",
              "cc_type": "Visa"
            }
          }
        }
      },
      "subscription-deleted": {
        "summary": "Subscription Deleted",
        "description": "A new subscription has been deleted.",
        "value": {
          "event_id": "a1c0839a-4156-4f7c-a875-dc9411e2d3a6",
          "event_type": "recurring.subscription.delete",
          "event_body": {
            "merchant": {
              "id": "944025",
              "name": "Test merchant account"
            },
            "features": {
              "is_test_mode": true
            },
            "subscription_id": "8608342724",
            "subscription_type": "cc",
            "processor_id": "",
            "next_charge_date": "2023-09-15",
            "completed_payments": "0",
            "attempted_payments": "0",
            "remaining_payments": "Until canceled",
            "ponumber": "",
            "order_id": "",
            "order_description": "",
            "shipping": "0.00",
            "tax": "0.00",
            "website": "",
            "plan": {
              "id": "",
              "name": "",
              "amount": "10.00",
              "day_frequency": "",
              "payments": "Until canceled",
              "month_frequency": "1",
              "day_of_month": "15"
            },
            "billing_address": {
              "first_name": "John",
              "last_name": "Smith",
              "address_1": "123 Lovely Lane",
              "address_2": "",
              "company": "",
              "city": "New York City",
              "state": "NY",
              "postal_code": "11111",
              "country": "US",
              "email": "",
              "phone": "",
              "cell_phone": "",
              "fax": ""
            },
            "card": {
              "cc_number": "411111******1111",
              "cc_exp": "1025",
              "cavv": "",
              "cavv_result": "",
              "xid": "",
              "eci": "",
              "avs_response": "",
              "csc_response": "",
              "cardholder_auth": "",
              "cc_start_date": "",
              "cc_issue_number": "",
              "card_balance": "",
              "card_available_balance": "",
              "entry_mode": "",
              "cc_bin": "",
              "cc_type": "Visa"
            }
          }
        }
      },
      "settlement-completed": {
        "summary": "Settlement Batch Completed",
        "description": "Settlement batch completed",
        "value": {
          "event_id": "11750910-bd03-4f9a-871a-786203df177f",
          "event_type": "settlement.batch.complete",
          "event_body": {
            "batch_id": "12345678",
            "count": 4,
            "amount": "402.81",
            "merchant": {
              "id": "123456",
              "name": "Test Account"
            },
            "processor": {
              "id": "ccprocessor",
              "name": "CC Processor",
              "type": "cc"
            },
            "by_card_type": {
              "visa": {
                "count": 4,
                "amount": "402.81"
              }
            },
            "transaction_ids": [
              "1234000000",
              "1234000001",
              "1234000002",
              "1234000003"
            ]
          }
        }
      },
      "settlement-failed": {
        "summary": "Settlement Batch Failed",
        "description": "Settlement batch failed",
        "value": {
          "event_id": "dfe8156d-5dd9-43ac-8928-3cf70ef74108",
          "event_type": "settlement.batch.failure",
          "event_body": {
            "batch_id": "123456",
            "merchant": {
              "id": "123456",
              "name": "Test Merchant"
            },
            "processor": {
              "id": "ccprocessor",
              "name": "CC Processor",
              "type": "cc"
            }
          }
        }
      },
      "acu.summary.automaticallyupdated": {
        "summary": "Automatically Updated",
        "description": "Automatically updated",
        "value": {
          "event_id": "7958c536-88f0-47f4-bb55-54575259a3be",
          "event_type": "acu.summary.automaticallyupdated",
          "event_body": {
            "updated_date": "2022-08-22",
            "merchant": {
              "id": 123456,
              "name": "Test Account"
            },
            "cards_checked": {
              "customer_vault": {
                "checked": 376,
                "updated": 4
              },
              "subscriptions": {
                "checked": 434,
                "updated": 3
              }
            },
            "vault_count_updated_cards": 1,
            "vault_updated_cards": [
              {
                "customer_vault_id": "308229500",
                "billing_id": "1781228768",
                "cc_number": "445701******0009",
                "cc_exp": "01/50",
                "first_name": "Bob",
                "last_name": "Smith",
                "email": "bsmith@example.com",
                "phone": "+14801112222"
              }
            ],
            "vault_count_updated_expiration_dates": 3,
            "vault_updated_expiration_dates": [
              {
                "customer_vault_id": "2061222895",
                "billing_id": "350282046",
                "cc_number": "400000******0002",
                "cc_exp": "11/70",
                "first_name": "Bob",
                "last_name": "Smith",
                "email": "bobsmith@company.com",
                "phone": "4801112222"
              },
              {
                "customer_vault_id": "1039486483",
                "billing_id": "1408598861",
                "cc_number": "400000******0034",
                "cc_exp": "11/70",
                "first_name": "Jane",
                "last_name": "Smith",
                "email": "jane@organization.org",
                "phone": "+12125551222"
              },
              {
                "customer_vault_id": "1033346428",
                "billing_id": "1460247050",
                "cc_number": "520000******0007",
                "cc_exp": "12/33",
                "first_name": "Steve",
                "last_name": "Customer",
                "email": "steve@customer.com",
                "phone": "+13104053434"
              }
            ],
            "recurring_count_updated_cards": 2,
            "recurring_updated_cards": [
              {
                "subscription_id": "281474976710720",
                "cc_number": "445701******0459",
                "cc_exp": "01/50",
                "first_name": "",
                "last_name": "",
                "email": "",
                "phone": ""
              },
              {
                "subscription_id": "281474976710726",
                "cc_number": "445701******1123",
                "cc_exp": "01/50",
                "first_name": "Frank",
                "last_name": "Jones",
                "email": "fjones@example.com",
                "phone": "6021234567"
              }
            ],
            "recurring_count_updated_expiration_dates": 1,
            "recurring_updated_expiration_dates": [
              {
                "subscription_id": "281474976710725",
                "cc_number": "400000******3223",
                "cc_exp": "11/70",
                "first_name": "Susan",
                "last_name": "Harris",
                "email": "harris@company.com",
                "phone": "3125551212"
              }
            ]
          }
        }
      },
      "acu.summary.closedaccount": {
        "summary": "Closed Account",
        "description": "Closed Account",
        "value": {
          "event_id": "7bbd4af6-4075-4902-af56-9fc59ab71362",
          "event_type": "acu.summary.closedaccount",
          "event_body": {
            "updated_date": "2022-08-23",
            "merchant": {
              "id": 123456,
              "name": "Test Account"
            },
            "cards_checked": {
              "customer_vault": {
                "checked": 123,
                "updated": 1
              },
              "subscriptions": {
                "checked": 232,
                "updated": 1
              }
            },
            "vault_count_updated_closed_account": 1,
            "vault_updates": [
              {
                "customer_vault_id": "281474976710722",
                "billing_id": "230304034",
                "cc_number": "434343******0123",
                "cc_exp": "11/25",
                "first_name": "Longterm",
                "last_name": "Client",
                "email": "sample@customer.com",
                "phone": "6025551213"
              }
            ],
            "recurring_count_updated_closed_account": 1,
            "recurring_updates": [
              {
                "subscription_id": "281474976710727",
                "cc_number": "601101******0002",
                "cc_exp": "11/32",
                "first_name": "Bob",
                "last_name": "Smith",
                "email": "bsmith@example.co.uk",
                "phone": "+440111122222"
              }
            ]
          }
        }
      },
      "acu.summary.contactcustomer": {
        "summary": "Contact Support",
        "description": "Contact Support",
        "value": {
          "event_id": "7bbd4af6-4075-4902-af56-9fc59ab71362",
          "event_type": "acu.summary.contactcustomer",
          "event_body": {
            "updated_date": "2022-08-23",
            "merchant": {
              "id": 123456,
              "name": "Test Account"
            },
            "cards_checked": {
              "customer_vault": {
                "checked": 123,
                "updated": 2
              },
              "subscriptions": {
                "checked": 232,
                "updated": 1
              }
            },
            "vault_count_updated_contact_customer": 2,
            "vault_updates": [
              {
                "customer_vault_id": "40403043545",
                "billing_id": "34544356",
                "cc_number": "445343******7432",
                "cc_exp": "06/29",
                "first_name": "Happy",
                "last_name": "Customer",
                "email": "frequent@shopper.com",
                "phone": "5555559999"
              },
              {
                "customer_vault_id": "281474976710722",
                "billing_id": "230304034",
                "cc_number": "434343******0123",
                "cc_exp": "11/25",
                "first_name": "Bill",
                "last_name": "Thompson",
                "email": "bill@anothercustomer.com",
                "phone": "6025551213"
              }
            ],
            "recurring_count_updated_contact_customer": 1,
            "recurring_updates": [
              {
                "subscription_id": "323232232445",
                "cc_number": "465333******4232",
                "cc_exp": "04/30",
                "first_name": "Recurring",
                "last_name": "Customer",
                "email": "buy@repeatedly.com",
                "phone": "8185552323"
              }
            ]
          }
        }
      },
      "chargeback.batch.complete": {
        "summary": "Chargeback Batch Completed",
        "description": "Chargeback Batch Completed",
        "value": {
          "event_id": "7bbd4af6-4075-4902-af56-9fc59ab71362",
          "event_type": "chargeback.batch.complete",
          "event_body": {
            "merchant": {
              "id": "123456",
              "name": "Test Account"
            },
            "processor": {
              "id": "ccprocessor",
              "name": "CC Processor",
              "type": "cc"
            },
            "count": 1,
            "chargeback_amount": "12.34",
            "chargebacks": [
              {
                "id": "12345678",
                "date": "2023-08-11",
                "customer_name": "John Doe",
                "cc_number": "411111******1111",
                "amount": "12.34",
                "reason": "Cardholder Does Not Recognize"
              }
            ]
          }
        }
      }
    },
    "schemas": {
      "QueryResponse": {
        "type": "object",
        "title": "Response",
        "properties": {
          "nm_response": {
            "type": "object",
            "properties": {
              "transaction": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "transaction_id": {
                      "type": "string",
                      "description": "Transaction id"
                    },
                    "partial_payment_id": {
                      "type": "string",
                      "description": "Partial payment id"
                    },
                    "partial_payment_balance": {
                      "type": "string",
                      "description": "Partial payment balance"
                    },
                    "platform_id": {
                      "type": "string",
                      "description": "Platform id"
                    },
                    "transaction_type": {
                      "type": "string",
                      "description": "Transaction type"
                    },
                    "condition": {
                      "type": "string",
                      "description": "Condition"
                    },
                    "order_id": {
                      "type": "string",
                      "description": "Order id"
                    },
                    "authorization_code": {
                      "type": "string",
                      "description": "Authorization code"
                    },
                    "ponumber": {
                      "type": "string",
                      "description": "PO Number"
                    },
                    "order_description": {
                      "type": "string",
                      "description": "Order description"
                    },
                    "first_name": {
                      "type": "string",
                      "description": "First name"
                    },
                    "last_name": {
                      "type": "string",
                      "description": "Last name"
                    },
                    "address_1": {
                      "type": "string",
                      "description": "Address 1"
                    },
                    "address_2": {
                      "type": "string",
                      "description": "Address 2"
                    },
                    "company": {
                      "type": "string",
                      "description": "Company"
                    },
                    "city": {
                      "type": "string",
                      "description": "City"
                    },
                    "state": {
                      "type": "string",
                      "description": "State"
                    },
                    "postal_code": {
                      "type": "string",
                      "description": "Postal code"
                    },
                    "country": {
                      "type": "string",
                      "description": "Country"
                    },
                    "email": {
                      "type": "string",
                      "description": "Email"
                    },
                    "phone": {
                      "type": "string",
                      "description": "Phone"
                    },
                    "fax": {
                      "type": "string",
                      "description": "Fax"
                    },
                    "cell_phone": {
                      "type": "string",
                      "description": "Cell phone"
                    },
                    "customertaxid": {
                      "type": "string",
                      "description": "Customer tax id"
                    },
                    "customerid": {
                      "type": "string",
                      "description": "Customer id"
                    },
                    "website": {
                      "type": "string",
                      "description": "Website"
                    },
                    "shipping_first_name": {
                      "type": "string",
                      "description": "Shipping first name"
                    },
                    "shipping_last_name": {
                      "type": "string",
                      "description": "Shipping last name"
                    },
                    "shipping_address_1": {
                      "type": "string",
                      "description": "Shipping address 1"
                    },
                    "shipping_address_2": {
                      "type": "string",
                      "description": "Shipping address 2"
                    },
                    "shipping_company": {
                      "type": "string",
                      "description": "Shipping company"
                    },
                    "shipping_city": {
                      "type": "string",
                      "description": "Shipping city"
                    },
                    "shipping_state": {
                      "type": "string",
                      "description": "Shipping state"
                    },
                    "shipping_postal_code": {
                      "type": "string",
                      "description": "Shipping postal code"
                    },
                    "shipping_country": {
                      "type": "string",
                      "description": "Shipping country"
                    },
                    "shipping_email": {
                      "type": "string",
                      "description": "Shipping email"
                    },
                    "shipping_carrier": {
                      "type": "string",
                      "description": "Shipping carrier"
                    },
                    "tracking_number": {
                      "type": "string",
                      "description": "Tracking number"
                    },
                    "shipping_date": {
                      "type": "string",
                      "description": "Shipping date"
                    },
                    "shipping": {
                      "type": "string",
                      "description": "Shipping"
                    },
                    "shipping_phone": {
                      "type": "string",
                      "description": "Shipping phone"
                    },
                    "cc_number": {
                      "type": "string",
                      "description": "Credit card number"
                    },
                    "cc_hash": {
                      "type": "string",
                      "description": "Credit card hash"
                    },
                    "cc_exp": {
                      "type": "string",
                      "description": "Credit card expiration"
                    },
                    "cavv": {
                      "type": "string",
                      "description": "Cavv"
                    },
                    "cavv_result": {
                      "type": "string",
                      "description": "Cavv result"
                    },
                    "xid": {
                      "type": "string",
                      "description": "Xid"
                    },
                    "eci": {
                      "type": "string",
                      "description": "Eci"
                    },
                    "directory_server_id": {
                      "type": "string",
                      "description": "Directory server id"
                    },
                    "three_ds_version": {
                      "type": "string",
                      "description": "3DS version"
                    },
                    "avs_response": {
                      "type": "string",
                      "description": "AVS response"
                    },
                    "csc_response": {
                      "type": "string",
                      "description": "CSC response"
                    },
                    "cardholder_auth": {
                      "type": "string",
                      "description": "Cardholder auth"
                    },
                    "cc_start_date": {
                      "type": "string",
                      "description": "Credit card start date"
                    },
                    "cc_issue_number": {
                      "type": "string",
                      "description": "Credit card issue number"
                    },
                    "check_account": {
                      "type": "string",
                      "description": "Check account"
                    },
                    "check_hash": {
                      "type": "string",
                      "description": "Check hash"
                    },
                    "check_aba": {
                      "type": "string",
                      "description": "Check ABA"
                    },
                    "check_name": {
                      "type": "string",
                      "description": "Check name"
                    },
                    "account_holder_type": {
                      "type": "string",
                      "description": "Account holder type"
                    },
                    "account_type": {
                      "type": "string",
                      "description": "Account type"
                    },
                    "sec_code": {
                      "type": "string",
                      "description": "Sec code"
                    },
                    "drivers_license_number": {
                      "type": "string",
                      "description": "Drivers license number"
                    },
                    "drivers_license_state": {
                      "type": "string",
                      "description": "Drivers license state"
                    },
                    "drivers_license_dob": {
                      "type": "string",
                      "description": "Drivers license dob"
                    },
                    "social_security_number": {
                      "type": "string",
                      "description": "Social security number"
                    },
                    "processor_id": {
                      "type": "string",
                      "description": "Processor id"
                    },
                    "tax": {
                      "type": "string",
                      "description": "Tax"
                    },
                    "currency": {
                      "type": "string",
                      "description": "Currency"
                    },
                    "surcharge": {
                      "type": "string",
                      "description": "Surcharge"
                    },
                    "convenience_fee": {
                      "type": "string",
                      "description": "Convenience Fee"
                    },
                    "misc_fee": {
                      "type": "string",
                      "description": "Miscelaneous Fee"
                    },
                    "misc_fee_name": {
                      "type": "string",
                      "description": "Miscelaneous Fee Name"
                    },
                    "cash_discount": {
                      "type": "string",
                      "description": "Cash discount"
                    },
                    "tip": {
                      "type": "string",
                      "description": "Tip"
                    },
                    "card_balance": {
                      "type": "string",
                      "description": "Card balance"
                    },
                    "card_available_balance": {
                      "type": "string",
                      "description": "Card available balance"
                    },
                    "entry_mode": {
                      "type": "string",
                      "description": "Entry mode"
                    },
                    "cc_bin": {
                      "type": "string",
                      "description": "Credit card bin"
                    },
                    "cc_type": {
                      "type": "string",
                      "description": "Credit card type"
                    },
                    "signature_image": {
                      "type": "string",
                      "description": "Signature image"
                    },
                    "product": {
                      "type": "object",
                      "properties": {
                        "sku": {
                          "type": "string",
                          "description": "SKU"
                        },
                        "quantity": {
                          "type": "string",
                          "description": "Quantity"
                        },
                        "description": {
                          "type": "string",
                          "description": "Description"
                        },
                        "amount": {
                          "type": "string",
                          "description": "Amount"
                        }
                      }
                    },
                    "duty_amount": {
                      "type": "string",
                      "description": "Duty amount"
                    },
                    "discount_amount": {
                      "type": "string",
                      "description": "Discount amount"
                    },
                    "national_tax_amount": {
                      "type": "string",
                      "description": "National tax amount"
                    },
                    "summary_commodity_code": {
                      "type": "string",
                      "description": "Summary commodity code"
                    },
                    "vat_tax_amount": {
                      "type": "string",
                      "description": "Vat tax amount"
                    },
                    "vat_tax_rate": {
                      "type": "string",
                      "description": "Vat tax rate"
                    },
                    "alternate_tax_amount": {
                      "type": "string",
                      "description": "Alternate tax amount"
                    },
                    "action": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "amount": {
                            "type": "string",
                            "description": "Amount"
                          },
                          "action_type": {
                            "type": "string",
                            "description": "Action type"
                          },
                          "date": {
                            "type": "string",
                            "description": "Date"
                          },
                          "success": {
                            "type": "string",
                            "description": "Success"
                          },
                          "ip_address": {
                            "type": "string",
                            "description": "IP address"
                          },
                          "source": {
                            "type": "string",
                            "description": "Source"
                          },
                          "api_method": {
                            "type": "string",
                            "description": "API method"
                          },
                          "tap_to_mobile": {
                            "type": "string",
                            "description": "Tap to mobile"
                          },
                          "username": {
                            "type": "string",
                            "description": "Username"
                          },
                          "response_text": {
                            "type": "string",
                            "description": "Response text"
                          },
                          "batch_id": {
                            "type": "string",
                            "description": "Batch id"
                          },
                          "processor_batch_id": {
                            "type": "string",
                            "description": "Processor batch id"
                          },
                          "response_code": {
                            "type": "string",
                            "description": "Response code"
                          },
                          "processor_response_text": {
                            "type": "string",
                            "description": "Processor response text"
                          },
                          "processor_response_code": {
                            "type": "string",
                            "description": "Processor response code"
                          },
                          "requested_amount": {
                            "type": "string",
                            "description": "Requested amount"
                          },
                          "device_license_number": {
                            "type": "string",
                            "description": "Device license number"
                          },
                          "device_nickname": {
                            "type": "string",
                            "description": "Device nickname"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "QueryCustomerVaultResponse": {
        "type": "object",
        "title": "Response - Customer Vault Report Type",
        "properties": {
          "nm_response": {
            "type": "object",
            "properties": {
              "customer_vault": {
                "type": "object",
                "properties": {
                  "customer": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Customer ID"
                        },
                        "first_name": {
                          "type": "string",
                          "description": "First name of the customer"
                        },
                        "last_name": {
                          "type": "string",
                          "description": "Last name of the customer"
                        },
                        "address_1": {
                          "type": "string",
                          "description": "Primary address line of the customer"
                        },
                        "address_2": {
                          "type": "string",
                          "description": "Secondary address line of the customer"
                        },
                        "company": {
                          "type": "string",
                          "description": "Company name associated with the customer"
                        },
                        "city": {
                          "type": "string",
                          "description": "City of the customer's address"
                        },
                        "state": {
                          "type": "string",
                          "description": "State of the customer's address"
                        },
                        "postal_code": {
                          "type": "string",
                          "description": "Postal code of the customer's address"
                        },
                        "country": {
                          "type": "string",
                          "description": "Country of the customer's address"
                        },
                        "email": {
                          "type": "string",
                          "description": "Email address of the customer"
                        },
                        "phone": {
                          "type": "string",
                          "description": "Phone number of the customer"
                        },
                        "fax": {
                          "type": "string",
                          "description": "Fax number of the customer"
                        },
                        "cell_phone": {
                          "type": "string",
                          "description": "Cell phone number of the customer"
                        },
                        "customertaxid": {
                          "type": "string",
                          "description": "Customer's tax identification number"
                        },
                        "website": {
                          "type": "string",
                          "description": "Website associated with the customer"
                        },
                        "shipping_first_name": {
                          "type": "string",
                          "description": "First name for shipping details"
                        },
                        "shipping_last_name": {
                          "type": "string",
                          "description": "Last name for shipping details"
                        },
                        "shipping_address_1": {
                          "type": "string",
                          "description": "Primary shipping address line"
                        },
                        "shipping_address_2": {
                          "type": "string",
                          "description": "Secondary shipping address line"
                        },
                        "shipping_company": {
                          "type": "string",
                          "description": "Shipping company name"
                        },
                        "shipping_city": {
                          "type": "string",
                          "description": "Shipping city"
                        },
                        "shipping_state": {
                          "type": "string",
                          "description": "Shipping state"
                        },
                        "shipping_postal_code": {
                          "type": "string",
                          "description": "Shipping postal code"
                        },
                        "shipping_country": {
                          "type": "string",
                          "description": "Shipping country"
                        },
                        "shipping_email": {
                          "type": "string",
                          "description": "Email address for shipping"
                        },
                        "shipping_carrier": {
                          "type": "string",
                          "description": "Shipping carrier details"
                        },
                        "tracking_number": {
                          "type": "string",
                          "description": "Shipping tracking number"
                        },
                        "shipping_date": {
                          "type": "string",
                          "description": "Shipping date"
                        },
                        "shipping": {
                          "type": "string",
                          "description": "Shipping cost"
                        },
                        "cc_number": {
                          "type": "string",
                          "description": "Credit card number (masked)"
                        },
                        "cc_hash": {
                          "type": "string",
                          "description": "Credit card hash"
                        },
                        "cc_exp": {
                          "type": "string",
                          "description": "Credit card expiration date"
                        },
                        "cc_start_date": {
                          "type": "string",
                          "description": "Credit card start date"
                        },
                        "cc_issue_number": {
                          "type": "string",
                          "description": "Credit card issue number"
                        },
                        "check_account": {
                          "type": "string",
                          "description": "Check account details"
                        },
                        "check_hash": {
                          "type": "string",
                          "description": "Check hash value"
                        },
                        "check_aba": {
                          "type": "string",
                          "description": "Check ABA routing number"
                        },
                        "check_name": {
                          "type": "string",
                          "description": "Name on the check"
                        },
                        "account_holder_type": {
                          "type": "string",
                          "description": "Account holder type"
                        },
                        "account_type": {
                          "type": "string",
                          "description": "Type of bank account"
                        },
                        "sec_code": {
                          "type": "string",
                          "description": "SEC code for ACH transactions"
                        },
                        "processor_id": {
                          "type": "string",
                          "description": "Processor ID"
                        },
                        "cc_bin": {
                          "type": "string",
                          "description": "Credit card BIN number"
                        },
                        "cc_type": {
                          "type": "string",
                          "description": "Credit card type"
                        },
                        "created": {
                          "type": "string",
                          "description": "Creation date"
                        },
                        "updated": {
                          "type": "string",
                          "description": "Last update date"
                        },
                        "account_updated": {
                          "type": "string",
                          "description": "Last account update date"
                        },
                        "customer_vault_id": {
                          "type": "string",
                          "description": "Customer vault ID"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "QueryRecurringResponse": {
        "type": "object",
        "title": "Response - Recurring Report Type",
        "properties": {
          "nm_response": {
            "type": "object",
            "properties": {
              "subscription": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Unique identifier for the subscription"
                    },
                    "subscription_id": {
                      "type": "string",
                      "description": "Subscription-specific ID"
                    },
                    "plan": {
                      "type": "object",
                      "properties": {
                        "plan_id": {
                          "type": "string",
                          "description": "Plan's specific ID"
                        },
                        "plan_name": {
                          "type": "string",
                          "description": "Name of the plan"
                        },
                        "plan_amount": {
                          "type": "string",
                          "description": "Amount associated with the plan"
                        },
                        "plan_payments": {
                          "type": "string",
                          "description": "Number of payments for the plan"
                        },
                        "day_frequency": {
                          "type": "string",
                          "description": "Frequency of the plan in days"
                        }
                      }
                    },
                    "next_charge_date": {
                      "type": "string",
                      "description": "Date of next charge for the subscription"
                    },
                    "completed_payments": {
                      "type": "string",
                      "description": "Number of completed payments"
                    },
                    "attempted_payments": {
                      "type": "string",
                      "description": "Number of attempted payments"
                    },
                    "remaining_payments": {
                      "type": "string",
                      "description": "Number of remaining payments"
                    },
                    "ponumber": {
                      "type": "string",
                      "description": "Purchase Order number"
                    },
                    "orderid": {
                      "type": "string",
                      "description": "Order ID"
                    },
                    "order_description": {
                      "type": "string",
                      "description": "Description of the order"
                    },
                    "shipping": {
                      "type": "string",
                      "description": "Shipping details"
                    },
                    "tax": {
                      "type": "string",
                      "description": "Tax details"
                    },
                    "first_name": {
                      "type": "string",
                      "description": "First name of the customer"
                    },
                    "last_name": {
                      "type": "string",
                      "description": "Last name of the customer"
                    },
                    "address_1": {
                      "type": "string",
                      "description": "Address line 1"
                    },
                    "address_2": {
                      "type": "string",
                      "description": "Address line 2"
                    },
                    "company": {
                      "type": "string",
                      "description": "Company name"
                    },
                    "city": {
                      "type": "string",
                      "description": "City"
                    },
                    "state": {
                      "type": "string",
                      "description": "State or region"
                    },
                    "postal_code": {
                      "type": "string",
                      "description": "Postal code"
                    },
                    "country": {
                      "type": "string",
                      "description": "Country"
                    },
                    "email": {
                      "type": "string",
                      "description": "Email address"
                    },
                    "phone": {
                      "type": "string",
                      "description": "Phone number"
                    },
                    "fax": {
                      "type": "string",
                      "description": "Fax number"
                    },
                    "cell_phone": {
                      "type": "string",
                      "description": "Cell phone number"
                    },
                    "customertaxid": {
                      "type": "string",
                      "description": "Customer's tax identification number"
                    },
                    "website": {
                      "type": "string",
                      "description": "Website URL"
                    },
                    "cc_number": {
                      "type": "string",
                      "description": "Credit card number"
                    },
                    "cc_hash": {
                      "type": "string",
                      "description": "Credit card hash"
                    },
                    "cc_exp": {
                      "type": "string",
                      "description": "Credit card expiration date"
                    },
                    "cc_start_date": {
                      "type": "string",
                      "description": "Credit card start date"
                    },
                    "cc_issue_number": {
                      "type": "string",
                      "description": "Credit card issue number"
                    },
                    "cc_bin": {
                      "type": "string",
                      "description": "Credit card BIN number"
                    },
                    "processor_id": {
                      "type": "string",
                      "description": "Processor ID"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "QueryRecurringPlanResponse": {
        "type": "object",
        "title": "Response - Recurring Plans Report Type",
        "properties": {
          "nm_response": {
            "type": "object",
            "properties": {
              "plan": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Unique identifier for the plan"
                    },
                    "plan_id": {
                      "type": "string",
                      "description": "Plan's specific ID"
                    },
                    "plan_name": {
                      "type": "string",
                      "description": "Name of the recurring plan"
                    },
                    "plan_amount": {
                      "type": "string",
                      "description": "Amount associated with the plan"
                    },
                    "day_frequency": {
                      "type": "string",
                      "description": "Frequency of the plan in days"
                    },
                    "month_frequency": {
                      "type": "string",
                      "description": "Frequency of the plan in months"
                    },
                    "day_of_month": {
                      "type": "string",
                      "description": "Specific day of the month for the plan"
                    },
                    "plan_payments": {
                      "type": "string",
                      "description": "Number of payments for the plan"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "QueryInvoicingResponse": {
        "type": "object",
        "title": "Response - Invoicing Report Type",
        "properties": {
          "nm_response": {
            "type": "object",
            "properties": {
              "invoice_report": {
                "type": "object",
                "properties": {
                  "invoice": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "invoice_id": {
                          "type": "string",
                          "description": "Unique identifier for the invoice"
                        },
                        "amount": {
                          "type": "string",
                          "description": "Total amount of the invoice"
                        },
                        "status": {
                          "type": "string",
                          "description": "Status of the invoice"
                        },
                        "currency": {
                          "type": "string",
                          "description": "Currency code for the invoice amount"
                        },
                        "order_description": {
                          "type": "string",
                          "description": "Description of the order"
                        },
                        "customer_id": {
                          "type": "string",
                          "description": "Unique identifier for the customer"
                        },
                        "customer_tax_id": {
                          "type": "string",
                          "description": "Tax ID associated with the customer"
                        },
                        "order_id": {
                          "type": "string",
                          "description": "Unique identifier for the order"
                        },
                        "po_number": {
                          "type": "string",
                          "description": "Purchase order number"
                        },
                        "tax_amount": {
                          "type": "string",
                          "description": "Total tax amount for the invoice"
                        },
                        "shipping_amount": {
                          "type": "string",
                          "description": "Total shipping amount for the invoice"
                        },
                        "discount_amount": {
                          "type": "string",
                          "description": "Total discount amount for the invoice"
                        },
                        "created": {
                          "type": "string",
                          "description": "Creation date of the invoice"
                        },
                        "terms": {
                          "type": "string",
                          "description": "Payment terms for the invoice"
                        },
                        "payments_applied": {
                          "type": "string",
                          "description": "Total payments applied to the invoice"
                        },
                        "billing": {
                          "type": "object",
                          "properties": {
                            "first_name": {
                              "type": "string",
                              "description": "First name for billing contact"
                            },
                            "last_name": {
                              "type": "string",
                              "description": "Last name for billing contact"
                            },
                            "address1": {
                              "type": "string",
                              "description": "Primary address line for billing"
                            },
                            "address2": {
                              "type": "string",
                              "description": "Secondary address line for billing"
                            },
                            "company": {
                              "type": "string",
                              "description": "Company name for billing"
                            },
                            "city": {
                              "type": "string",
                              "description": "City for billing"
                            },
                            "state": {
                              "type": "string",
                              "description": "State for billing"
                            },
                            "postal": {
                              "type": "string",
                              "description": "Postal code for billing"
                            },
                            "country": {
                              "type": "string",
                              "description": "Country for billing"
                            },
                            "email": {
                              "type": "string",
                              "description": "Email address for billing"
                            },
                            "phone": {
                              "type": "string",
                              "description": "Phone number for billing"
                            },
                            "fax": {
                              "type": "string",
                              "description": "Fax number for billing"
                            }
                          }
                        },
                        "shipping": {
                          "type": "object",
                          "properties": {
                            "first_name": {
                              "type": "string",
                              "description": "First name for shipping contact"
                            },
                            "last_name": {
                              "type": "string",
                              "description": "Last name for shipping contact"
                            },
                            "address1": {
                              "type": "string",
                              "description": "Primary address line for shipping"
                            },
                            "address2": {
                              "type": "string",
                              "description": "Secondary address line for shipping"
                            },
                            "company": {
                              "type": "string",
                              "description": "Company name for shipping"
                            },
                            "city": {
                              "type": "string",
                              "description": "City for shipping"
                            },
                            "state": {
                              "type": "string",
                              "description": "State for shipping"
                            },
                            "postal": {
                              "type": "string",
                              "description": "Postal code for shipping"
                            },
                            "country": {
                              "type": "string",
                              "description": "Country for shipping"
                            },
                            "email": {
                              "type": "string",
                              "description": "Email address for shipping"
                            },
                            "phone": {
                              "type": "string",
                              "description": "Phone number for shipping"
                            },
                            "fax": {
                              "type": "string",
                              "description": "Fax number for shipping"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "QueryGatewayProcessorResponse": {
        "type": "object",
        "title": "Response - Gateway Processors Report Type",
        "properties": {
          "nm_response": {
            "type": "object",
            "properties": {
              "gateway_processor": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "description": {
                      "type": "string",
                      "description": "Description of the gateway processor"
                    },
                    "processor_id": {
                      "type": "string",
                      "description": "Unique identifier for the processor"
                    },
                    "platform": {
                      "type": "string",
                      "description": "Platform associated with the gateway processor"
                    },
                    "emv_support": {
                      "type": "string",
                      "description": "EMV support status; indicates whether the processor supports EMV transactions"
                    },
                    "mcc": {
                      "type": "string",
                      "description": "Merchant category code"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "QueryProfileWithProcessorDetailsResponse": {
        "type": "object",
        "title": "Response - Profile Report Type With Processor Details",
        "properties": {
          "nm_response": {
            "type": "object",
            "properties": {
              "protected": {
                "type": "string",
                "description": "Indicates whether the response is protected"
              },
              "is_gateway": {
                "type": "string",
                "description": "Indicates whether the response is related to a gateway"
              },
              "merchant": {
                "type": "object",
                "properties": {
                  "company": {
                    "type": "string",
                    "description": "Merchant's company name"
                  },
                  "email": {
                    "type": "string",
                    "description": "Merchant's email address"
                  },
                  "phone": {
                    "type": "string",
                    "description": "Merchant's phone number"
                  },
                  "url": {
                    "type": "string",
                    "description": "Merchant's website URL"
                  },
                  "address1": {
                    "type": "string",
                    "description": "Merchant's primary address line"
                  },
                  "address2": {
                    "type": "string",
                    "description": "Merchant's secondary address line"
                  },
                  "city": {
                    "type": "string",
                    "description": "Merchant's city"
                  },
                  "state": {
                    "type": "string",
                    "description": "Merchant's state"
                  },
                  "zip": {
                    "type": "string",
                    "description": "Merchant's ZIP code"
                  },
                  "country": {
                    "type": "string",
                    "description": "Merchant's country"
                  },
                  "timezone": {
                    "type": "string",
                    "description": "Merchant's timezone"
                  },
                  "card_schemes": {
                    "type": "string",
                    "description": "Supported card schemes by the merchant"
                  }
                }
              },
              "gateway": {
                "type": "object",
                "properties": {
                  "company": {
                    "type": "string",
                    "description": "Gateway's company name"
                  },
                  "url": {
                    "type": "string",
                    "description": "Gateway's website URL"
                  },
                  "email": {
                    "type": "string",
                    "description": "Gateway's email address"
                  },
                  "phone": {
                    "type": "string",
                    "description": "Gateway's phone number"
                  },
                  "primary_color": {
                    "type": "string",
                    "description": "Gateway's primary color code"
                  },
                  "complimentary_color_1": {
                    "type": "string",
                    "description": "Gateway's first complimentary color code"
                  },
                  "complimentary_color_2": {
                    "type": "string",
                    "description": "Gateway's second complimentary color code"
                  }
                }
              },
              "merchant_defined_fields": {
                "type": "array",
                "description": "Merchant-defined fields",
                "items": {
                  "type": "object",
                  "properties": {}
                }
              },
              "processors": {
                "type": "object",
                "properties": {
                  "processor": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "description": "Processor's unique identifier"
                        },
                        "type": {
                          "type": "string",
                          "description": "Processor's type"
                        },
                        "platform": {
                          "type": "string",
                          "description": "Processor's platform"
                        },
                        "tap_to_mobile": {
                          "type": "object",
                          "description": "Details related to tap mobile functionality"
                        },
                        "required_fields": {
                          "type": "string",
                          "description": "Fields required by the processor"
                        },
                        "currencies": {
                          "type": "object",
                          "description": "Supported currencies by the processor"
                        },
                        "merchant_category_code": {
                          "type": "string",
                          "description": "Merchant category code associated with the processor"
                        }
                      }
                    }
                  }
                }
              },
              "merchant_favicon": {
                "type": "string",
                "description": "Merchant's favicon data"
              },
              "account_details": {
                "type": "object",
                "properties": {
                  "account_status": {
                    "type": "string",
                    "description": "Status of the merchant's account"
                  },
                  "test_mode_enabled": {
                    "type": "string",
                    "description": "Indicates whether test mode is enabled for the merchant's account"
                  }
                }
              }
            }
          }
        }
      },
      "Merchant": {
        "type": "object",
        "title": "Merchant",
        "description": "Merchant Details",
        "properties": {
          "id": {
            "type": "string",
            "description": "Merchant identifier"
          },
          "name": {
            "type": "string",
            "description": "Merchant name"
          }
        }
      },
      "Features": {
        "type": "object",
        "title": "Features",
        "description": "Features associated with the transaction",
        "properties": {
          "is_test_mode": {
            "type": "boolean",
            "description": "Test mode status"
          }
        }
      },
      "BillingAddress": {
        "type": "object",
        "title": "Billing Address",
        "description": "Billing Address details",
        "properties": {
          "first_name": {
            "type": "string",
            "description": "The first name of the person associated with the billing address."
          },
          "last_name": {
            "type": "string",
            "description": "The last name of the person associated with the billing address."
          },
          "address_1": {
            "type": "string",
            "description": "The first line of the street address."
          },
          "address_2": {
            "type": "string",
            "description": "The second line of the street address."
          },
          "company": {
            "type": "string",
            "description": "The name of the company associated with the billing address."
          },
          "city": {
            "type": "string",
            "description": "The name of the city associated with the billing address."
          },
          "state": {
            "type": "string",
            "description": "The name of the state or province associated with the billing address.\n  \nFormat: `CC`"
          },
          "postal_code": {
            "type": "string",
            "description": "The postal code or zip code associated with the billing address."
          },
          "country": {
            "type": "string",
            "description": "The name of the country associated with the billing address. *Country codes are as shown in ISO 3166-1 alpha-2*.\n  \nFormat: `CC`"
          },
          "email": {
            "type": "string",
            "format": "email",
            "description": "The email address associated with the billing address."
          },
          "phone": {
            "type": "string",
            "format": "phone",
            "description": "The phone number associated with the billing address."
          },
          "cell_phone": {
            "type": "string",
            "format": "phone",
            "description": "The cell phone number associated with the billing address."
          },
          "fax": {
            "type": "string",
            "format": "phone",
            "description": "The fax number associated with the billing address."
          }
        }
      },
      "ShippingAddress": {
        "type": "object",
        "title": "Shipping Address",
        "description": "Shipping Address details.",
        "properties": {
          "first_name": {
            "type": "string",
            "description": "The first name of the person associated with the shipping address."
          },
          "last_name": {
            "type": "string",
            "description": "The last name of the person associated with the shipping address."
          },
          "address_1": {
            "type": "string",
            "description": "The first line of the street address."
          },
          "address_2": {
            "type": "string",
            "description": "The second line of the street address."
          },
          "company": {
            "type": "string",
            "description": "The name of the company associated with the shipping address."
          },
          "city": {
            "type": "string",
            "description": "The city of the shipping address."
          },
          "state": {
            "type": "string",
            "description": "The state or province of the shipping address.\n  \nFormat: `CC`"
          },
          "postal_code": {
            "type": "string",
            "description": "The postal or zip code of the shipping address."
          },
          "country": {
            "type": "string",
            "description": "The country of the shipping address. *Country codes are as shown in ISO 3166-1 alpha-2*.\n  \nFormat: `CC`"
          },
          "email": {
            "type": "string",
            "description": "The email address associated with the shipping address."
          },
          "phone": {
            "type": "string",
            "description": "The phone number associated with the shipping address."
          },
          "fax": {
            "type": "string",
            "description": "The fax number associated with the shipping address."
          }
        }
      },
      "CardDetails": {
        "type": "object",
        "title": "Card Details",
        "description": "Details related to the credit card used in the transaction. Available for credit card transactions only.",
        "properties": {
          "cc_number": {
            "type": "string",
            "description": "Masked credit card number"
          },
          "cc_exp": {
            "type": "string",
            "description": "Credit card expiration date"
          },
          "cavv": {
            "type": "string",
            "description": "Cardholder Authentication Verification Value"
          },
          "cavv_result": {
            "type": "string",
            "description": "Cardholder Authentication Verification Value result"
          },
          "xid": {
            "type": "string",
            "description": "Cardholder authentication transaction id"
          },
          "eci": {
            "type": "string",
            "enum": [
              "01",
              "02",
              "05",
              "06",
              "07",
              "08",
              "09",
              ""
            ],
            "description": "Electronic Commerce Indicator"
          },
          "avs_response": {
            "type": "string",
            "description": "Address Verification Service response"
          },
          "csc_response": {
            "type": "string",
            "description": "Card Security Code response"
          },
          "cardholder_auth": {
            "type": "string",
            "enum": [
              "verified",
              "attempted",
              ""
            ],
            "description": "Cardholder Authentication response"
          },
          "cc_start_date": {
            "type": "string",
            "description": "Credit card start date"
          },
          "cc_issue_number": {
            "type": "string",
            "description": "Credit card issue number"
          },
          "card_balance": {
            "type": "string",
            "description": "Card balance"
          },
          "card_available_balance": {
            "type": "string",
            "description": "Card available balance"
          },
          "entry_mode": {
            "type": "string",
            "enum": [
              "0",
              "1",
              "2",
              "3",
              "4",
              "5",
              "6",
              "7",
              "8"
            ],
            "description": "The type of transaction data to be processed.\n\n<details>\n<summary>Possible values:</summary>\n\n| Code  | Description         |\n|:------|:--------------------|\n| 0     | Unknown             |\n| 1     | Invalid             |\n| 2     | NFC MSD             |\n| 3     | Swiped              |\n| 4     | Keyed               |\n| 5     | EMV ICC             |\n| 6     | NFC EMV             |\n| 7     | Keyed - Fallback    |\n| 8     | Swiped - Fallback   |\n</details>"
          },
          "cc_bin": {
            "type": "string",
            "description": "Credit card BIN (first 6 digits)"
          },
          "cc_type": {
            "type": "string",
            "description": "Credit card type (visa, ..)"
          },
          "feature_token": {
            "type": "string",
            "description": "Feature token"
          }
        }
      },
      "ACHAccountHolderType": {
        "type": "string",
        "enum": [
          "business",
          "personal"
        ],
        "description": "The customer's ACH account entity."
      },
      "ACHAccountType": {
        "type": "string",
        "enum": [
          "checking",
          "savings"
        ],
        "description": "The customer's ACH account type."
      },
      "ACHSecCode": {
        "type": "string",
        "enum": [
          "PPD",
          "WEB",
          "TEL",
          "CCD"
        ],
        "description": "ACH standard entry class codes."
      },
      "CheckDetails": {
        "type": "object",
        "title": "Check Details",
        "description": "Details about a check payment. Available for ACH transactions only.",
        "properties": {
          "check_account": {
            "type": "string",
            "description": "The customer's bank account number."
          },
          "check_aba": {
            "type": "string",
            "description": "The customer's bank routing number."
          },
          "check_name": {
            "type": "string",
            "description": "The customer's name."
          },
          "account_holder_type": {
            "$ref": "#/components/schemas/ACHAccountHolderType"
          },
          "account_type": {
            "$ref": "#/components/schemas/ACHAccountType"
          },
          "sec_code": {
            "$ref": "#/components/schemas/ACHSecCode"
          }
        }
      },
      "EmvMetaData": {
        "type": "object",
        "title": "EMV Meta Data",
        "description": "Details about the EMV transaction",
        "properties": {
          "application_id": {
            "type": "string",
            "description": "EMV Application ID"
          },
          "application_label": {
            "type": "string",
            "description": "EMV Application Label"
          },
          "application_preferred_name": {
            "type": "string",
            "description": "EMV Application Preferred Name"
          },
          "transaction_status_info": {
            "type": "string",
            "description": "Transaction Status Information"
          },
          "application_pan_sequence_number": {
            "type": "string",
            "description": "EMV Application PAN Sequence Number"
          },
          "customer_verification_method": {
            "type": "string",
            "enum": [
              "signature",
              "offline_pin",
              "online_pin",
              "none",
              "offline_pin_signature",
              "consumer_device",
              "consumer_device_plus_signature",
              ""
            ],
            "description": "EMV Customer Verification Method"
          }
        }
      },
      "TransactionAction": {
        "type": "object",
        "title": "Transaction Action",
        "description": "Transaction Action details",
        "properties": {
          "amount": {
            "type": "string",
            "description": "Amount of the transaction",
            "format": "decimal"
          },
          "action_type": {
            "type": "string",
            "enum": [
              "auth",
              "capture",
              "sale",
              "void",
              "refund",
              "credit",
              "return",
              "validate"
            ],
            "description": "Type of transaction"
          },
          "date": {
            "type": "string",
            "format": "date-time",
            "description": "Date of the transaction"
          },
          "success": {
            "type": "string",
            "enum": [
              "0",
              "1"
            ],
            "description": "Transaction Success Flag (0 - Failed, 1 - Success)"
          },
          "ip_address": {
            "type": "string",
            "description": "IP Address of the transaction",
            "format": "ipv4"
          },
          "source": {
            "type": "string",
            "enum": [
              "api",
              "batch_upload",
              "mobile",
              "quickclick",
              "quickbooks",
              "recurring",
              "swipe",
              "virtual_terminal",
              "internal"
            ],
            "description": "Source of the transaction"
          },
          "api_method": {
            "type": "string",
            "description": "API Method used for the transaction (direct_post, ..)"
          },
          "username": {
            "type": "string",
            "description": "Username"
          },
          "response_text": {
            "type": "string",
            "enum": [
              "APPROVED",
              "SUCCESS",
              "DECLINE"
            ],
            "description": "Transaction Response Text"
          },
          "response_code": {
            "type": "string",
            "description": "Response Code (100 - OK, 200 - Declined)"
          },
          "processor_response_text": {
            "type": "string",
            "description": "Processor Response Text"
          },
          "processor_response_code": {
            "type": "string",
            "description": "Processor Response Code"
          },
          "tap_to_mobile": {
            "type": "boolean",
            "description": "Tap to Mobile Flag"
          },
          "device_license_number": {
            "type": "string",
            "description": "Mobile Device License Number"
          },
          "device_nickname": {
            "type": "string",
            "description": "Mobile Device Nickname"
          }
        }
      },
      "RecurringCardDetails": {
        "type": "object",
        "title": "Card Details",
        "description": "Details related to the credit card used in the transaction. Available for credit card transactions only.",
        "properties": {
          "cc_number": {
            "type": "string",
            "description": "Masked credit card number"
          },
          "cc_exp": {
            "type": "string",
            "description": "Credit card expiration date"
          },
          "cavv": {
            "type": "string",
            "description": "Cardholder Authentication Verification Value"
          },
          "cavv_result": {
            "type": "string",
            "description": "Cardholder Authentication Verification Value result"
          },
          "xid": {
            "type": "string",
            "description": "Cardholder authentication transaction id"
          },
          "eci": {
            "type": "string",
            "enum": [
              "01",
              "02",
              "05",
              "06",
              "07",
              "08",
              "09",
              ""
            ],
            "description": "Electronic Commerce Indicator"
          },
          "avs_response": {
            "type": "string",
            "description": "Address Verification Service response"
          },
          "csc_response": {
            "type": "string",
            "description": "Card Security Code response"
          },
          "cardholder_auth": {
            "type": "string",
            "enum": [
              "verified",
              "attempted",
              ""
            ],
            "description": "Cardholder Authentication response"
          },
          "cc_start_date": {
            "type": "string",
            "description": "Credit card start date"
          },
          "cc_issue_number": {
            "type": "string",
            "description": "Credit card issue number"
          },
          "card_balance": {
            "type": "string",
            "description": "Card balance"
          },
          "card_available_balance": {
            "type": "string",
            "description": "Card available balance"
          },
          "entry_mode": {
            "type": "string",
            "enum": [
              "0",
              "1",
              "2",
              "3",
              "4",
              "5",
              "6",
              "7",
              "8",
              ""
            ],
            "description": "The type of transaction data to be processed.\n\n<details>\n<summary>Possible values:</summary>\n\n| Code  | Description         |\n|:------|:--------------------|\n| 0     | Unknown             |\n| 1     | Invalid             |\n| 2     | NFC MSD             |\n| 3     | Swiped              |\n| 4     | Keyed               |\n| 5     | EMV ICC             |\n| 6     | NFC EMV             |\n| 7     | Keyed - Fallback    |\n| 8     | Swiped - Fallback   |\n</details>"
          },
          "cc_bin": {
            "type": "string",
            "description": "Credit card BIN (first 6 digits)"
          },
          "cc_type": {
            "type": "string",
            "description": "Credit card type (visa, ..)"
          }
        }
      },
      "RecurringEventBody": {
        "type": "object",
        "title": "Subscription Event Body",
        "description": "Details about Subscription.",
        "required": [
          "merchant",
          "features",
          "plan"
        ],
        "properties": {
          "merchant": {
            "$ref": "#/components/schemas/Merchant"
          },
          "features": {
            "$ref": "#/components/schemas/Features"
          },
          "subscription_id": {
            "type": "string",
            "description": "Subscription ID"
          },
          "subscription_type": {
            "type": "string",
            "enum": [
              "cc",
              "ck"
            ],
            "description": "Subscription Type (cc - Credit Card, ck - Check)"
          },
          "processor_id": {
            "type": "string",
            "description": "Processor ID"
          },
          "next_charge_date": {
            "type": "string",
            "format": "date",
            "description": "Next Charge Date"
          },
          "completed_payments": {
            "type": "string",
            "format": "number",
            "description": "Completed Payments"
          },
          "attempted_payments": {
            "type": "string",
            "format": "number",
            "description": "Attempted Payments"
          },
          "remaining_payments": {
            "type": "string",
            "description": "Remaining Payments (`Until canceled` or number of remaining payments)"
          },
          "ponumber": {
            "type": "string",
            "description": "PO Number"
          },
          "order_id": {
            "type": "string",
            "description": "Order ID"
          },
          "order_description": {
            "type": "string",
            "description": "Order Description"
          },
          "shipping": {
            "type": "string",
            "description": "Shipping Details"
          },
          "tax": {
            "type": "string",
            "description": "Tax Details"
          },
          "website": {
            "type": "string",
            "description": "Website Details"
          },
          "plan": {
            "type": "object",
            "title": "Plan",
            "description": "Plan Details",
            "properties": {
              "id": {
                "type": "string",
                "description": "Plan ID"
              },
              "name": {
                "type": "string",
                "description": "Plan Name"
              },
              "amount": {
                "type": "string",
                "description": "Plan Amount"
              },
              "day_frequency": {
                "type": "string",
                "description": "Day Frequency"
              },
              "payments": {
                "type": "string",
                "description": "Payments Details"
              },
              "month_frequency": {
                "type": "string",
                "format": "number",
                "description": "Month Frequency"
              },
              "day_of_month": {
                "type": "string",
                "format": "number",
                "description": "Day of Month"
              }
            }
          },
          "billing_address": {
            "$ref": "#/components/schemas/BillingAddress"
          },
          "card": {
            "$ref": "#/components/schemas/RecurringCardDetails"
          },
          "check": {
            "$ref": "#/components/schemas/CheckDetails"
          }
        }
      },
      "TransactionSummary": {
        "type": "object",
        "title": "Transactions summary",
        "description": "Summary (number of transactions and total amount)",
        "properties": {
          "count": {
            "type": "integer",
            "format": "int64",
            "description": "Transactions Count"
          },
          "amount": {
            "type": "string",
            "format": "number",
            "description": "Transactions Amount"
          }
        }
      },
      "SettlementEventBody": {
        "type": "object",
        "title": "Settlement Event Body",
        "description": "Details about Settlement.",
        "required": [
          "batch_id",
          "merchant",
          "processor"
        ],
        "properties": {
          "batch_id": {
            "type": "string",
            "format": "int64",
            "description": "Batch ID"
          },
          "merchant": {
            "$ref": "#/components/schemas/Merchant"
          },
          "processor": {
            "type": "object",
            "title": "Processor",
            "description": "Processor Details",
            "properties": {
              "id": {
                "type": "string",
                "description": "Processor ID"
              },
              "name": {
                "type": "string",
                "description": "Processor Name"
              },
              "type": {
                "type": "string",
                "enum": [
                  "cc",
                  "ck"
                ],
                "description": "Processor Type (cc - Credit Card, ck - Check)"
              }
            }
          },
          "count": {
            "type": "integer",
            "format": "int64",
            "description": "Transactions Count"
          },
          "amount": {
            "type": "string",
            "format": "number",
            "description": "Transactions Amount"
          },
          "transaction_ids": {
            "type": "array",
            "description": "Transaction IDs",
            "items": {
              "type": "string",
              "description": "Transaction ID"
            }
          },
          "by_card_type": {
            "type": "object",
            "title": "By Card Type",
            "description": "Transactions by Card Type",
            "properties": {
              "visa": {
                "$ref": "#/components/schemas/TransactionSummary"
              },
              "mastercard": {
                "$ref": "#/components/schemas/TransactionSummary"
              },
              "amex": {
                "$ref": "#/components/schemas/TransactionSummary"
              },
              "discover": {
                "$ref": "#/components/schemas/TransactionSummary"
              },
              "diners": {
                "$ref": "#/components/schemas/TransactionSummary"
              },
              "jcb": {
                "$ref": "#/components/schemas/TransactionSummary"
              },
              "maestro": {
                "$ref": "#/components/schemas/TransactionSummary"
              },
              "ebt": {
                "$ref": "#/components/schemas/TransactionSummary"
              }
            },
            "additionalProperties": {
              "type": "object",
              "description": "Other card types"
            }
          }
        }
      },
      "AcuCustomerVaultDetails": {
        "type": "object",
        "description": "Details about a customer vault card with updated expiration date.",
        "properties": {
          "customer_vault_id": {
            "type": "string",
            "description": "The ID of the customer vault."
          },
          "billing_id": {
            "type": "string",
            "description": "The billing ID of the customer."
          },
          "cc_number": {
            "type": "string",
            "description": "The masked credit card number."
          },
          "cc_exp": {
            "type": "string",
            "description": "The updated expiration date of the credit card."
          },
          "first_name": {
            "type": "string",
            "description": "The first name of the customer."
          },
          "last_name": {
            "type": "string",
            "description": "The last name of the customer."
          },
          "email": {
            "type": "string",
            "description": "The email address of the customer."
          },
          "phone": {
            "type": "string",
            "description": "The phone number of the customer."
          }
        }
      },
      "AcuSubscriptionDetails": {
        "type": "object",
        "description": "Details about a recurring card that was updated.",
        "properties": {
          "subscription_id": {
            "type": "string",
            "description": "The ID of the subscription."
          },
          "cc_number": {
            "type": "string",
            "description": "The masked credit card number."
          },
          "cc_exp": {
            "type": "string",
            "description": "The expiration date of the credit card."
          },
          "first_name": {
            "type": "string",
            "description": "The first name of the customer."
          },
          "last_name": {
            "type": "string",
            "description": "The last name of the customer."
          },
          "email": {
            "type": "string",
            "description": "The email address of the customer."
          },
          "phone": {
            "type": "string",
            "description": "The phone number of the customer."
          }
        }
      },
      "AcuAutoUpdatedEventBody": {
        "type": "object",
        "title": "ACU Automatically Updated Event Body",
        "description": "Details about ACU Automatically Updated Event.",
        "required": [
          "updated_date",
          "merchant",
          "cards_checked"
        ],
        "properties": {
          "updated_date": {
            "type": "string",
            "format": "date",
            "description": "The update date."
          },
          "merchant": {
            "type": "object",
            "title": "Merchant",
            "description": "Merchant Details",
            "properties": {
              "id": {
                "type": "integer",
                "description": "Merchant identifier"
              },
              "name": {
                "type": "string",
                "description": "Merchant name"
              }
            }
          },
          "cards_checked": {
            "type": "object",
            "description": "Details about the cards that were checked.",
            "properties": {
              "customer_vault": {
                "type": "object",
                "description": "Details about the customer vault cards that were checked.",
                "properties": {
                  "checked": {
                    "type": "integer",
                    "description": "The number of customer vault cards that were checked."
                  },
                  "updated": {
                    "type": "integer",
                    "description": "The number of customer vault cards that were updated."
                  }
                }
              },
              "subscriptions": {
                "type": "object",
                "description": "Details about the subscription cards that were checked.",
                "properties": {
                  "checked": {
                    "type": "integer",
                    "description": "The number of subscription cards that were checked."
                  },
                  "updated": {
                    "type": "integer",
                    "description": "The number of subscription cards that were updated."
                  }
                }
              }
            }
          },
          "vault_count_updated_cards": {
            "type": "integer",
            "description": "The number of customer vault cards that were updated."
          },
          "vault_updated_cards": {
            "type": "array",
            "description": "Details about the customer vault cards that were updated.",
            "items": {
              "$ref": "#/components/schemas/AcuCustomerVaultDetails"
            }
          },
          "vault_count_updated_expiration_dates": {
            "type": "integer",
            "description": "The number of customer vault cards with updated expiration dates."
          },
          "vault_updated_expiration_dates": {
            "type": "array",
            "description": "Details about the customer vault cards with updated expiration dates.",
            "items": {
              "$ref": "#/components/schemas/AcuCustomerVaultDetails"
            }
          },
          "recurring_count_updated_cards": {
            "type": "integer",
            "description": "The number of recurring cards that were updated."
          },
          "recurring_updated_cards": {
            "type": "array",
            "description": "Details about the recurring cards that were updated.",
            "items": {
              "$ref": "#/components/schemas/AcuSubscriptionDetails"
            }
          },
          "recurring_count_updated_expiration_dates": {
            "type": "integer",
            "description": "The number of recurring cards with updated expiration dates."
          },
          "recurring_updated_expiration_dates": {
            "type": "array",
            "description": "Details about the recurring cards with updated expiration dates.",
            "items": {
              "$ref": "#/components/schemas/AcuSubscriptionDetails"
            }
          }
        }
      },
      "AcuClosedAccountEventBody": {
        "type": "object",
        "title": "ACU Closed Account Event Body",
        "description": "Details about ACU Closed Account Event.",
        "required": [
          "updated_date",
          "merchant",
          "cards_checked"
        ],
        "properties": {
          "updated_date": {
            "type": "string",
            "format": "date",
            "description": "The update date."
          },
          "merchant": {
            "type": "object",
            "description": "Details about the merchant.",
            "properties": {
              "id": {
                "type": "integer",
                "description": "The ID of the merchant."
              },
              "name": {
                "type": "string",
                "description": "The name of the merchant."
              }
            }
          },
          "cards_checked": {
            "type": "object",
            "description": "Details about the cards checked.",
            "properties": {
              "customer_vault": {
                "type": "object",
                "description": "Details about the customer vault.",
                "properties": {
                  "checked": {
                    "type": "integer",
                    "description": "The number of customer vaults checked."
                  },
                  "updated": {
                    "type": "integer",
                    "description": "The number of customer vaults updated."
                  }
                }
              },
              "subscriptions": {
                "type": "object",
                "description": "Details about the subscriptions.",
                "properties": {
                  "checked": {
                    "type": "integer",
                    "description": "The number of subscriptions checked."
                  },
                  "updated": {
                    "type": "integer",
                    "description": "The number of subscriptions updated."
                  }
                }
              }
            }
          },
          "vault_count_updated_closed_account": {
            "type": "integer",
            "description": "The number of vaults updated for the closed account."
          },
          "vault_updates": {
            "type": "array",
            "description": "Details about the vault updates.",
            "items": {
              "$ref": "#/components/schemas/AcuCustomerVaultDetails"
            }
          },
          "recurring_count_updated_closed_account": {
            "type": "integer",
            "description": "The number of recurring payments updated for the closed account."
          },
          "recurring_updates": {
            "type": "array",
            "description": "Details about the recurring payment updates.",
            "items": {
              "$ref": "#/components/schemas/AcuSubscriptionDetails"
            }
          }
        }
      },
      "AcuContactCustomerEventBody": {
        "type": "object",
        "title": "ACU Contact Customer Event Body",
        "description": "Details about ACU Contact Customer Event.",
        "required": [
          "updated_date",
          "merchant",
          "cards_checked"
        ],
        "properties": {
          "updated_date": {
            "type": "string",
            "format": "date",
            "description": "The date when the event was updated."
          },
          "merchant": {
            "type": "object",
            "description": "Details about the merchant.",
            "required": [
              "id",
              "name"
            ],
            "properties": {
              "id": {
                "type": "integer",
                "description": "The ID of the merchant."
              },
              "name": {
                "type": "string",
                "description": "The name of the merchant."
              }
            }
          },
          "cards_checked": {
            "type": "object",
            "description": "Details about the cards checked.",
            "required": [
              "customer_vault",
              "subscriptions"
            ],
            "properties": {
              "customer_vault": {
                "type": "object",
                "description": "Details about the customer vault.",
                "required": [
                  "checked",
                  "updated"
                ],
                "properties": {
                  "checked": {
                    "type": "integer",
                    "description": "The number of customer vaults checked."
                  },
                  "updated": {
                    "type": "integer",
                    "description": "The number of customer vaults updated."
                  }
                }
              },
              "subscriptions": {
                "type": "object",
                "description": "Details about the subscriptions.",
                "required": [
                  "checked",
                  "updated"
                ],
                "properties": {
                  "checked": {
                    "type": "integer",
                    "description": "The number of subscriptions checked."
                  },
                  "updated": {
                    "type": "integer",
                    "description": "The number of subscriptions updated."
                  }
                }
              }
            }
          },
          "vault_count_updated_contact_customer": {
            "type": "integer",
            "description": "The number of vaults updated."
          },
          "vault_updates": {
            "type": "array",
            "description": "Details about the vault updates.",
            "items": {
              "$ref": "#/components/schemas/AcuCustomerVaultDetails"
            }
          },
          "recurring_count_updated_contact_customer": {
            "type": "integer",
            "description": "The number of recurring subscriptions updated."
          },
          "recurring_updates": {
            "type": "array",
            "description": "Details about the recurring subscriptions updates.",
            "items": {
              "$ref": "#/components/schemas/AcuSubscriptionDetails"
            }
          }
        }
      }
    },
    "parameters": {
      "WebhookSignature": {
        "name": "Webhook-Signature",
        "in": "header",
        "required": true,
        "schema": {
          "type": "string"
        },
        "description": "Signature to validate the webhook event."
      }
    }
  },
  "x-tagGroups": [
    {
      "name": "REST API (recommended)",
      "tags": [
        "Payments",
        "Plans",
        "Subscriptions",
        "Products",
        "Invoicing",
        "Customers",
        "Devices"
      ]
    },
    {
      "name": "Classic API",
      "tags": [
        "Payment Processing",
        "Data and Transaction Reporting",
        "Webhook Events",
        "Gateway Features",
        "Processors and Services",
        "Apple Pay"
      ]
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
````