Get Transaction Data
POST /v4/transactions/reports
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>Usage</summary> This is a query to find live transactions by merchants under your partner account. The query will respond in Universal Time Coordinated (UTC). If you provide a specific transaction id, then it will return that transaction. If you provide a sub-affiliates' merchant id in the merchant id list, it will return that merchant's transactions. </details> POST /v4/transactions/reports 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 one valid request variant from the fields/examples below as request.json. Do not combine mutually exclusive variants. The payload is deliberately not fabricated from schema defaults. 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/v4/transactions/reports' \ --header 'Content-Type: application/json' \ --header 'Authorization: <Authorization>' \ --data-binary '@request.json' import { readFile } from 'node:fs/promises'; const body = await readFile('request.json', 'utf8'); const response = await fetch("https://sandbox.nmi.com/api/v4/transactions/reports", { method: 'POST', headers: { "Content-Type": "application/json", "Authorization": "<Authorization>" }, 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/v4/transactions/reports', method='POST', headers={'Content-Type': 'application/json', 'Authorization': '<Authorization>'}, data=Path('request.json').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/v4/transactions/reports") request = Net::HTTP::Post.new(uri) request["Content-Type"] = "application/json" request["Authorization"] = "<Authorization>" request.body = File.binread('request.json') 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/v4/transactions/reports'); curl_setopt_array($curl, [ CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 30, CURLOPT_HTTPHEADER => ['Content-Type: application/json', 'Authorization: <Authorization>'], CURLOPT_POSTFIELDS => file_get_contents('request.json') ]); $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);
Path and query parameters
Required flags apply to the parameter itself. Additional limits and enum values appear in the contract below. Parameter Location Required Type Description Content-Type header true string The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending). Authorization header true string Your v4 API key that was generated in the Partner portal. [ { "name": "Content-Type", "in": "header", "required": true, "schema": { "type": "string" }, "description": "The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).", "example": "application/json" }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Your v4 API key that was generated in the Partner portal." } ] true
Request body
Use the declared media type: application/json. Required flags below apply within the selected object or variant. Read the workflow notes before choosing a variant. Field Type Required Description Constraints [allOf 1].merchantId string no The merchant gateway ID to which the transactions belong. [allOf 1].merchantIds array no The merchants gateway IDs to which the transactions belong. [allOf 1].maxResults string yes Maximum number of results per page. [allOf 1].offset string no Offset value for pagination, or null if not used. [allOf 1].orderId string no The order ID of the transaction. [allOf 1].par string no The Payment Account Reference ID to search for. [allOf 1].hmac string no The Hash-based Message Authentication Code ID to search for. [allOf 1].serviceId string no The ID of the processor platform you want to search for. [allOf 1].platformId string no The ID of the platform. [allOf 1].firstName string no The first name of the merchant's company contact. [allOf 1].lastName string no The last name of the merchant's company contact. [allOf 1].email string no The email of the merchant's company contact. [allOf 1].accountNumber string no Account Number. [allOf 1].transactionType string no Transaction type. [allOf 1].customerId string no Customer ID. [allOf 1].phone string no The phone number of the merchant's company contact. [allOf 1].transactionIds array no Transactions IDs to search. [allOf 1].statuses array no The list of statuses to query. [allOf 1].actionTypes array no The type of transaction to query. [allOf 1].amount object no Min and max amount for transactions to search. [allOf 1].amount.min number no Min amount. [allOf 1].amount.max number no Max amount. [allOf 1].date object no Start and End date for query transactions. [allOf 1].date.start string no Start date. [allOf 1].date.end string no End date. { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionDataRequest" }, "examples": { "Create Standard Merchant": { "$ref": "#/components/examples/GetTransactionDataExampleRequest" } } } } } 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/json Success { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransactionDataResponse" }, "examples": { "Get Processor Config": { "$ref": "#/components/examples/GetTransactionDataExampleResponse" } } } } } } true
Response fields · 200 · application/json
Field Type Required Description Constraints objectType string no The type of object that was returned as a result of the request. enum: ["serviceConfig"] reportId number no The ID of the report. offset number no The first N skipped results. maxResults number no The max number results. totalResults number no The total number of results. hasMore boolean no Indicates if there are more results available beyond the current page. links object no Pagination links for navigating through the report results. links.first string no URL to the first page of results. format: "uri" links.last string no URL to the last page of results. format: "uri" links.next string no URL to the next page of results. format: "uri" links.previous string no URL to the previous page of results. format: "uri" results array no Results for the search. results[].objectType string no Type of the returned response object. results[].id string no The ID for the transaction. results[].created string no The timestamp indicating when the transaction was created. format: "date-time" results[].updated string no The timestamp indicating when the transaction was last updated. format: "date-time" results[].billingAddress object no Billing Address details. results[].billingAddress.first_name string no The first name of the person associated with the billing address. results[].billingAddress.last_name string no The last name of the person associated with the billing address. results[].billingAddress.address_1 string no The first line of the street address. results[].billingAddress.address_2 string no The second line of the street address. results[].billingAddress.company string no The name of the company associated with the billing address. results[].billingAddress.city string no The name of the city associated with the billing address. results[].billingAddress.state string no The name of the state or province associated with the billing address. Format: `CC`. results[].billingAddress.postal_code string no The postal code or zip code associated with the billing address. results[].billingAddress.country string no The name of the country associated with the billing address. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC`. results[].billingAddress.email string no The email address associated with the billing address. format: "email" results[].billingAddress.phone string no The phone number associated with the billing address. format: "phone" results[].billingAddress.cell_phone string no The cell phone number associated with the billing address. format: "phone" results[].billingAddress.fax string no The fax number associated with the billing address. format: "phone" results[].shippingAddress object no Shipping Address details. results[].shippingAddress.first_name string no The first name of the person associated with the shipping address. results[].shippingAddress.last_name string no The last name of the person associated with the shipping address. results[].shippingAddress.address_1 string no The first line of the street address. results[].shippingAddress.address_2 string no The second line of the street address. results[].shippingAddress.company string no The name of the company associated with the shipping address. results[].shippingAddress.city string no The city of the shipping address. results[].shippingAddress.state string no The state or province of the shipping address. Format: `CC`. results[].shippingAddress.postal_code string no The postal or zip code of the shipping address. results[].shippingAddress.country string no The country of the shipping address. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC`. results[].shippingAddress.email string no The email address associated with the shipping address. results[].shippingAddress.phone string no The phone number associated with the shipping address. results[].shippingAddress.fax string no The fax number associated with the shipping address. results[].shipping object no The shipping details associated with the transaction. results[].shipping.objectType string no The type of the object, representing shipping details. results[].shipping.carrier string no The carrier used for shipping. results[].shipping.trackingNumber string no The tracking number provided by the shipping carrier. results[].shipping.date string no The date the item was shipped. format: "date-time" results[].shipping.fromPostalCode string no The postal code from where the item was shipped. results[].shipping.amount object no The amount details for shipping. results[].shipping.amount.objectType string no The type of the object, representing the shipping amount. results[].shipping.amount.amount string no The monetary amount for shipping. results[].shipping.amount.currency string no The currency of the shipping amount. results[].merchantId string no The ID for the merchant involved in the transaction. results[].platformId string no The ID for the platform facilitating the transaction. results[].customerId string no The ID for the customer involved in the transaction. results[].orderId string no The order ID associated with the transaction. results[].orderDescription string no A description of the order associated with the transaction. results[].processorId string no The ID for the payment processor handling the transaction. results[].poNumber string no The purchase order number associated with the transaction. results[].refId string no A reference identifier for the transaction. results[].authorizationCode string no The authorization code for the transaction, provided by the payment processor. results[].status string no The current status of the transaction. results[].driversLicense object no The driver's license details associated with the transaction. results[].driversLicense.objectType string no The type of the object, representing a driver's license. results[].driversLicense.dateOfBirth string no The birth date of the individual associated with the driver's license. format: "date" results[].driversLicense.number string no The unique number of the driver's license. results[].driversLicense.state string no The state or province that issued the driver's license. results[].tax object no The tax details associated with the transaction. results[].tax.objectType string no The type of the object, representing the tax amount. results[].tax.amount string no The monetary amount for tax. results[].tax.currency string no The currency of the tax amount. results[].tip object no The tip details associated with the transaction. results[].tip.objectType string no The type of the object, representing the tip amount. results[].tip.amount string no The monetary amount for the tip. results[].tip.currency string no The currency of the tip amount. results[].merchantDefinedFields object no Custom fields defined by the merchant for additional information related to the transaction. results[].vat object no The VAT details associated with the transaction. results[].vat.objectType string no The type of the object, representing the VAT details. results[].vat.taxRate object no The VAT rate details. results[].vat.taxRate.objectType string no The type of the object, representing the tax rate. results[].vat.taxRate.amount string no The VAT rate applied. results[].vat.taxRate.currency string no The currency of the VAT rate. results[].vat.invoiceReferenceNumber string no The reference number for the invoice related to the VAT. results[].vat.customerVatRegistration string no The VAT registration number of the customer. results[].vat.merchantVatRegistration string no The VAT registration number of the merchant. results[].summaryCommodityCode string no The summary commodity code related to the transaction. results[].orderDate string no The date when the order was placed. format: "date-time" results[].installmentBilling object no The installment billing details associated with the transaction. results[].installmentBilling.objectType string no The type of the object, representing installment billing details. results[].installmentBilling.billingNumber string no The current installment number being billed. results[].installmentBilling.billingTotal object no The total billing amount details for the installment. results[].installmentBilling.billingTotal.objectType string no The type of the object, representing the total billing amount for the installment. results[].installmentBilling.billingTotal.amount string no The monetary amount for the total installment billing. results[].installmentBilling.billingTotal.currency string no The currency of the installment billing amount. results[].alternateTaxId string no An alternate tax identifier for the transaction. results[].customerTaxId string no The tax identifier for the customer associated with the transaction. results[].website string no The website associated with the transaction. results[].socialSecurityNumber string no The social security number of the individual involved in the transaction. results[].serviceId string no The ID for the service used in the transaction. results[].surcharge object no The surcharge details associated with the transaction. results[].surcharge.objectType string no The type of the object, representing the surcharge amount. results[].surcharge.amount string no The monetary amount for the surcharge. results[].surcharge.currency string no The currency of the surcharge amount. results[].partialPayment object no The partial payment details associated with the transaction. results[].partialPayment.objectType string no The type of the object, representing partial payment details. results[].partialPayment.id string no The ID for the partial payment. results[].partialPayment.balance object no The balance details for the partial payment. results[].partialPayment.balance.objectType string no The type of the object, representing the balance amount. results[].partialPayment.balance.amount string no The remaining balance for the partial payment. results[].partialPayment.balance.currency string no The currency of the remaining balance amount. results[].refundableBalance object no The refundable balance details for the transaction. results[].refundableBalance.objectType string no The type of the object, representing the refundable balance. results[].refundableBalance.amount string no The monetary amount available for refund. results[].refundableBalance.currency string no The currency of the refundable balance. results[].actions array no A list of actions associated with the transaction. results[].actions[].objectType string no The type of the object, representing an action. results[].actions[].amount object no The amount details for the action. results[].actions[].amount.objectType string no The type of the object, representing the action amount. results[].actions[].amount.amount string no The monetary amount for the action. results[].actions[].amount.currency string no The currency of the action amount. results[].actions[].actionType string no The type of action performed, such as 'sale' or 'refund'. results[].actions[].date string no The timestamp when the action was performed. format: "date-time" results[].actions[].success boolean no Indicates whether the action was successful. results[].actions[].ipAddress string no The IP address from where the action was initiated. results[].actions[].source string no The source from which the action was performed, such as 'virtualTerminal'. results[].actions[].apiMethod string no The API method used to perform the action. results[].actions[].username string no The username of the individual who performed the action. results[].actions[].responseText string no The response text returned by the system for the action. results[].actions[].batchId string no The identifier for the batch in which the action was included. results[].actions[].platformBatchId string no The platform-specific batch identifier for the action. results[].actions[].responseCode string no The response code returned by the system for the action. results[].actions[].platformResponseText string no The platform-specific response text for the action. results[].actions[].platformResponseCode string no The platform-specific response code for the action. results[].actions[].deviceLicenseNumber string no The license number of the device used for the action. results[].actions[].deviceNickname string no The nickname of the device used for the action. results[].items array no A list of items associated with the transaction. results[].emv object no The EMV details associated with the transaction. results[].emv.objectType string no The type of the object, representing EMV (Europay, Mastercard, and Visa) details. results[].emv.applicationId string no The ID for the EMV application. results[].emv.applicationPreferredName string no The preferred name of the EMV application. results[].emv.applicationLabels string no Labels associated with the EMV application. results[].emv.terminalStatusId string no The status identifier of the terminal processing the EMV transaction. results[].paymentInfo object no results[].paymentInfo.objectType string no The type of the object, representing payment card information. results[].paymentInfo.cardNumber string no The masked card number used for the transaction. results[].paymentInfo.cardExp string no The expiration date of the card used for the transaction. results[].paymentInfo.cardHash string no A hash value of the card information used for transaction security. results[].paymentInfo.avsResponse string no The response from the Address Verification System (AVS) for the card. results[].paymentInfo.cardholderAuth string no The authentication response for the cardholder. results[].paymentInfo.cscResponse string no The response from the Card Security Code (CSC) verification. results[].paymentInfo.cardStartDate string no The start date of the card, if applicable. results[].paymentInfo.cardIssueNumber string no The issue number of the card, if applicable. results[].paymentInfo.cardBalance string no The balance available on the card, if applicable. results[].paymentInfo.cardAvailableBalance string no The available balance on the card, if applicable. results[].paymentInfo.entryMode string no The mode used to enter the card information, such as 'swiped' or 'keyed'. results[].paymentInfo.cardBin string no The Bank Identification Number (BIN) of the card used for the transaction. results[].paymentInfo.cardType string no The type of card used, such as 'visa' or 'mastercard'. results[].paymentInfo.cardHolderAuthentication object no results[].paymentInfo.cardHolderAuthentication.objectType string no The type of the object, representing cardholder authentication details. results[].paymentInfo.cardHolderAuthentication.xid string no The transaction identifier for cardholder authentication. results[].paymentInfo.cardHolderAuthentication.eci string no The electronic commerce indicator for cardholder authentication. results[].paymentInfo.cardHolderAuthentication.cavv string no The cardholder authentication verification value. results[].paymentInfo.cardHolderAuthentication.cavvResult string no The result of the cardholder authentication verification. results[].paymentInfo.cardHolderAuthentication.directoryServerId string no The identifier for the directory server involved in cardholder authentication. results[].paymentInfo.cardHolderAuthentication.threeDsVersion string no The version of the 3D Secure protocol used for authentication. results[].storedCredentials object no The stored credentials details associated with the transaction. results[].storedCredentials.objectType string no The type of the object, representing stored credentials. results[].storedCredentials.initiatedBy string no The initiator of the transaction, indicating whether it was 'merchant' or 'cardholder' initiated. results[].storedCredentials.initialTransactionId string no The ID of the initial transaction for stored credentials. results[].storedCredentials.storedIndicator string no Indicates whether the credentials are stored, typically 'true' or 'false'. results[].storedCredentials.credentialOnFileSupported boolean no Indicates whether the system supports storing credentials on file. results[].authorizationState string no The state of authorization for the transaction. results[].cardholderVerificationMethod string no The method used for cardholder verification during the transaction.
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": { "GetTransactionDataExampleRequest": { "summary": "Get Transaction Data", "description": "Below is an example of a request that\u2019s searching for all available fields. You can pick and choose which ones you\u2019d like to actually search for.\nNote - there\u2019s `merchantId` (singular search) and `merchantIds` (an array of ids to search for)\n`maxResults` is the only required argument, and it must be between 1-1000", "value": { "maxResults": 100, "offset": 0, "orderId": "2", "par": "5", "hmac": "6", "merchantIds": [ "33" ], "serviceId": "tsys", "platformId": "3", "firstName": "Jane", "lastName": "Doe", "email": "someone@example.com", "accountNumber": "123123123", "transactionType": "check", "customerId": "456342523", "phone": "5555555555", "transactionIds": [ "34643323456345", "34643323456346" ], "statuses": [ "complete" ], "actionTypes": [ "sale", "auth", "void", "refund", "credit", "validate" ], "amount": { "min": 1, "max": 100 }, "date": { "start": "2021-08-01T05:00:00Z", "end": "2021-09-01T04:59:00Z" } } }, "GetTransactionDataExampleResponse": { "summary": "Get Transaction Data response", "description": "<b>Note</b> - the `objectType` is included in all responses and they are shared types that exist throughout the v4 api. Anytime you get back an object, if it has a specific `objectType`, it will always have the exact same structure as any other response that includes that same object type.", "value": { "objectType": "report", "reportId": 46345, "offset": 0, "maxResults": 50, "totalResults": 320, "hasMore": true, "links": { "first": "https://sandbox.nmi.com/api/v4/transactions/reports/46345?maxResults= 50", "last": "https://sandbox.nmi.com/api/v4/transactions/reports/46345?offset=50&m axResults=50", "next": "https://sandbox.nmi.com/api/v4/transactions/reports/46345?offset=50&m axResults=50", "previous": "https://sandbox.nmi.com/api/v4/transactions/reports/46345?offset=0&ma xResults=50" }, "results": [ { "objectType": "cardTransaction", "id": "281474976710713", "created": "2021-08-19T19:55:32+00:00", "updated": "2021-08-19T19:55:32+00:00", "billingAddress": { "objectType": "billingAddress", "firstName": "", "lastName": "", "company": "", "email": "", "phone": "", "fax": "", "website": "", "address1": "", "address2": "", "city": "", "state": "", "postalCode": "", "country": "US", "cellPhone": "" }, "shippingAddress": { "objectType": "shippingAddress", "company": "", "country": "US", "postalCode": "", "state": "", "city": "", "address1": "", "address2": "", "firstName": "", "lastName": "", "email": "", "phone": "", "fax": "" }, "shipping": { "objectType": "shipping", "carrier": "", "trackingNumber": "", "date": null, "fromPostalCode": "", "amount": { "objectType": "amount", "amount": "0.00", "currency": "USD" } }, "merchantId": "33", "platformId": "", "customerId": "", "orderId": "", "orderDescription": null, "processorId": "421", "poNumber": "", "refId": "0", "authorizationCode": "VTLMC1", "status": "pendingSettlement", "driversLicense": { "objectType": "driversLicense", "dateOfBirth": "", "number": "", "state": "" }, "tax": { "objectType": "amount", "amount": "0.00", "currency": "USD" }, "tip": { "objectType": "amount", "amount": "", "currency": "USD" }, "merchantDefinedFields": {}, "vat": { "objectType": "vat", "taxRate": { "objectType": "amount", "amount": "0.00", "currency": "USD" }, "invoiceReferenceNumber": "", "customerVatRegistration": "", "merchantVatRegistration": "" }, "summaryCommodityCode": "", "orderDate": null, "installmentBilling": { "objectType": "installmentBilling", "billingNumber": "0", "billingTotal": { "objectType": "amount", "amount": "0.00", "currency": "USD" } }, "alternateTaxId": "", "customerTaxId": "", "website": "", "socialSecurityNumber": "", "serviceId": "vital", "surcharge": { "objectType": "amount", "amount": "", "currency": "USD" }, "partialPayment": { "objectType": "partialPayment", "id": "", "balance": { "objectType": "amount", "amount": "", "currency": "USD" } }, "refundableBalance": { "objectType": "amount", "amount": "5.00", "currency": "USD" }, "actions": [ { "objectType": "action", "amount": { "objectType": "amount", "amount": "5.00", "currency": "USD" }, "actionType": "sale", "date": "2021-08-19T19:55:32+00:00", "success": true, "ipAddress": "10.8.5.19", "source": "virtualTerminal", "apiMethod": "", "username": "testuser", "responseText": "Approved", "batchId": "0", "platformBatchId": "", "responseCode": "100", "platformResponseText": " NO MATCH ", "platformResponseCode": "00", "deviceLicenseNumber": null, "deviceNickname": null } ], "items": [], "emv": { "objectType": "emv", "applicationId": "", "applicationPreferredName": "", "applicationLabels": "", "terminalStatusId": "" }, "paymentInfo": { "objectType": "cardPayment", "cardNumber": "411111******1111", "cardExp": "1025", "cardHash": "f6c609e195d9d4c185dcc8ca662f0180", "avsResponse": "N", "cardholderAuth": "", "cscResponse": "M", "cardStartDate": "", "cardIssueNumber": "", "cardBalance": "", "cardAvailableBalance": "", "entryMode": "", "cardBin": "411111", "cardType": "visa", "cardHolderAuthentication": { "objectType": "cardHolderAuthentication", "xid": "", "eci": "", "cavv": "", "cavvResult": "", "directoryServerId": null, "threeDsVersion": null } }, "storedCredentials": { "objectType": "storedCredentials", "initiatedBy": "", "initialTransactionId": "", "storedIndicator": "", "credentialOnFileSupported": false }, "authorizationState": "", "cardholderVerificationMethod": "" } ] } }, "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": { "GetTransactionDataRequest": { "title": "Get Transaction Data", "allOf": [ { "type": "object", "required": [ "maxResults" ], "properties": { "merchantId": { "type": "string", "description": "The merchant gateway ID to which the transactions belong." }, "merchantIds": { "type": "array", "description": "The merchants gateway IDs to which the transactions belong.", "items": { "type": "string" } }, "maxResults": { "type": "string", "description": "Maximum number of results per page." }, "offset": { "type": "string", "description": "Offset value for pagination, or null if not used." }, "orderId": { "type": "string", "description": "The order ID of the transaction." }, "par": { "type": "string", "description": "The Payment Account Reference ID to search for." }, "hmac": { "type": "string", "description": "The Hash-based Message Authentication Code ID to search for." }, "serviceId": { "type": "string", "description": "The ID of the processor platform you want to search for." }, "platformId": { "type": "string", "description": "The ID of the platform." }, "firstName": { "type": "string", "description": "The first name of the merchant's company contact." }, "lastName": { "type": "string", "description": "The last name of the merchant's company contact." }, "email": { "type": "string", "description": "The email of the merchant's company contact." }, "accountNumber": { "type": "string", "description": "Account Number." }, "transactionType": { "type": "string", "description": "Transaction type." }, "customerId": { "type": "string", "description": "Customer ID." }, "phone": { "type": "string", "description": "The phone number of the merchant's company contact." }, "transactionIds": { "type": "array", "description": "Transactions IDs to search.", "items": { "type": "string" } }, "statuses": { "type": "array", "description": "The list of statuses to query.", "items": { "type": "string" } }, "actionTypes": { "type": "array", "description": "The type of transaction to query.", "items": { "type": "string", "enum": [ "sale", "auth", "void", "refund", "credit", "validate" ] } }, "amount": { "type": "object", "title": "Amount", "properties": { "min": { "type": "number", "description": "Min amount." }, "max": { "type": "number", "description": "Max amount." } }, "description": "Min and max amount for transactions to search." }, "date": { "type": "object", "title": "Date", "properties": { "start": { "type": "string", "description": "Start date." }, "end": { "type": "string", "description": "End date." } }, "description": "Start and End date for query transactions." } } } ] }, "GetTransactionDataResponse": { "type": "object", "title": "Response", "properties": { "objectType": { "type": "string", "enum": [ "serviceConfig" ], "description": "The type of object that was returned as a result of the request." }, "reportId": { "type": "number", "description": "The ID of the report." }, "offset": { "type": "number", "description": "The first N skipped results." }, "maxResults": { "type": "number", "description": "The max number results." }, "totalResults": { "type": "number", "description": "The total number of results." }, "hasMore": { "type": "boolean", "description": "Indicates if there are more results available beyond the current page." }, "links": { "type": "object", "title": "Links", "description": "Pagination links for navigating through the report results.", "properties": { "first": { "type": "string", "format": "uri", "description": "URL to the first page of results." }, "last": { "type": "string", "format": "uri", "description": "URL to the last page of results." }, "next": { "type": "string", "format": "uri", "description": "URL to the next page of results." }, "previous": { "type": "string", "format": "uri", "description": "URL to the previous page of results." } } }, "results": { "type": "array", "description": "Results for the search.", "items": { "type": "object", "properties": { "objectType": { "type": "string", "description": "Type of the returned response object." }, "id": { "type": "string", "description": "The ID for the transaction." }, "created": { "type": "string", "format": "date-time", "description": "The timestamp indicating when the transaction was created." }, "updated": { "type": "string", "format": "date-time", "description": "The timestamp indicating when the transaction was last updated." }, "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." } } }, "shipping": { "type": "object", "title": "Shipping", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing shipping details." }, "carrier": { "type": "string", "description": "The carrier used for shipping." }, "trackingNumber": { "type": "string", "description": "The tracking number provided by the shipping carrier." }, "date": { "type": "string", "format": "date-time", "nullable": true, "description": "The date the item was shipped." }, "fromPostalCode": { "type": "string", "description": "The postal code from where the item was shipped." }, "amount": { "type": "object", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing the shipping amount." }, "amount": { "type": "string", "description": "The monetary amount for shipping." }, "currency": { "type": "string", "description": "The currency of the shipping amount." } }, "description": "The amount details for shipping." } }, "description": "The shipping details associated with the transaction." }, "merchantId": { "type": "string", "description": "The ID for the merchant involved in the transaction." }, "platformId": { "type": "string", "description": "The ID for the platform facilitating the transaction." }, "customerId": { "type": "string", "description": "The ID for the customer involved in the transaction." }, "orderId": { "type": "string", "description": "The order ID associated with the transaction." }, "orderDescription": { "type": "string", "nullable": true, "description": "A description of the order associated with the transaction." }, "processorId": { "type": "string", "description": "The ID for the payment processor handling the transaction." }, "poNumber": { "type": "string", "description": "The purchase order number associated with the transaction." }, "refId": { "type": "string", "description": "A reference identifier for the transaction." }, "authorizationCode": { "type": "string", "description": "The authorization code for the transaction, provided by the payment processor." }, "status": { "type": "string", "description": "The current status of the transaction." }, "driversLicense": { "type": "object", "title": "Drivers License", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing a driver's license." }, "dateOfBirth": { "type": "string", "format": "date", "description": "The birth date of the individual associated with the driver's license." }, "number": { "type": "string", "description": "The unique number of the driver's license." }, "state": { "type": "string", "description": "The state or province that issued the driver's license." } }, "description": "The driver's license details associated with the transaction." }, "tax": { "type": "object", "title": "Tax", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing the tax amount." }, "amount": { "type": "string", "description": "The monetary amount for tax." }, "currency": { "type": "string", "description": "The currency of the tax amount." } }, "description": "The tax details associated with the transaction." }, "tip": { "type": "object", "title": "Tip", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing the tip amount." }, "amount": { "type": "string", "description": "The monetary amount for the tip." }, "currency": { "type": "string", "description": "The currency of the tip amount." } }, "description": "The tip details associated with the transaction." }, "merchantDefinedFields": { "type": "object", "title": "Merchant Defined Fields", "description": "Custom fields defined by the merchant for additional information related to the transaction." }, "vat": { "type": "object", "title": "VAT", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing the VAT details." }, "taxRate": { "type": "object", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing the tax rate." }, "amount": { "type": "string", "description": "The VAT rate applied." }, "currency": { "type": "string", "description": "The currency of the VAT rate." } }, "description": "The VAT rate details." }, "invoiceReferenceNumber": { "type": "string", "description": "The reference number for the invoice related to the VAT." }, "customerVatRegistration": { "type": "string", "description": "The VAT registration number of the customer." }, "merchantVatRegistration": { "type": "string", "description": "The VAT registration number of the merchant." } }, "description": "The VAT details associated with the transaction." }, "summaryCommodityCode": { "type": "string", "description": "The summary commodity code related to the transaction." }, "orderDate": { "type": "string", "format": "date-time", "nullable": true, "description": "The date when the order was placed." }, "installmentBilling": { "type": "object", "title": "Installment Billing", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing installment billing details." }, "billingNumber": { "type": "string", "description": "The current installment number being billed." }, "billingTotal": { "type": "object", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing the total billing amount for the installment." }, "amount": { "type": "string", "description": "The monetary amount for the total installment billing." }, "currency": { "type": "string", "description": "The currency of the installment billing amount." } }, "description": "The total billing amount details for the installment." } }, "description": "The installment billing details associated with the transaction." }, "alternateTaxId": { "type": "string", "description": "An alternate tax identifier for the transaction." }, "customerTaxId": { "type": "string", "description": "The tax identifier for the customer associated with the transaction." }, "website": { "type": "string", "description": "The website associated with the transaction." }, "socialSecurityNumber": { "type": "string", "description": "The social security number of the individual involved in the transaction." }, "serviceId": { "type": "string", "description": "The ID for the service used in the transaction." }, "surcharge": { "type": "object", "title": "Surcharge", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing the surcharge amount." }, "amount": { "type": "string", "description": "The monetary amount for the surcharge." }, "currency": { "type": "string", "description": "The currency of the surcharge amount." } }, "description": "The surcharge details associated with the transaction." }, "partialPayment": { "type": "object", "title": "Partial Payment", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing partial payment details." }, "id": { "type": "string", "description": "The ID for the partial payment." }, "balance": { "type": "object", "title": "Balance", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing the balance amount." }, "amount": { "type": "string", "description": "The remaining balance for the partial payment." }, "currency": { "type": "string", "description": "The currency of the remaining balance amount." } }, "description": "The balance details for the partial payment." } }, "description": "The partial payment details associated with the transaction." }, "refundableBalance": { "type": "object", "title": "Refundable Balance", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing the refundable balance." }, "amount": { "type": "string", "description": "The monetary amount available for refund." }, "currency": { "type": "string", "description": "The currency of the refundable balance." } }, "description": "The refundable balance details for the transaction." }, "actions": { "type": "array", "items": { "type": "object", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing an action." }, "amount": { "type": "object", "title": "Amount", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing the action amount." }, "amount": { "type": "string", "description": "The monetary amount for the action." }, "currency": { "type": "string", "description": "The currency of the action amount." } }, "description": "The amount details for the action." }, "actionType": { "type": "string", "description": "The type of action performed, such as 'sale' or 'refund'." }, "date": { "type": "string", "format": "date-time", "description": "The timestamp when the action was performed." }, "success": { "type": "boolean", "description": "Indicates whether the action was successful." }, "ipAddress": { "type": "string", "description": "The IP address from where the action was initiated." }, "source": { "type": "string", "description": "The source from which the action was performed, such as 'virtualTerminal'." }, "apiMethod": { "type": "string", "description": "The API method used to perform the action." }, "username": { "type": "string", "description": "The username of the individual who performed the action." }, "responseText": { "type": "string", "description": "The response text returned by the system for the action." }, "batchId": { "type": "string", "description": "The identifier for the batch in which the action was included." }, "platformBatchId": { "type": "string", "description": "The platform-specific batch identifier for the action." }, "responseCode": { "type": "string", "description": "The response code returned by the system for the action." }, "platformResponseText": { "type": "string", "description": "The platform-specific response text for the action." }, "platformResponseCode": { "type": "string", "description": "The platform-specific response code for the action." }, "deviceLicenseNumber": { "type": "string", "nullable": true, "description": "The license number of the device used for the action." }, "deviceNickname": { "type": "string", "nullable": true, "description": "The nickname of the device used for the action." } }, "description": "The details of actions performed within the transaction." }, "description": "A list of actions associated with the transaction." }, "items": { "type": "array", "items": { "type": "object", "description": "Details of individual items related to the transaction." }, "description": "A list of items associated with the transaction." }, "emv": { "type": "object", "title": "EMV", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing EMV (Europay, Mastercard, and Visa) details." }, "applicationId": { "type": "string", "description": "The ID for the EMV application." }, "applicationPreferredName": { "type": "string", "description": "The preferred name of the EMV application." }, "applicationLabels": { "type": "string", "description": "Labels associated with the EMV application." }, "terminalStatusId": { "type": "string", "description": "The status identifier of the terminal processing the EMV transaction." } }, "description": "The EMV details associated with the transaction." }, "paymentInfo": { "type": "object", "title": "Payment Info", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing payment card information." }, "cardNumber": { "type": "string", "description": "The masked card number used for the transaction." }, "cardExp": { "type": "string", "description": "The expiration date of the card used for the transaction." }, "cardHash": { "type": "string", "description": "A hash value of the card information used for transaction security." }, "avsResponse": { "type": "string", "description": "The response from the Address Verification System (AVS) for the card." }, "cardholderAuth": { "type": "string", "description": "The authentication response for the cardholder." }, "cscResponse": { "type": "string", "description": "The response from the Card Security Code (CSC) verification." }, "cardStartDate": { "type": "string", "description": "The start date of the card, if applicable." }, "cardIssueNumber": { "type": "string", "description": "The issue number of the card, if applicable." }, "cardBalance": { "type": "string", "description": "The balance available on the card, if applicable." }, "cardAvailableBalance": { "type": "string", "description": "The available balance on the card, if applicable." }, "entryMode": { "type": "string", "description": "The mode used to enter the card information, such as 'swiped' or 'keyed'." }, "cardBin": { "type": "string", "description": "The Bank Identification Number (BIN) of the card used for the transaction." }, "cardType": { "type": "string", "description": "The type of card used, such as 'visa' or 'mastercard'." }, "cardHolderAuthentication": { "type": "object", "title": "Card Holder Authentication", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing cardholder authentication details." }, "xid": { "type": "string", "description": "The transaction identifier for cardholder authentication." }, "eci": { "type": "string", "description": "The electronic commerce indicator for cardholder authentication." }, "cavv": { "type": "string", "description": "The cardholder authentication verification value." }, "cavvResult": { "type": "string", "description": "The result of the cardholder authentication verification." }, "directoryServerId": { "type": "string", "nullable": true, "description": "The identifier for the directory server involved in cardholder authentication." }, "threeDsVersion": { "type": "string", "nullable": true, "description": "The version of the 3D Secure protocol used for authentication." } } } } }, "storedCredentials": { "type": "object", "title": "Stored Credentials", "properties": { "objectType": { "type": "string", "description": "The type of the object, representing stored credentials." }, "initiatedBy": { "type": "string", "description": "The initiator of the transaction, indicating whether it was 'merchant' or 'cardholder' initiated." }, "initialTransactionId": { "type": "string", "description": "The ID of the initial transaction for stored credentials." }, "storedIndicator": { "type": "string", "description": "Indicates whether the credentials are stored, typically 'true' or 'false'." }, "credentialOnFileSupported": { "type": "boolean", "description": "Indicates whether the system supports storing credentials on file." } }, "description": "The stored credentials details associated with the transaction." }, "authorizationState": { "type": "string", "description": "The state of authorization for the transaction." }, "cardholderVerificationMethod": { "type": "string", "description": "The method used for cardholder verification during the transaction." } } } } } }, "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": { "ContentType": { "name": "Content-Type", "in": "header", "required": true, "schema": { "type": "string" }, "description": "The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).", "example": "application/json" }, "Authorization": { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Your v4 API key that was generated in the Partner portal." }, "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.