Query API (Classic)

POST /query.php

Environment and operation

Use this endpoint contract with the account and environment assigned to your integration. Values in angle brackets are placeholders. This reference does not execute requests. Documented server https://sandbox.nmi.com/api Schema reference: field definitions do not include every behavioral rule. Follow the workflow guidance and account prerequisites for this operation before submitting requests.

Request route

<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> POST /query.php Security scheme Type Credential location Scopes None declared Verify account setup Not inferred Not inferred

Request language templates

Original transport templates derived from this endpoint’s documented method, server, authentication and media type. Replace path/query/credential placeholders with authorized sandbox values. These examples print the raw status and response; they do not infer business success or retry a request. Save properly URL-encoded name=value pairs for your selected operation as request.form, including its private security_key when required. JSON example objects below describe these form fields; they are not the wire encoding. Node requires a runtime with fetch; PHP requires cURL. Generated source-based examples have not been executed against provider accounts. curl --request POST \ --url 'https://sandbox.nmi.com/api/query.php' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-binary '@request.form' import { readFile } from 'node:fs/promises'; const body = await readFile('request.form', 'utf8'); const response = await fetch("https://sandbox.nmi.com/api/query.php", { method: 'POST', headers: { "Content-Type": "application/x-www-form-urlencoded" }, body }); console.log(response.status, await response.text()); from urllib.request import Request, urlopen from urllib.error import HTTPError from pathlib import Path request = Request('https://sandbox.nmi.com/api/query.php', method='POST', headers={'Content-Type': 'application/x-www-form-urlencoded'}, data=Path('request.form').read_bytes()) try: with urlopen(request, timeout=30) as response: print(response.status, response.read().decode()) except HTTPError as error: print(error.code, error.read().decode()) require 'net/http' require 'uri' uri = URI("https://sandbox.nmi.com/api/query.php") request = Net::HTTP::Post.new(uri) request["Content-Type"] = "application/x-www-form-urlencoded" request.body = File.binread('request.form') response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https', read_timeout: 30) { |http| http.request(request) } puts response.code puts response.body <?php $curl = curl_init('https://sandbox.nmi.com/api/query.php'); curl_setopt_array($curl, [ CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 30, CURLOPT_HTTPHEADER => ['Content-Type: application/x-www-form-urlencoded'], CURLOPT_POSTFIELDS => file_get_contents('request.form') ]); $response = curl_exec($curl); if ($response === false) { throw new RuntimeException(curl_error($curl)); } echo curl_getinfo($curl, CURLINFO_HTTP_CODE), PHP_EOL, $response; curl_close($curl);

Request body

Use the declared media type: application/x-www-form-urlencoded. Required flags below apply within the selected object or variant. Read the workflow notes before choosing a variant. Field Type Required Description Constraints security_key string no API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys condition string no A combination of values can be passed and should be separated by commas. For example, to retrieve all transactions pending settlement or complete, the following could be used: `condition=pendingsettlement,complete` <details> <summary>Conditions</summary> | Condition | Description | |:-------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------| | pending | 'Auth Only' transactions that are awaiting capture. | | pendingsettlement | Transaction is awaiting settlement. | | in_progress | Three-Step Redirect API transaction has not yet been completed. The transaction condition will change to 'abandoned' if 24 hours pass with no further action. | | abandoned | Three-Step Redirect API transaction has not been completed, and has timed out. | | failed | Transaction has failed. | | canceled | Transaction has been voided. | | complete | Transaction has settled. | | unknown | An unknown error was encountered while processing this transaction. | </details> enum: ["pending", "pendingsettlement", "in_progress", "abandoned", "failed", "canceled", "complete", "unknown"] transaction_type string no Retrieves only transactions with the specified transaction type. <details> <summary>Transaction Types</summary> | Transaction Type | Description | |:------------------|:----------------------------| | cc | A credit card transaction. | | ck | A check transaction. | | cs | A cash transaction. | </details> enum: ["cc", "ck", "cs"] action_type string no Retrieves only transactions with the specified action types. A combination of the values can be used and should be separated by commas. For example, to retrieve all transactions with credit or refund actions, use the following: `action_type=refund,credit` <details> <summary>Action Types</summary> | Action Type | Description | |:-------------|:-------------------------------------------------------------------------------------------------| | sale | Sale transactions. | | refund | Refund transactions. | | credit | Credit transactions. | | auth | 'Auth Only' transactions. | | capture | Captured transactions. | | void | Voided transactions. | | return | Electronic Check (ACH) transactions that have returned, as well as credit card chargebacks. | | validate | Validated transactions. | </details> enum: ["sale", "refund", "credit", "auth", "capture", "void", "return", "validate"] source string no Retrieves only transactions with a particular 'transaction source'. A combination of the values can be used and should be separated by commas. For example, to retrieve all transactions with api or recurring actions, use the following: `source=api,recurring` <details> <summary>Sources</summary> | Source | Description | |:-----------------|:--------------------------------------------------------------------------------------------------| | api | API transactions. | | batch_upload | Batch Upload transactions. | | mobile | Mobile (iProcess) transactions. | | quickclick | QuickClick transactions. | | quickbooks | QuickBooks SyncPay transactions. | | recurring | Recurring transactions when using Recurring module. | | swipe | Swipe transactions. | | virtual_terminal | Virtual Terminal transactions. | | internal | Internal transactions. Typically indicates settlement. | </details> enum: ["api", "batch_upload", "mobile", "quickclick", "quickbooks", "recurring", "swipe", "virtual_terminal", "internal"] transaction_id string no Specify a transaction ID or a comma separated list of transaction IDs to retrieve information on. Alternatively, provide a Subscription ID to retrieve processed (approved and declined) transactions associated with it. subscription_id string no Set a specific subscription record or comma separated list of records. Using this with a transaction search will return all transactions associated with this subscription. This will return this subscription's payment/plan information when used with `report_type=recurring`. invoice_id string no Set a specific Invoice ID. Should only be used when `report_type=invoicing`. partial_payment_id string no Retrieves only transactions with the specified partial payment ID. order_id string no Retrieves only transactions with the specified Order ID. first_name string no Retrieves only transactions with the specified first name. last_name string no Retrieves only transactions with the specified last name. address1 string no Retrieves only transactions with the specified specified address. city string no Retrieves only transactions with the specified city. state string no Retrieves only transactions with the specified state. Format: `CC` zip string no Retrieves only transactions with the specified zip/postal code. phone string no Retrieves only transactions with the specified phone number. fax string no Retrieves only transactions with the specified fax number. order_description string no Retrieves only transactions with the specified order description. drivers_license_number string no Retrieves only transactions with the specified driver's license number. drivers_license_dob string no Retrieves only transactions with the specified driver's license date of birth. drivers_license_state string no Retrieves only transactions with the specified driver's license state. email string no Retrieves only transactions with the specified billing email address. cc_number string no Retrieves only transactions with the specified credit card number. You can use either the full number or the last 4 digits of the credit card number. **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. <details> <summary>Allowed Card Numbers:</summary> | Card Type | Test Card Number | |:-------------------------------------|:--------------------| | Visa | 4111111111111111 | | MasterCard | 5431111111111111 | | Discover | 6011000991300009 | | American Express | 341111111111111 | | Diner's Club | 30205252489926 | | JCB | 3541963594572595 | | Maestro | 6799990100000000019 | | Visa, MasterCard, & American Express | 1111 | | Discover | 0009 | | Diner's Club | 9926 | | JCB | 2595 | | Maestro | 0019 | </details> enum: ["4111111111111111", "5431111111111111", "6011000991300009", "341111111111111", "30205252489926", "3541963594572595", "6799990100000000019", "1111", "0009", "9926", "2595", "0019"] merchant_defined_field_1 string no Retrieves only transactions with the specified merchant defined field value. Replace the '1' with a field number (1-20) (Example: `merchant_defined_field_12=value`) start_date string no Only transactions that have been modified on or after this date will be retrieved. Note that any actions performed on a transaction will cause the modified date to be updated. Format: `YYYYMMDDhhmmss` format: "date-time" end_date string no Only transactions that have been modified on or before this date will be retrieved. Note that any actions performed on a transaction will cause the modified date to be updated. Format: `YYYYMMDDhhmmss` format: "date-time" report_type string no Sets the report type. * 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. * If you omit the customer_vault_id, the system will return all customers that are stored in the vault. * If you include a customer_vault_id, it will return the customer record associated with that ID. Example: `report_type=customer_vault&customer_vault _id=123456789` <details> <summary>Report Types</summary> | Report Type | Description | |:-------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | receipt | Will return an html receipt for a specified transaction id. | | customer_vault | Set the Query API to return Customer Vault data. | | recurring | Set the Query API to return subscription data. | | recurring_plans | Set the Query API to return plan data. | | invoicing | Set the Query API to return invoicing data. | | gateway_processors | Will return Processor details a user has permissions for. Specify a "user" by querying with that security key. | | account_updater | Will return Customer Vault data that has been updated using the Account Updater service. | | test_mode_status | Will return whether the account has test mode active or inactive. | | profile | Return merchant profile (company, email, address, timezone, defined fields, gateway, favicon, status). It will also return card_schemes with 'processor_details' set to 'true' | </details> enum: ["receipt", "customer_vault", "recurring", "recurring_plans", "invoicing", "gateway_processors", "account_updater", "test_mode_status", "profile"] mobile_device_license string no Retrieves only transactions processed using the specified mobile device. * The device IDs for this parameter are available in the License Manager. * Use 'any_mobile' to retrieve all mobile transactions. * A combination of the values can be used and should be separated by commas. * Can not be used with 'mobile_device_nickname'. Example 1: `mobile_device_license=D91AC56A-4242-3131-2323-2AE4AA6DB6EB` Example 2: `mobile_device_license=any_mobile` mobile_device_nickname string no Retrieves only transactions processed using mobile devices with the specified nickname. * The nicknames for this parameter are available in the License Manager. * Can not be used with 'mobile_device_license'. Example (URL encoded): `mobile_device_nickname=Jim's%20iPhone` customer_vault_id string no Set a specific Customer Vault record. Should only be used when `report_type=customer_vault`. date_search string no Allows Customer Vault information to be returned based on the 'created' or 'updated' date. * 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. * If you omit the report_type variable, the system will ignore the date_search variable. Example: `report_type=customer_vault&date_search=created,updated&start_date=20170101000000&end_date=20201231232359` | Value | Description | |:---------|:------------------------------------------------------------------------| | created | Will return Customer Vault data created during a specified date range. | | updated | Will return Customer Vault data updated during a specified date range. | enum: ["created", "updated"] result_limit integer no Determines the maximum number of results that may return for the current query. page_number integer no 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 string no Determines order of in which results are returned. Default - `standard`. <details> <summary>Result Orders</summary> | Result Order | Description | |:-----------------|:--------------------------------------------| | standard | Returns the results from oldest to newest. | | reverse | Returns the results from newest to oldest. | enum: ["standard", "reverse"] invoice_status string no Specify a comma separated list of what invoice statuses will return when using an "invoicing" report type. Example: `invoice_status=open,closed,paid` enum: ["open", "paid", "closed", "past_due"] processor_details string no Can be use with `"report_type"="profile"`, this will include merchant `"card_schemes"` in the response additionalProperties string no Up to 20 `merchant_defined_field_#` are allowed. { "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 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 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 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 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. Alternatively, provide a Subscription ID to retrieve processed (approved and declined) transactions 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 will return all transactions associated with this subscription. This will return this subscription's payment/plan 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. 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. Note that any actions performed on a transaction will cause the modified date to be updated. Format: `YYYYMMDDhhmmss`" }, "end_date": { "type": "string", "format": "date-time", "description": "Only transactions that have been modified on or before this date will be retrieved. Note that any actions performed on a transaction will cause the modified date to be updated. 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 querying with that security key. |\n| account_updater | Will return Customer Vault data that has been updated using the 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, gateway, favicon, status). It will also return card_schemes with '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 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. 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" } } } } } true

Responses

Match the HTTP status to its response schema below. For financial operations, also inspect the payment outcome before updating your order or retrying. HTTP status Media type Meaning 200 application/xml ok { "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" } ] } } } } } true

Response fields · 200 · application/xml

Field Type Required Description Constraints [oneOf 1].nm_response object no [oneOf 1].nm_response.transaction array no [oneOf 1].nm_response.transaction[].transaction_id string no Transaction id [oneOf 1].nm_response.transaction[].partial_payment_id string no Partial payment id [oneOf 1].nm_response.transaction[].partial_payment_balance string no Partial payment balance [oneOf 1].nm_response.transaction[].platform_id string no Platform id [oneOf 1].nm_response.transaction[].transaction_type string no Transaction type [oneOf 1].nm_response.transaction[].condition string no Condition [oneOf 1].nm_response.transaction[].order_id string no Order id [oneOf 1].nm_response.transaction[].authorization_code string no Authorization code [oneOf 1].nm_response.transaction[].ponumber string no PO Number [oneOf 1].nm_response.transaction[].order_description string no Order description [oneOf 1].nm_response.transaction[].first_name string no First name [oneOf 1].nm_response.transaction[].last_name string no Last name [oneOf 1].nm_response.transaction[].address_1 string no Address 1 [oneOf 1].nm_response.transaction[].address_2 string no Address 2 [oneOf 1].nm_response.transaction[].company string no Company [oneOf 1].nm_response.transaction[].city string no City [oneOf 1].nm_response.transaction[].state string no State [oneOf 1].nm_response.transaction[].postal_code string no Postal code [oneOf 1].nm_response.transaction[].country string no Country [oneOf 1].nm_response.transaction[].email string no Email [oneOf 1].nm_response.transaction[].phone string no Phone [oneOf 1].nm_response.transaction[].fax string no Fax [oneOf 1].nm_response.transaction[].cell_phone string no Cell phone [oneOf 1].nm_response.transaction[].customertaxid string no Customer tax id [oneOf 1].nm_response.transaction[].customerid string no Customer id [oneOf 1].nm_response.transaction[].website string no Website [oneOf 1].nm_response.transaction[].shipping_first_name string no Shipping first name [oneOf 1].nm_response.transaction[].shipping_last_name string no Shipping last name [oneOf 1].nm_response.transaction[].shipping_address_1 string no Shipping address 1 [oneOf 1].nm_response.transaction[].shipping_address_2 string no Shipping address 2 [oneOf 1].nm_response.transaction[].shipping_company string no Shipping company [oneOf 1].nm_response.transaction[].shipping_city string no Shipping city [oneOf 1].nm_response.transaction[].shipping_state string no Shipping state [oneOf 1].nm_response.transaction[].shipping_postal_code string no Shipping postal code [oneOf 1].nm_response.transaction[].shipping_country string no Shipping country [oneOf 1].nm_response.transaction[].shipping_email string no Shipping email [oneOf 1].nm_response.transaction[].shipping_carrier string no Shipping carrier [oneOf 1].nm_response.transaction[].tracking_number string no Tracking number [oneOf 1].nm_response.transaction[].shipping_date string no Shipping date [oneOf 1].nm_response.transaction[].shipping string no Shipping [oneOf 1].nm_response.transaction[].shipping_phone string no Shipping phone [oneOf 1].nm_response.transaction[].cc_number string no Credit card number [oneOf 1].nm_response.transaction[].cc_hash string no Credit card hash [oneOf 1].nm_response.transaction[].cc_exp string no Credit card expiration [oneOf 1].nm_response.transaction[].cavv string no Cavv [oneOf 1].nm_response.transaction[].cavv_result string no Cavv result [oneOf 1].nm_response.transaction[].xid string no Xid [oneOf 1].nm_response.transaction[].eci string no Eci [oneOf 1].nm_response.transaction[].directory_server_id string no Directory server id [oneOf 1].nm_response.transaction[].three_ds_version string no 3DS version [oneOf 1].nm_response.transaction[].avs_response string no AVS response [oneOf 1].nm_response.transaction[].csc_response string no CSC response [oneOf 1].nm_response.transaction[].cardholder_auth string no Cardholder auth [oneOf 1].nm_response.transaction[].cc_start_date string no Credit card start date [oneOf 1].nm_response.transaction[].cc_issue_number string no Credit card issue number [oneOf 1].nm_response.transaction[].check_account string no Check account [oneOf 1].nm_response.transaction[].check_hash string no Check hash [oneOf 1].nm_response.transaction[].check_aba string no Check ABA [oneOf 1].nm_response.transaction[].check_name string no Check name [oneOf 1].nm_response.transaction[].account_holder_type string no Account holder type [oneOf 1].nm_response.transaction[].account_type string no Account type [oneOf 1].nm_response.transaction[].sec_code string no Sec code [oneOf 1].nm_response.transaction[].drivers_license_number string no Drivers license number [oneOf 1].nm_response.transaction[].drivers_license_state string no Drivers license state [oneOf 1].nm_response.transaction[].drivers_license_dob string no Drivers license dob [oneOf 1].nm_response.transaction[].social_security_number string no Social security number [oneOf 1].nm_response.transaction[].processor_id string no Processor id [oneOf 1].nm_response.transaction[].tax string no Tax [oneOf 1].nm_response.transaction[].currency string no Currency [oneOf 1].nm_response.transaction[].surcharge string no Surcharge [oneOf 1].nm_response.transaction[].convenience_fee string no Convenience Fee [oneOf 1].nm_response.transaction[].misc_fee string no Miscelaneous Fee [oneOf 1].nm_response.transaction[].misc_fee_name string no Miscelaneous Fee Name [oneOf 1].nm_response.transaction[].cash_discount string no Cash discount [oneOf 1].nm_response.transaction[].tip string no Tip [oneOf 1].nm_response.transaction[].card_balance string no Card balance [oneOf 1].nm_response.transaction[].card_available_balance string no Card available balance [oneOf 1].nm_response.transaction[].entry_mode string no Entry mode [oneOf 1].nm_response.transaction[].cc_bin string no Credit card bin [oneOf 1].nm_response.transaction[].cc_type string no Credit card type [oneOf 1].nm_response.transaction[].signature_image string no Signature image [oneOf 1].nm_response.transaction[].product object no [oneOf 1].nm_response.transaction[].product.sku string no SKU [oneOf 1].nm_response.transaction[].product.quantity string no Quantity [oneOf 1].nm_response.transaction[].product.description string no Description [oneOf 1].nm_response.transaction[].product.amount string no Amount [oneOf 1].nm_response.transaction[].duty_amount string no Duty amount [oneOf 1].nm_response.transaction[].discount_amount string no Discount amount [oneOf 1].nm_response.transaction[].national_tax_amount string no National tax amount [oneOf 1].nm_response.transaction[].summary_commodity_code string no Summary commodity code [oneOf 1].nm_response.transaction[].vat_tax_amount string no Vat tax amount [oneOf 1].nm_response.transaction[].vat_tax_rate string no Vat tax rate [oneOf 1].nm_response.transaction[].alternate_tax_amount string no Alternate tax amount [oneOf 1].nm_response.transaction[].action array no [oneOf 1].nm_response.transaction[].action[].amount string no Amount [oneOf 1].nm_response.transaction[].action[].action_type string no Action type [oneOf 1].nm_response.transaction[].action[].date string no Date [oneOf 1].nm_response.transaction[].action[].success string no Success [oneOf 1].nm_response.transaction[].action[].ip_address string no IP address [oneOf 1].nm_response.transaction[].action[].source string no Source [oneOf 1].nm_response.transaction[].action[].api_method string no API method [oneOf 1].nm_response.transaction[].action[].tap_to_mobile string no Tap to mobile [oneOf 1].nm_response.transaction[].action[].username string no Username [oneOf 1].nm_response.transaction[].action[].response_text string no Response text [oneOf 1].nm_response.transaction[].action[].batch_id string no Batch id [oneOf 1].nm_response.transaction[].action[].processor_batch_id string no Processor batch id [oneOf 1].nm_response.transaction[].action[].response_code string no Response code [oneOf 1].nm_response.transaction[].action[].processor_response_text string no Processor response text [oneOf 1].nm_response.transaction[].action[].processor_response_code string no Processor response code [oneOf 1].nm_response.transaction[].action[].requested_amount string no Requested amount [oneOf 1].nm_response.transaction[].action[].device_license_number string no Device license number [oneOf 1].nm_response.transaction[].action[].device_nickname string no Device nickname [oneOf 2].nm_response object no [oneOf 2].nm_response.customer_vault object no [oneOf 2].nm_response.customer_vault.customer array no [oneOf 2].nm_response.customer_vault.customer[].id string no Customer ID [oneOf 2].nm_response.customer_vault.customer[].first_name string no First name of the customer [oneOf 2].nm_response.customer_vault.customer[].last_name string no Last name of the customer [oneOf 2].nm_response.customer_vault.customer[].address_1 string no Primary address line of the customer [oneOf 2].nm_response.customer_vault.customer[].address_2 string no Secondary address line of the customer [oneOf 2].nm_response.customer_vault.customer[].company string no Company name associated with the customer [oneOf 2].nm_response.customer_vault.customer[].city string no City of the customer's address [oneOf 2].nm_response.customer_vault.customer[].state string no State of the customer's address [oneOf 2].nm_response.customer_vault.customer[].postal_code string no Postal code of the customer's address [oneOf 2].nm_response.customer_vault.customer[].country string no Country of the customer's address [oneOf 2].nm_response.customer_vault.customer[].email string no Email address of the customer [oneOf 2].nm_response.customer_vault.customer[].phone string no Phone number of the customer [oneOf 2].nm_response.customer_vault.customer[].fax string no Fax number of the customer [oneOf 2].nm_response.customer_vault.customer[].cell_phone string no Cell phone number of the customer [oneOf 2].nm_response.customer_vault.customer[].customertaxid string no Customer's tax identification number [oneOf 2].nm_response.customer_vault.customer[].website string no Website associated with the customer [oneOf 2].nm_response.customer_vault.customer[].shipping_first_name string no First name for shipping details [oneOf 2].nm_response.customer_vault.customer[].shipping_last_name string no Last name for shipping details [oneOf 2].nm_response.customer_vault.customer[].shipping_address_1 string no Primary shipping address line [oneOf 2].nm_response.customer_vault.customer[].shipping_address_2 string no Secondary shipping address line [oneOf 2].nm_response.customer_vault.customer[].shipping_company string no Shipping company name [oneOf 2].nm_response.customer_vault.customer[].shipping_city string no Shipping city [oneOf 2].nm_response.customer_vault.customer[].shipping_state string no Shipping state [oneOf 2].nm_response.customer_vault.customer[].shipping_postal_code string no Shipping postal code [oneOf 2].nm_response.customer_vault.customer[].shipping_country string no Shipping country [oneOf 2].nm_response.customer_vault.customer[].shipping_email string no Email address for shipping [oneOf 2].nm_response.customer_vault.customer[].shipping_carrier string no Shipping carrier details [oneOf 2].nm_response.customer_vault.customer[].tracking_number string no Shipping tracking number [oneOf 2].nm_response.customer_vault.customer[].shipping_date string no Shipping date [oneOf 2].nm_response.customer_vault.customer[].shipping string no Shipping cost [oneOf 2].nm_response.customer_vault.customer[].cc_number string no Credit card number (masked) [oneOf 2].nm_response.customer_vault.customer[].cc_hash string no Credit card hash [oneOf 2].nm_response.customer_vault.customer[].cc_exp string no Credit card expiration date [oneOf 2].nm_response.customer_vault.customer[].cc_start_date string no Credit card start date [oneOf 2].nm_response.customer_vault.customer[].cc_issue_number string no Credit card issue number [oneOf 2].nm_response.customer_vault.customer[].check_account string no Check account details [oneOf 2].nm_response.customer_vault.customer[].check_hash string no Check hash value [oneOf 2].nm_response.customer_vault.customer[].check_aba string no Check ABA routing number [oneOf 2].nm_response.customer_vault.customer[].check_name string no Name on the check [oneOf 2].nm_response.customer_vault.customer[].account_holder_type string no Account holder type [oneOf 2].nm_response.customer_vault.customer[].account_type string no Type of bank account [oneOf 2].nm_response.customer_vault.customer[].sec_code string no SEC code for ACH transactions [oneOf 2].nm_response.customer_vault.customer[].processor_id string no Processor ID [oneOf 2].nm_response.customer_vault.customer[].cc_bin string no Credit card BIN number [oneOf 2].nm_response.customer_vault.customer[].cc_type string no Credit card type [oneOf 2].nm_response.customer_vault.customer[].created string no Creation date [oneOf 2].nm_response.customer_vault.customer[].updated string no Last update date [oneOf 2].nm_response.customer_vault.customer[].account_updated string no Last account update date [oneOf 2].nm_response.customer_vault.customer[].customer_vault_id string no Customer vault ID [oneOf 3].nm_response object no [oneOf 3].nm_response.subscription array no [oneOf 3].nm_response.subscription[].id string no Unique identifier for the subscription [oneOf 3].nm_response.subscription[].subscription_id string no Subscription-specific ID [oneOf 3].nm_response.subscription[].plan object no [oneOf 3].nm_response.subscription[].plan.plan_id string no Plan's specific ID [oneOf 3].nm_response.subscription[].plan.plan_name string no Name of the plan [oneOf 3].nm_response.subscription[].plan.plan_amount string no Amount associated with the plan [oneOf 3].nm_response.subscription[].plan.plan_payments string no Number of payments for the plan [oneOf 3].nm_response.subscription[].plan.day_frequency string no Frequency of the plan in days [oneOf 3].nm_response.subscription[].next_charge_date string no Date of next charge for the subscription [oneOf 3].nm_response.subscription[].completed_payments string no Number of completed payments [oneOf 3].nm_response.subscription[].attempted_payments string no Number of attempted payments [oneOf 3].nm_response.subscription[].remaining_payments string no Number of remaining payments [oneOf 3].nm_response.subscription[].ponumber string no Purchase Order number [oneOf 3].nm_response.subscription[].orderid string no Order ID [oneOf 3].nm_response.subscription[].order_description string no Description of the order [oneOf 3].nm_response.subscription[].shipping string no Shipping details [oneOf 3].nm_response.subscription[].tax string no Tax details [oneOf 3].nm_response.subscription[].first_name string no First name of the customer [oneOf 3].nm_response.subscription[].last_name string no Last name of the customer [oneOf 3].nm_response.subscription[].address_1 string no Address line 1 [oneOf 3].nm_response.subscription[].address_2 string no Address line 2 [oneOf 3].nm_response.subscription[].company string no Company name [oneOf 3].nm_response.subscription[].city string no City [oneOf 3].nm_response.subscription[].state string no State or region [oneOf 3].nm_response.subscription[].postal_code string no Postal code [oneOf 3].nm_response.subscription[].country string no Country [oneOf 3].nm_response.subscription[].email string no Email address [oneOf 3].nm_response.subscription[].phone string no Phone number [oneOf 3].nm_response.subscription[].fax string no Fax number [oneOf 3].nm_response.subscription[].cell_phone string no Cell phone number [oneOf 3].nm_response.subscription[].customertaxid string no Customer's tax identification number [oneOf 3].nm_response.subscription[].website string no Website URL [oneOf 3].nm_response.subscription[].cc_number string no Credit card number [oneOf 3].nm_response.subscription[].cc_hash string no Credit card hash [oneOf 3].nm_response.subscription[].cc_exp string no Credit card expiration date [oneOf 3].nm_response.subscription[].cc_start_date string no Credit card start date [oneOf 3].nm_response.subscription[].cc_issue_number string no Credit card issue number [oneOf 3].nm_response.subscription[].cc_bin string no Credit card BIN number [oneOf 3].nm_response.subscription[].processor_id string no Processor ID [oneOf 4].nm_response object no [oneOf 4].nm_response.plan array no [oneOf 4].nm_response.plan[].id string no Unique identifier for the plan [oneOf 4].nm_response.plan[].plan_id string no Plan's specific ID [oneOf 4].nm_response.plan[].plan_name string no Name of the recurring plan [oneOf 4].nm_response.plan[].plan_amount string no Amount associated with the plan [oneOf 4].nm_response.plan[].day_frequency string no Frequency of the plan in days [oneOf 4].nm_response.plan[].month_frequency string no Frequency of the plan in months [oneOf 4].nm_response.plan[].day_of_month string no Specific day of the month for the plan [oneOf 4].nm_response.plan[].plan_payments string no Number of payments for the plan [oneOf 5].nm_response object no [oneOf 5].nm_response.invoice_report object no [oneOf 5].nm_response.invoice_report.invoice array no [oneOf 5].nm_response.invoice_report.invoice[].invoice_id string no Unique identifier for the invoice [oneOf 5].nm_response.invoice_report.invoice[].amount string no Total amount of the invoice [oneOf 5].nm_response.invoice_report.invoice[].status string no Status of the invoice [oneOf 5].nm_response.invoice_report.invoice[].currency string no Currency code for the invoice amount [oneOf 5].nm_response.invoice_report.invoice[].order_description string no Description of the order [oneOf 5].nm_response.invoice_report.invoice[].customer_id string no Unique identifier for the customer [oneOf 5].nm_response.invoice_report.invoice[].customer_tax_id string no Tax ID associated with the customer [oneOf 5].nm_response.invoice_report.invoice[].order_id string no Unique identifier for the order [oneOf 5].nm_response.invoice_report.invoice[].po_number string no Purchase order number [oneOf 5].nm_response.invoice_report.invoice[].tax_amount string no Total tax amount for the invoice [oneOf 5].nm_response.invoice_report.invoice[].shipping_amount string no Total shipping amount for the invoice [oneOf 5].nm_response.invoice_report.invoice[].discount_amount string no Total discount amount for the invoice [oneOf 5].nm_response.invoice_report.invoice[].created string no Creation date of the invoice [oneOf 5].nm_response.invoice_report.invoice[].terms string no Payment terms for the invoice [oneOf 5].nm_response.invoice_report.invoice[].payments_applied string no Total payments applied to the invoice [oneOf 5].nm_response.invoice_report.invoice[].billing object no [oneOf 5].nm_response.invoice_report.invoice[].billing.first_name string no First name for billing contact [oneOf 5].nm_response.invoice_report.invoice[].billing.last_name string no Last name for billing contact [oneOf 5].nm_response.invoice_report.invoice[].billing.address1 string no Primary address line for billing [oneOf 5].nm_response.invoice_report.invoice[].billing.address2 string no Secondary address line for billing [oneOf 5].nm_response.invoice_report.invoice[].billing.company string no Company name for billing [oneOf 5].nm_response.invoice_report.invoice[].billing.city string no City for billing [oneOf 5].nm_response.invoice_report.invoice[].billing.state string no State for billing [oneOf 5].nm_response.invoice_report.invoice[].billing.postal string no Postal code for billing [oneOf 5].nm_response.invoice_report.invoice[].billing.country string no Country for billing [oneOf 5].nm_response.invoice_report.invoice[].billing.email string no Email address for billing [oneOf 5].nm_response.invoice_report.invoice[].billing.phone string no Phone number for billing [oneOf 5].nm_response.invoice_report.invoice[].billing.fax string no Fax number for billing [oneOf 5].nm_response.invoice_report.invoice[].shipping object no [oneOf 5].nm_response.invoice_report.invoice[].shipping.first_name string no First name for shipping contact [oneOf 5].nm_response.invoice_report.invoice[].shipping.last_name string no Last name for shipping contact [oneOf 5].nm_response.invoice_report.invoice[].shipping.address1 string no Primary address line for shipping [oneOf 5].nm_response.invoice_report.invoice[].shipping.address2 string no Secondary address line for shipping [oneOf 5].nm_response.invoice_report.invoice[].shipping.company string no Company name for shipping [oneOf 5].nm_response.invoice_report.invoice[].shipping.city string no City for shipping [oneOf 5].nm_response.invoice_report.invoice[].shipping.state string no State for shipping [oneOf 5].nm_response.invoice_report.invoice[].shipping.postal string no Postal code for shipping [oneOf 5].nm_response.invoice_report.invoice[].shipping.country string no Country for shipping [oneOf 5].nm_response.invoice_report.invoice[].shipping.email string no Email address for shipping [oneOf 5].nm_response.invoice_report.invoice[].shipping.phone string no Phone number for shipping [oneOf 5].nm_response.invoice_report.invoice[].shipping.fax string no Fax number for shipping [oneOf 6].nm_response object no [oneOf 6].nm_response.gateway_processor array no [oneOf 6].nm_response.gateway_processor[].description string no Description of the gateway processor [oneOf 6].nm_response.gateway_processor[].processor_id string no Unique identifier for the processor [oneOf 6].nm_response.gateway_processor[].platform string no Platform associated with the gateway processor [oneOf 6].nm_response.gateway_processor[].emv_support string no EMV support status; indicates whether the processor supports EMV transactions [oneOf 6].nm_response.gateway_processor[].mcc string no Merchant category code [oneOf 7].nm_response object no [oneOf 7].nm_response.protected string no Indicates whether the response is protected [oneOf 7].nm_response.is_gateway string no Indicates whether the response is related to a gateway [oneOf 7].nm_response.merchant object no [oneOf 7].nm_response.merchant.company string no Merchant's company name [oneOf 7].nm_response.merchant.email string no Merchant's email address [oneOf 7].nm_response.merchant.phone string no Merchant's phone number [oneOf 7].nm_response.merchant.url string no Merchant's website URL [oneOf 7].nm_response.merchant.address1 string no Merchant's primary address line [oneOf 7].nm_response.merchant.address2 string no Merchant's secondary address line [oneOf 7].nm_response.merchant.city string no Merchant's city [oneOf 7].nm_response.merchant.state string no Merchant's state [oneOf 7].nm_response.merchant.zip string no Merchant's ZIP code [oneOf 7].nm_response.merchant.country string no Merchant's country [oneOf 7].nm_response.merchant.timezone string no Merchant's timezone [oneOf 7].nm_response.merchant.card_schemes string no Supported card schemes by the merchant [oneOf 7].nm_response.gateway object no [oneOf 7].nm_response.gateway.company string no Gateway's company name [oneOf 7].nm_response.gateway.url string no Gateway's website URL [oneOf 7].nm_response.gateway.email string no Gateway's email address [oneOf 7].nm_response.gateway.phone string no Gateway's phone number [oneOf 7].nm_response.gateway.primary_color string no Gateway's primary color code [oneOf 7].nm_response.gateway.complimentary_color_1 string no Gateway's first complimentary color code [oneOf 7].nm_response.gateway.complimentary_color_2 string no Gateway's second complimentary color code [oneOf 7].nm_response.merchant_defined_fields array no Merchant-defined fields [oneOf 7].nm_response.processors object no [oneOf 7].nm_response.processors.processor array no [oneOf 7].nm_response.processors.processor[].id string no Processor's unique identifier [oneOf 7].nm_response.processors.processor[].type string no Processor's type [oneOf 7].nm_response.processors.processor[].platform string no Processor's platform [oneOf 7].nm_response.processors.processor[].tap_to_mobile object no Details related to tap mobile functionality [oneOf 7].nm_response.processors.processor[].required_fields string no Fields required by the processor [oneOf 7].nm_response.processors.processor[].currencies object no Supported currencies by the processor [oneOf 7].nm_response.processors.processor[].merchant_category_code string no Merchant category code associated with the processor [oneOf 7].nm_response.merchant_favicon string no Merchant's favicon data [oneOf 7].nm_response.account_details object no [oneOf 7].nm_response.account_details.account_status string no Status of the merchant's account [oneOf 7].nm_response.account_details.test_mode_enabled string no Indicates whether test mode is enabled for the merchant's account

Referenced schema definitions

References beginning with #/components resolve to these definitions. These are field contracts, not example payment values. Use the applicable variant, required fields and constraints. { "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." } } } true

Integration checks

Validate the request against its selected schema before submission. Keep secrets outside browser code. Test permitted and denied account access, validation failures and interrupted responses in the sandbox. Account-management or messaging operations require the corresponding partner access and intended recipient context.