Classic: Transaction processing
POST /transact.php · Transaction processing
Classic protocol
This family uses POST /transact.php under the documented sandbox base https://sandbox.nmi.com/api. Send application/x-www-form-urlencoded fields with the private security_key on your server. Do not substitute a REST JSON body or REST Authorization header. Each named variant below has its own action selector and required fields. For maintenance of a Classic integration. Source examples are fixtures, not live credentials; replace their security_key before any authorized test. This reference sends no requests.
Choose the operation variant
Variant Selector fields Required fields CreditCardSaleRequest CreditCardAuthorizeRequest CreditCardCaptureRequest CreditCardValidateRequest CreditCardCreditRequest CreditCardOfflineRequest CreditCardPaymentInFullPartialRequest VoidRequest RefundRequest ACHSaleRequest ACHCreditRequest CashSaleRequest TransactionUpdateRequest ACHTransactionUpdateRequest
Request language templates
Original transport templates derived from this endpoint’s documented method, server, authentication and media type. Replace path/query/credential placeholders with authorized sandbox values. These examples print the raw status and response; they do not infer business success or retry a request. Save properly URL-encoded name=value pairs for your selected operation as request.form, including its private security_key when required. JSON example objects below describe these form fields; they are not the wire encoding. Node requires a runtime with fetch; PHP requires cURL. Generated source-based examples have not been executed against provider accounts. curl --request POST \ --url 'https://sandbox.nmi.com/api/transact.php' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-binary '@request.form' import { readFile } from 'node:fs/promises'; const body = await readFile('request.form', 'utf8'); const response = await fetch("https://sandbox.nmi.com/api/transact.php", { method: 'POST', headers: { "Content-Type": "application/x-www-form-urlencoded" }, body }); console.log(response.status, await response.text()); from urllib.request import Request, urlopen from urllib.error import HTTPError from pathlib import Path request = Request('https://sandbox.nmi.com/api/transact.php', method='POST', headers={'Content-Type': 'application/x-www-form-urlencoded'}, data=Path('request.form').read_bytes()) try: with urlopen(request, timeout=30) as response: print(response.status, response.read().decode()) except HTTPError as error: print(error.code, error.read().decode()) require 'net/http' require 'uri' uri = URI("https://sandbox.nmi.com/api/transact.php") request = Net::HTTP::Post.new(uri) request["Content-Type"] = "application/x-www-form-urlencoded" request.body = File.binread('request.form') response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https', read_timeout: 30) { |http| http.request(request) } puts response.code puts response.body <?php $curl = curl_init('https://sandbox.nmi.com/api/transact.php'); curl_setopt_array($curl, [ CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 30, CURLOPT_HTTPHEADER => ['Content-Type: application/x-www-form-urlencoded'], CURLOPT_POSTFIELDS => file_get_contents('request.form') ]); $response = curl_exec($curl); if ($response === false) { throw new RuntimeException(curl_error($curl)); } echo curl_getinfo($curl, CURLINFO_HTTP_CODE), PHP_EOL, $response; curl_close($curl);
Request fields
Choose one schema variant. Descriptions retain conditional requirements that are not always included in required arrays. Do not merge all variants into one request. Field Type Required Description Constraints [oneOf 1].[allOf 1].security_key string yes API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys [oneOf 1].[allOf 1].type string yes The type of transaction to be processed. Must be `sale` [oneOf 1].[allOf 1].partial_payments string no `settle_partial`: Settles any amount of tender collected (captured partial auth's and approved partial sales) at cut off. `payment_in_full`: Required that any split tendered transaction is collected in-full before settlement gets initiated. enum: ["settle_partial", "payment_in_full"] [oneOf 1].[allOf 3].partial_payment_id string no Unique identifier returned when making the original transaction. This should only be used for secondary transactions. [oneOf 1].[allOf 4].[allOf 1].ccnumber string no Credit card number. <details> <summary>Allowed Card Numbers:</summary> | Card Type | Test Card Number | |:------------------|:---------------------| | Visa | 4111111111111111 | | MasterCard | 5431111111111111 | | Discover | 6011000991300009 | | American Express | 341111111111111 | | Diner's Club | 30205252489926 | | JCB | 3541963594572595 | | Maestro | 6799990100000000019 | </details> enum: ["4111111111111111", "5431111111111111", "6011000991300009", "341111111111111", "30205252489926", "3541963594572595", "6799990100000000019"] [oneOf 1].[allOf 4].[allOf 1].ccexp string no Credit card expiration date. Format: `MMYY` [oneOf 1].[allOf 4].[allOf 2].cvv string no The card security code. While this is not required, it is strongly recommended. [oneOf 1].[allOf 5].amount string no Total amount to be charged. Format: `x.xx` [oneOf 1].[allOf 6].[allOf 1].payment_token string no The tokenized version of the customer's card or check information, generated by the [Payment Component](../docs/payment-component) (npm packages / [Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology)) and usable only once. Existing integrations may also supply a token from [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology). [oneOf 1].[allOf 6].[allOf 1].transaction_session_id string no A single use session ID used by Kount to link the transaction and Data Collector information together. * Should be generated every time a payment form is loaded by the cardholder. * Should be random/unpredictable (do not use sequential IDs). * Should not be reused within a 30 day period. This can be used with [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology) or the Payment API when using the [Kount DDC with Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology). Format: `alphanumeric` minLength: 32; maxLength: 32 [oneOf 1].[allOf 6].[allOf 1].applepay_payment_data string no The encrypted token created when integration directly to the Apple Pay SDK. [oneOf 1].[allOf 6].[allOf 1].googlepay_payment_data string no The encrypted token created when [integration directly to the Google Pay SDK](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#googlepay_variables). [oneOf 1].[allOf 6].[allOf 1].surcharge string no Surcharge amount. Format: `x.xx` [oneOf 1].[allOf 6].[allOf 1].convenience_fee string no Convenience fee amount. Format: `x.xx` [oneOf 1].[allOf 6].[allOf 1].misc_fee string no Miscellaneous fee amount. Format: `x.xx` [oneOf 1].[allOf 6].[allOf 1].misc_fee_name string no Custom miscellaneous fee name. Default: `Miscellaneous Fee` [oneOf 1].[allOf 6].[allOf 1].tip number no The final tip amount, included in the transaction, associated with the purchase. Format: `x.xx` [oneOf 1].[allOf 6].[allOf 1].currency string no The transaction currency. Format: `ISO 4217` [oneOf 1].[allOf 6].[allOf 1].processor_id string no If using Multiple MIDs, route to this processor (*processor_id* is obtained under Settings → Transaction Routing in the Control Panel). [oneOf 1].[allOf 6].[allOf 1].dup_seconds integer no Sets the time in seconds for duplicate transaction checking on supported processors. Set to *0* to disable duplicate checking. maximum: 7862400 [oneOf 1].[allOf 6].[allOf 2].descriptor string no Set payment descriptor on supported processors. [oneOf 1].[allOf 6].[allOf 2].descriptor_phone string no Set payment descriptor phone on supported processors. [oneOf 1].[allOf 6].[allOf 2].descriptor_address string no Set payment descriptor address on supported processors. [oneOf 1].[allOf 6].[allOf 2].descriptor_city string no Set payment descriptor city on supported processors. [oneOf 1].[allOf 6].[allOf 2].descriptor_state string no Set payment descriptor state on supported processors. [oneOf 1].[allOf 6].[allOf 2].descriptor_postal string no Set payment descriptor postal code on supported processors. [oneOf 1].[allOf 6].[allOf 2].descriptor_country string no Set payment descriptor country on supported processors. [oneOf 1].[allOf 6].[allOf 2].descriptor_mcc string no Set payment descriptor mcc on supported processors. [oneOf 1].[allOf 6].[allOf 2].descriptor_merchant_id string no Set payment descriptor merchant id on supported processors. [oneOf 1].[allOf 6].[allOf 2].descriptor_url string no Set payment descriptor url on supported processors. [oneOf 1].[allOf 6].[allOf 3].billing_method string no Recurring or installment classification for the processor. - `initial_recurring`: First transaction in a recurring sequence only. - `recurring`: Later charges in that sequence. - `installment`: Installment transactions; use `billing_number` and `billing_total` on supported processors. Which values apply depends on the processor. enum: ["initial_recurring", "recurring", "installment"] [oneOf 1].[allOf 6].[allOf 3].billing_number integer no Specify installment billing number, on supported processors. For use when `billing_method` is set to "installment". minimum: 0; maximum: 99 [oneOf 1].[allOf 6].[allOf 3].billing_total string no Specify installment billing total on supported processors. For use when `billing_method` is set to "installment". [oneOf 1].[allOf 6].[allOf 3].order_template string no Order template ID. [oneOf 1].[allOf 6].[allOf 3].order_description string no Order description. [oneOf 1].[allOf 6].[allOf 3].orderid string no Order Id. [oneOf 1].[allOf 6].[allOf 3].ipaddress string no IP address of cardholder, this field is recommended. Format: `xxx.xxx.xxx.xxx` [oneOf 1].[allOf 6].[allOf 4].first_name string no Cardholder's first name. [oneOf 1].[allOf 6].[allOf 4].last_name string no Cardholder's last name [oneOf 1].[allOf 6].[allOf 4].company string no Cardholder's company [oneOf 1].[allOf 6].[allOf 4].address1 string no Card billing address [oneOf 1].[allOf 6].[allOf 4].address2 string no Card billing address, line 2 [oneOf 1].[allOf 6].[allOf 4].city string no Card billing city [oneOf 1].[allOf 6].[allOf 4].state string no Card billing state. Format: `CC` [oneOf 1].[allOf 6].[allOf 4].zip string no Card billing zip code [oneOf 1].[allOf 6].[allOf 4].country string no Card billing country. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 1].[allOf 6].[allOf 4].phone string no Billing phone number [oneOf 1].[allOf 6].[allOf 4].fax string no Billing fax number [oneOf 1].[allOf 6].[allOf 4].email string no Billing email address format: "email" [oneOf 1].[allOf 6].[allOf 5].drivers_license_number string no Driver's license number. [oneOf 1].[allOf 6].[allOf 5].drivers_license_dob string no Driver's license date of birth. [oneOf 1].[allOf 6].[allOf 5].drivers_license_state string no The state that issued the customer's driver's license. [oneOf 1].[allOf 6].[allOf 6].shipping_firstname string no Shipping first name [oneOf 1].[allOf 6].[allOf 6].shipping_lastname string no Shipping last name [oneOf 1].[allOf 6].[allOf 6].shipping_company string no Shipping company [oneOf 1].[allOf 6].[allOf 6].shipping_address1 string no Shipping address [oneOf 1].[allOf 6].[allOf 6].shipping_address2 string no Shipping address, line 2 [oneOf 1].[allOf 6].[allOf 6].shipping_city string no Shipping city [oneOf 1].[allOf 6].[allOf 6].shipping_state string no Shipping state. Format: `CC` [oneOf 1].[allOf 6].[allOf 6].shipping_zip string no Shipping zip code [oneOf 1].[allOf 6].[allOf 6].shipping_country string no Shipping country. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 1].[allOf 6].[allOf 6].shipping_email string no Shipping email address format: "email" [oneOf 1].[allOf 6].[allOf 7].merchant_defined_field_1 string no Merchant defined field. You can pass custom information in up to 20 fields. Format: `merchant_defined_field_1=Value1`, `merchant_defined_field_2=Value2`, etc... [oneOf 1].[allOf 6].[allOf 8].customer_receipt string no If set to true, when the customer is charged, they will be sent a transaction receipt. enum: ["true", "false"] [oneOf 1].[allOf 6].[allOf 8].cardholder_auth string no Set 3D Secure condition. Value used to determine E-commerce indicator (ECI). **Required for 3D Secure transactions** enum: ["verified", "attempted"] [oneOf 1].[allOf 6].[allOf 8].cavv string no Cardholder authentication verification value. Format: `base64 encoded` **Required for 3D Secure transactions** [oneOf 1].[allOf 6].[allOf 8].xid string no Cardholder authentication transaction id. Format: `base64 encoded` **Required for 3D Secure transactions** [oneOf 1].[allOf 6].[allOf 8].three_ds_version string no 3DSecure version. **Required for 3D Secure transactions** enum: ["2.0.0", "2.2.0"] [oneOf 1].[allOf 6].[allOf 8].directory_server_id string no Directory Server Transaction ID. May be provided as part of 3DSecure 2.0 authentication. Format: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` [oneOf 1].[allOf 6].[allOf 8].source_transaction_id string no Specifies a payment gateway transaction id in order to associate payment information with a Subscription or Customer Vault record. Must be set with a 'recurring' or 'customer_vault' action. [oneOf 1].[allOf 6].[allOf 8].pinless_debit_override string no Set to 'Y' if you have Pinless Debit Conversion enabled but want to opt out for this transaction. Feature applies to selected processors only. [oneOf 1].[allOf 6].[allOf 9].recurring string no **Recurring Field:** Recurring action to be processed. enum: ["add_subscription"] [oneOf 1].[allOf 6].[allOf 9].plan_id string no **Recurring Field:** Create a subscription tied to a Plan ID if the sale/auth transaction is successful. Required when **recurring** variable is set to `add_subscription` [oneOf 1].[allOf 6].[allOf 9].plan_payments integer no **Recurring Field:** The number of payments before the recurring plan is complete. Note: Use '0' for until canceled Required when **recurring** variable is set to `add_subscription` [oneOf 1].[allOf 6].[allOf 9].plan_amount number no **Recurring Field:** The plan amount to be charged each billing cycle. Format: `x.xx` Required when **recurring** variable is set to `add_subscription` [oneOf 1].[allOf 6].[allOf 9].month_frequency integer no **Recurring Field:** How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'. Required when **recurring** variable is set to `add_subscription` minimum: 1; maximum: 24 [oneOf 1].[allOf 6].[allOf 9].day_of_month integer no **Recurring Field:** The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'. For months without 29, 30, or 31 days, the charge will be on the last day Required when **recurring** variable is set to `add_subscription` minimum: 1; maximum: 31 [oneOf 1].[allOf 6].[allOf 9].day_frequency integer no **Recurring Field:** How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'. Required when **recurring** variable is set to `add_subscription` [oneOf 1].[allOf 6].[allOf 9].start_date string no **Recurring Field:** The first day that the customer will be charged. Format: `YYYYMMDD` Required when **recurring** variable is set to `add_subscription` format: "date" [oneOf 1].[allOf 6].[allOf 10].customer_vault string no Associate payment information with a Customer Vault record if the transaction is successful. enum: ["add_customer", "update_customer"] [oneOf 1].[allOf 6].[allOf 10].customer_vault_id string no Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id. [oneOf 1].[allOf 6].[allOf 11].initiated_by string no **Stored Credentials (CIT/MIT):** Who initiated the transaction. enum: ["customer", "merchant"] [oneOf 1].[allOf 6].[allOf 11].initial_transaction_id string no **Stored Credentials (CIT/MIT):** Original payment gateway transaction id. [oneOf 1].[allOf 6].[allOf 11].stored_credential_indicator string no **Stored Credentials (CIT/MIT):** The indicator of the stored credential. Use **'stored'** when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system. Use **'used'** when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method. enum: ["stored", "used"] [oneOf 1].[allOf 6].[allOf 12].shipping number no **Level II/III - Order Field:** Freight or shipping amount included in the transaction amount. Default - `0.00`. Format: `x.xx` [oneOf 1].[allOf 6].[allOf 12].tax number no **Level II/III - Order Field:** The sales tax, included in the transaction amount, associated with the purchase. Setting tax equal to '-1' indicates an order that is exempt from sales tax. Default - `0.00`. Format: `x.xx` [oneOf 1].[allOf 6].[allOf 12].ponumber string no **Level II/III - Order Field:** Purchase order number [oneOf 1].[allOf 6].[allOf 12].orderid string no **Level III - Order Field:** Identifier assigned by the merchant. This defaults to gateway transaction id. [oneOf 1].[allOf 6].[allOf 12].shipping_country string no **Level III - Order Field:** Shipping country (e.g. US). Format: `CC` - ISO 3166-1 alpha-2 [oneOf 1].[allOf 6].[allOf 12].shipping_postal string no **Level III - Order Field:** Postal/ZIP code of the address where purchased goods will be delivered. This field can be identical to the 'ship_from_postal' if the customer is present and takes immediate possession of the goods. [oneOf 1].[allOf 6].[allOf 12].ship_from_postal string no **Level III - Order Field:** Postal/ZIP code of the address from where purchased goods are being shipped, defaults to merchant profile postal code. [oneOf 1].[allOf 6].[allOf 12].summary_commodity_code string no **Level III - Order Field:** 4 character international description code of the overall goods or services being supplied. The acquirer or processor will provide a list of current codes. [oneOf 1].[allOf 6].[allOf 12].duty_amount number no **Level III - Order Field:** Amount included in the transaction amount associated with the import of purchased goods. Default - `0.00`. Format: `x.xx` [oneOf 1].[allOf 6].[allOf 12].discount_amount number no **Level III - Order Field:** Amount included in the transaction amount of any discount applied to complete order by the merchant. Default - `0.00`. Format: `x.xx` [oneOf 1].[allOf 6].[allOf 12].national_tax_amount number no **Level III - Order Field:** The national tax amount included in the transaction amount. Default - `0.00`. Format: `x.xx` [oneOf 1].[allOf 6].[allOf 12].alternate_tax_amount number no **Level III - Order Field:** Second tax amount included in the transaction amount in countries where more than one type of tax can be applied to the purchases. Default - `0.00`. Format: `x.xx` [oneOf 1].[allOf 6].[allOf 12].alternate_tax_id string no **Level III - Order Field:** Tax identification number of the merchant that reported the alternate tax amount. [oneOf 1].[allOf 6].[allOf 12].vat_tax_amount number no **Level III - Order Field:** Contains the amount of any value added taxes which can be associated with the purchased item. Default - `0.00`. Format: `x.xx` [oneOf 1].[allOf 6].[allOf 12].vat_tax_rate number no **Level III - Order Field:** Contains the tax rate used to calculate the sales tax amount appearing. Can contain up to 2 decimal places, e.g. 1% = 1.00. Default - `0.00`. Format: `x.xx` [oneOf 1].[allOf 6].[allOf 12].vat_invoice_reference_number string no **Level III - Order Field:** Invoice number that is associated with the VAT invoice. [oneOf 1].[allOf 6].[allOf 12].customer_vat_registration string no **Level III - Order Field:** Value added tax registration number supplied by the cardholder. [oneOf 1].[allOf 6].[allOf 12].merchant_vat_registration string no **Level III - Order Field:** Government assigned tax identification number of the merchant for whom the goods or services were purchased from. [oneOf 1].[allOf 6].[allOf 12].order_date string no **Level III - Order Field:** Purchase order date, defaults to the date of the transaction. Format: `YYMMDD` format: "date" [oneOf 1].[allOf 6].[allOf 13].item_product_code_1 string no **Level III - Line Item:** Merchant defined description code of the item being purchased. *Up to 99 sets of item_* fields are allowed.* [oneOf 1].[allOf 6].[allOf 13].item_description_1 string no **Level III - Line Item:** Description of the item(s) being supplied. [oneOf 1].[allOf 6].[allOf 13].item_commodity_code_1 string no **Level III - Line Item:** International description code of the individual good or service being supplied. The acquirer or processor will provide a list of current codes. [oneOf 1].[allOf 6].[allOf 13].item_unit_of_measure_1 string no **Level III - Line Item:** Code for units of measurement as used in international trade. Default - `EACH`. [oneOf 1].[allOf 6].[allOf 13].item_unit_cost_1 number no **Level III - Line Item:** Unit cost of item purchased, may contain up to 4 decimal places. [oneOf 1].[allOf 6].[allOf 13].item_quantity_1 integer no **Level III - Line Item:** Quantity of the item(s) being purchased. Default - `1`. [oneOf 1].[allOf 6].[allOf 13].item_total_amount_1 number no **Level III - Line Item:** Purchase amount associated with the item. Defaults to: 'item_unit_cost_#' x 'item_quantity_#' rounded to the nearest penny. [oneOf 1].[allOf 6].[allOf 13].item_tax_amount_1 number no **Level III - Line Item:** Amount of sales tax on specific item. Amount should not be included in 'total_amount_#'. Default - `0.00`. Format: `x.xx` [oneOf 1].[allOf 6].[allOf 13].item_tax_rate_1 number no **Level III - Line Item:** Percentage representing the value-added tax applied. Default - `0.00`. Format: `x.xx` [oneOf 1].[allOf 6].[allOf 13].item_discount_amount_1 number no **Level III - Line Item:** Discount amount which can have been applied by the merchant on the sale of the specific item. Amount should not be included in 'total_amount_#'. [oneOf 1].[allOf 6].[allOf 13].item_discount_rate_1 number no **Level III - Line Item:** Discount rate for the line item. Default - `0.00`. Format: `x.xx` [oneOf 1].[allOf 6].[allOf 13].item_tax_type_1 string no **Level III - Line Item:** Type of value-added taxes that are being used. [oneOf 1].[allOf 6].[allOf 13].item_alternate_tax_id_1 string no **Level III - Line Item:** Tax identification number of the merchant that reported the alternate tax amount. [oneOf 1].[allOf 6].[allOf 14].payment_facilitator_id string no **Payment Facilitator:** Payment Facilitator/Aggregator/ISO's ID Number [oneOf 1].[allOf 6].[allOf 14].submerchant_id string no **Payment Facilitator:** Sub-merchant Account ID [oneOf 1].[allOf 6].[allOf 14].submerchant_name string no **Payment Facilitator:** Sub-merchant's Name [oneOf 1].[allOf 6].[allOf 14].submerchant_address string no **Payment Facilitator:** Sub-merchant's Address [oneOf 1].[allOf 6].[allOf 14].submerchant_city string no **Payment Facilitator:** Sub-merchant's City [oneOf 1].[allOf 6].[allOf 14].submerchant_state string no **Payment Facilitator:** Sub-merchant's State [oneOf 1].[allOf 6].[allOf 14].submerchant_postal string no **Payment Facilitator:** Sub-merchant's Zip/Postal Code [oneOf 1].[allOf 6].[allOf 14].submerchant_country string no **Payment Facilitator:** Sub-merchant's Country [oneOf 1].[allOf 6].[allOf 14].submerchant_phone string no **Payment Facilitator:** Sub-merchant's Phone Number [oneOf 1].[allOf 6].[allOf 14].submerchant_email string no **Payment Facilitator:** Sub-merchant's Email Address format: "email" [oneOf 1].[allOf 7].industry string no The industry parameter is supported across multiple transaction types. Its purpose is to identify the merchant industry type for processing enum: ["ecommerce", "moto", "retail", "restaurant", "lodging"] [oneOf 1].[allOf 8].signature_image string no Cardholder signature image. Format: `base64 encoded raw PNG image. (16kiB maximum)` [oneOf 1].[allOf 9].network_tokenize string no Overrides the Customer Token Vault settings and tokenizes the transaction if eligible. Default - `0`. enum: ["0", "1"] [oneOf 2].[allOf 1].security_key string yes API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys [oneOf 2].[allOf 1].type string yes The type of transaction to be processed. enum: ["auth"] [oneOf 2].[allOf 3].[allOf 1].ccnumber string no Credit card number. <details> <summary>Allowed Card Numbers:</summary> | Card Type | Test Card Number | |:------------------|:---------------------| | Visa | 4111111111111111 | | MasterCard | 5431111111111111 | | Discover | 6011000991300009 | | American Express | 341111111111111 | | Diner's Club | 30205252489926 | | JCB | 3541963594572595 | | Maestro | 6799990100000000019 | </details> enum: ["4111111111111111", "5431111111111111", "6011000991300009", "341111111111111", "30205252489926", "3541963594572595", "6799990100000000019"] [oneOf 2].[allOf 3].[allOf 1].ccexp string no Credit card expiration date. Format: `MMYY` [oneOf 2].[allOf 3].[allOf 2].cvv string no The card security code. While this is not required, it is strongly recommended. [oneOf 2].[allOf 4].amount string no Total amount to be charged. Format: `x.xx` [oneOf 2].[allOf 5].[allOf 1].payment_token string no The tokenized version of the customer's card or check information, generated by the [Payment Component](../docs/payment-component) (npm packages / [Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology)) and usable only once. Existing integrations may also supply a token from [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology). [oneOf 2].[allOf 5].[allOf 1].transaction_session_id string no A single use session ID used by Kount to link the transaction and Data Collector information together. * Should be generated every time a payment form is loaded by the cardholder. * Should be random/unpredictable (do not use sequential IDs). * Should not be reused within a 30 day period. This can be used with [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology) or the Payment API when using the [Kount DDC with Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology). Format: `alphanumeric` minLength: 32; maxLength: 32 [oneOf 2].[allOf 5].[allOf 1].applepay_payment_data string no The encrypted token created when integration directly to the Apple Pay SDK. [oneOf 2].[allOf 5].[allOf 1].googlepay_payment_data string no The encrypted token created when [integration directly to the Google Pay SDK](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#googlepay_variables). [oneOf 2].[allOf 5].[allOf 1].surcharge string no Surcharge amount. Format: `x.xx` [oneOf 2].[allOf 5].[allOf 1].convenience_fee string no Convenience fee amount. Format: `x.xx` [oneOf 2].[allOf 5].[allOf 1].misc_fee string no Miscellaneous fee amount. Format: `x.xx` [oneOf 2].[allOf 5].[allOf 1].misc_fee_name string no Custom miscellaneous fee name. Default: `Miscellaneous Fee` [oneOf 2].[allOf 5].[allOf 1].tip number no The final tip amount, included in the transaction, associated with the purchase. Format: `x.xx` [oneOf 2].[allOf 5].[allOf 1].currency string no The transaction currency. Format: `ISO 4217` [oneOf 2].[allOf 5].[allOf 1].processor_id string no If using Multiple MIDs, route to this processor (*processor_id* is obtained under Settings → Transaction Routing in the Control Panel). [oneOf 2].[allOf 5].[allOf 1].dup_seconds integer no Sets the time in seconds for duplicate transaction checking on supported processors. Set to *0* to disable duplicate checking. maximum: 7862400 [oneOf 2].[allOf 5].[allOf 2].descriptor string no Set payment descriptor on supported processors. [oneOf 2].[allOf 5].[allOf 2].descriptor_phone string no Set payment descriptor phone on supported processors. [oneOf 2].[allOf 5].[allOf 2].descriptor_address string no Set payment descriptor address on supported processors. [oneOf 2].[allOf 5].[allOf 2].descriptor_city string no Set payment descriptor city on supported processors. [oneOf 2].[allOf 5].[allOf 2].descriptor_state string no Set payment descriptor state on supported processors. [oneOf 2].[allOf 5].[allOf 2].descriptor_postal string no Set payment descriptor postal code on supported processors. [oneOf 2].[allOf 5].[allOf 2].descriptor_country string no Set payment descriptor country on supported processors. [oneOf 2].[allOf 5].[allOf 2].descriptor_mcc string no Set payment descriptor mcc on supported processors. [oneOf 2].[allOf 5].[allOf 2].descriptor_merchant_id string no Set payment descriptor merchant id on supported processors. [oneOf 2].[allOf 5].[allOf 2].descriptor_url string no Set payment descriptor url on supported processors. [oneOf 2].[allOf 5].[allOf 3].billing_method string no Recurring or installment classification for the processor. - `initial_recurring`: First transaction in a recurring sequence only. - `recurring`: Later charges in that sequence. - `installment`: Installment transactions; use `billing_number` and `billing_total` on supported processors. Which values apply depends on the processor. enum: ["initial_recurring", "recurring", "installment"] [oneOf 2].[allOf 5].[allOf 3].billing_number integer no Specify installment billing number, on supported processors. For use when `billing_method` is set to "installment". minimum: 0; maximum: 99 [oneOf 2].[allOf 5].[allOf 3].billing_total string no Specify installment billing total on supported processors. For use when `billing_method` is set to "installment". [oneOf 2].[allOf 5].[allOf 3].order_template string no Order template ID. [oneOf 2].[allOf 5].[allOf 3].order_description string no Order description. [oneOf 2].[allOf 5].[allOf 3].orderid string no Order Id. [oneOf 2].[allOf 5].[allOf 3].ipaddress string no IP address of cardholder, this field is recommended. Format: `xxx.xxx.xxx.xxx` [oneOf 2].[allOf 5].[allOf 4].first_name string no Cardholder's first name. [oneOf 2].[allOf 5].[allOf 4].last_name string no Cardholder's last name [oneOf 2].[allOf 5].[allOf 4].company string no Cardholder's company [oneOf 2].[allOf 5].[allOf 4].address1 string no Card billing address [oneOf 2].[allOf 5].[allOf 4].address2 string no Card billing address, line 2 [oneOf 2].[allOf 5].[allOf 4].city string no Card billing city [oneOf 2].[allOf 5].[allOf 4].state string no Card billing state. Format: `CC` [oneOf 2].[allOf 5].[allOf 4].zip string no Card billing zip code [oneOf 2].[allOf 5].[allOf 4].country string no Card billing country. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 2].[allOf 5].[allOf 4].phone string no Billing phone number [oneOf 2].[allOf 5].[allOf 4].fax string no Billing fax number [oneOf 2].[allOf 5].[allOf 4].email string no Billing email address format: "email" [oneOf 2].[allOf 5].[allOf 5].drivers_license_number string no Driver's license number. [oneOf 2].[allOf 5].[allOf 5].drivers_license_dob string no Driver's license date of birth. [oneOf 2].[allOf 5].[allOf 5].drivers_license_state string no The state that issued the customer's driver's license. [oneOf 2].[allOf 5].[allOf 6].shipping_firstname string no Shipping first name [oneOf 2].[allOf 5].[allOf 6].shipping_lastname string no Shipping last name [oneOf 2].[allOf 5].[allOf 6].shipping_company string no Shipping company [oneOf 2].[allOf 5].[allOf 6].shipping_address1 string no Shipping address [oneOf 2].[allOf 5].[allOf 6].shipping_address2 string no Shipping address, line 2 [oneOf 2].[allOf 5].[allOf 6].shipping_city string no Shipping city [oneOf 2].[allOf 5].[allOf 6].shipping_state string no Shipping state. Format: `CC` [oneOf 2].[allOf 5].[allOf 6].shipping_zip string no Shipping zip code [oneOf 2].[allOf 5].[allOf 6].shipping_country string no Shipping country. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 2].[allOf 5].[allOf 6].shipping_email string no Shipping email address format: "email" [oneOf 2].[allOf 5].[allOf 7].merchant_defined_field_1 string no Merchant defined field. You can pass custom information in up to 20 fields. Format: `merchant_defined_field_1=Value1`, `merchant_defined_field_2=Value2`, etc... [oneOf 2].[allOf 5].[allOf 8].customer_receipt string no If set to true, when the customer is charged, they will be sent a transaction receipt. enum: ["true", "false"] [oneOf 2].[allOf 5].[allOf 8].cardholder_auth string no Set 3D Secure condition. Value used to determine E-commerce indicator (ECI). **Required for 3D Secure transactions** enum: ["verified", "attempted"] [oneOf 2].[allOf 5].[allOf 8].cavv string no Cardholder authentication verification value. Format: `base64 encoded` **Required for 3D Secure transactions** [oneOf 2].[allOf 5].[allOf 8].xid string no Cardholder authentication transaction id. Format: `base64 encoded` **Required for 3D Secure transactions** [oneOf 2].[allOf 5].[allOf 8].three_ds_version string no 3DSecure version. **Required for 3D Secure transactions** enum: ["2.0.0", "2.2.0"] [oneOf 2].[allOf 5].[allOf 8].directory_server_id string no Directory Server Transaction ID. May be provided as part of 3DSecure 2.0 authentication. Format: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` [oneOf 2].[allOf 5].[allOf 8].source_transaction_id string no Specifies a payment gateway transaction id in order to associate payment information with a Subscription or Customer Vault record. Must be set with a 'recurring' or 'customer_vault' action. [oneOf 2].[allOf 5].[allOf 8].pinless_debit_override string no Set to 'Y' if you have Pinless Debit Conversion enabled but want to opt out for this transaction. Feature applies to selected processors only. [oneOf 2].[allOf 5].[allOf 9].recurring string no **Recurring Field:** Recurring action to be processed. enum: ["add_subscription"] [oneOf 2].[allOf 5].[allOf 9].plan_id string no **Recurring Field:** Create a subscription tied to a Plan ID if the sale/auth transaction is successful. Required when **recurring** variable is set to `add_subscription` [oneOf 2].[allOf 5].[allOf 9].plan_payments integer no **Recurring Field:** The number of payments before the recurring plan is complete. Note: Use '0' for until canceled Required when **recurring** variable is set to `add_subscription` [oneOf 2].[allOf 5].[allOf 9].plan_amount number no **Recurring Field:** The plan amount to be charged each billing cycle. Format: `x.xx` Required when **recurring** variable is set to `add_subscription` [oneOf 2].[allOf 5].[allOf 9].month_frequency integer no **Recurring Field:** How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'. Required when **recurring** variable is set to `add_subscription` minimum: 1; maximum: 24 [oneOf 2].[allOf 5].[allOf 9].day_of_month integer no **Recurring Field:** The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'. For months without 29, 30, or 31 days, the charge will be on the last day Required when **recurring** variable is set to `add_subscription` minimum: 1; maximum: 31 [oneOf 2].[allOf 5].[allOf 9].day_frequency integer no **Recurring Field:** How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'. Required when **recurring** variable is set to `add_subscription` [oneOf 2].[allOf 5].[allOf 9].start_date string no **Recurring Field:** The first day that the customer will be charged. Format: `YYYYMMDD` Required when **recurring** variable is set to `add_subscription` format: "date" [oneOf 2].[allOf 5].[allOf 10].customer_vault string no Associate payment information with a Customer Vault record if the transaction is successful. enum: ["add_customer", "update_customer"] [oneOf 2].[allOf 5].[allOf 10].customer_vault_id string no Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id. [oneOf 2].[allOf 5].[allOf 11].initiated_by string no **Stored Credentials (CIT/MIT):** Who initiated the transaction. enum: ["customer", "merchant"] [oneOf 2].[allOf 5].[allOf 11].initial_transaction_id string no **Stored Credentials (CIT/MIT):** Original payment gateway transaction id. [oneOf 2].[allOf 5].[allOf 11].stored_credential_indicator string no **Stored Credentials (CIT/MIT):** The indicator of the stored credential. Use **'stored'** when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system. Use **'used'** when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method. enum: ["stored", "used"] [oneOf 2].[allOf 5].[allOf 12].shipping number no **Level II/III - Order Field:** Freight or shipping amount included in the transaction amount. Default - `0.00`. Format: `x.xx` [oneOf 2].[allOf 5].[allOf 12].tax number no **Level II/III - Order Field:** The sales tax, included in the transaction amount, associated with the purchase. Setting tax equal to '-1' indicates an order that is exempt from sales tax. Default - `0.00`. Format: `x.xx` [oneOf 2].[allOf 5].[allOf 12].ponumber string no **Level II/III - Order Field:** Purchase order number [oneOf 2].[allOf 5].[allOf 12].orderid string no **Level III - Order Field:** Identifier assigned by the merchant. This defaults to gateway transaction id. [oneOf 2].[allOf 5].[allOf 12].shipping_country string no **Level III - Order Field:** Shipping country (e.g. US). Format: `CC` - ISO 3166-1 alpha-2 [oneOf 2].[allOf 5].[allOf 12].shipping_postal string no **Level III - Order Field:** Postal/ZIP code of the address where purchased goods will be delivered. This field can be identical to the 'ship_from_postal' if the customer is present and takes immediate possession of the goods. [oneOf 2].[allOf 5].[allOf 12].ship_from_postal string no **Level III - Order Field:** Postal/ZIP code of the address from where purchased goods are being shipped, defaults to merchant profile postal code. [oneOf 2].[allOf 5].[allOf 12].summary_commodity_code string no **Level III - Order Field:** 4 character international description code of the overall goods or services being supplied. The acquirer or processor will provide a list of current codes. [oneOf 2].[allOf 5].[allOf 12].duty_amount number no **Level III - Order Field:** Amount included in the transaction amount associated with the import of purchased goods. Default - `0.00`. Format: `x.xx` [oneOf 2].[allOf 5].[allOf 12].discount_amount number no **Level III - Order Field:** Amount included in the transaction amount of any discount applied to complete order by the merchant. Default - `0.00`. Format: `x.xx` [oneOf 2].[allOf 5].[allOf 12].national_tax_amount number no **Level III - Order Field:** The national tax amount included in the transaction amount. Default - `0.00`. Format: `x.xx` [oneOf 2].[allOf 5].[allOf 12].alternate_tax_amount number no **Level III - Order Field:** Second tax amount included in the transaction amount in countries where more than one type of tax can be applied to the purchases. Default - `0.00`. Format: `x.xx` [oneOf 2].[allOf 5].[allOf 12].alternate_tax_id string no **Level III - Order Field:** Tax identification number of the merchant that reported the alternate tax amount. [oneOf 2].[allOf 5].[allOf 12].vat_tax_amount number no **Level III - Order Field:** Contains the amount of any value added taxes which can be associated with the purchased item. Default - `0.00`. Format: `x.xx` [oneOf 2].[allOf 5].[allOf 12].vat_tax_rate number no **Level III - Order Field:** Contains the tax rate used to calculate the sales tax amount appearing. Can contain up to 2 decimal places, e.g. 1% = 1.00. Default - `0.00`. Format: `x.xx` [oneOf 2].[allOf 5].[allOf 12].vat_invoice_reference_number string no **Level III - Order Field:** Invoice number that is associated with the VAT invoice. [oneOf 2].[allOf 5].[allOf 12].customer_vat_registration string no **Level III - Order Field:** Value added tax registration number supplied by the cardholder. [oneOf 2].[allOf 5].[allOf 12].merchant_vat_registration string no **Level III - Order Field:** Government assigned tax identification number of the merchant for whom the goods or services were purchased from. [oneOf 2].[allOf 5].[allOf 12].order_date string no **Level III - Order Field:** Purchase order date, defaults to the date of the transaction. Format: `YYMMDD` format: "date" [oneOf 2].[allOf 5].[allOf 13].item_product_code_1 string no **Level III - Line Item:** Merchant defined description code of the item being purchased. *Up to 99 sets of item_* fields are allowed.* [oneOf 2].[allOf 5].[allOf 13].item_description_1 string no **Level III - Line Item:** Description of the item(s) being supplied. [oneOf 2].[allOf 5].[allOf 13].item_commodity_code_1 string no **Level III - Line Item:** International description code of the individual good or service being supplied. The acquirer or processor will provide a list of current codes. [oneOf 2].[allOf 5].[allOf 13].item_unit_of_measure_1 string no **Level III - Line Item:** Code for units of measurement as used in international trade. Default - `EACH`. [oneOf 2].[allOf 5].[allOf 13].item_unit_cost_1 number no **Level III - Line Item:** Unit cost of item purchased, may contain up to 4 decimal places. [oneOf 2].[allOf 5].[allOf 13].item_quantity_1 integer no **Level III - Line Item:** Quantity of the item(s) being purchased. Default - `1`. [oneOf 2].[allOf 5].[allOf 13].item_total_amount_1 number no **Level III - Line Item:** Purchase amount associated with the item. Defaults to: 'item_unit_cost_#' x 'item_quantity_#' rounded to the nearest penny. [oneOf 2].[allOf 5].[allOf 13].item_tax_amount_1 number no **Level III - Line Item:** Amount of sales tax on specific item. Amount should not be included in 'total_amount_#'. Default - `0.00`. Format: `x.xx` [oneOf 2].[allOf 5].[allOf 13].item_tax_rate_1 number no **Level III - Line Item:** Percentage representing the value-added tax applied. Default - `0.00`. Format: `x.xx` [oneOf 2].[allOf 5].[allOf 13].item_discount_amount_1 number no **Level III - Line Item:** Discount amount which can have been applied by the merchant on the sale of the specific item. Amount should not be included in 'total_amount_#'. [oneOf 2].[allOf 5].[allOf 13].item_discount_rate_1 number no **Level III - Line Item:** Discount rate for the line item. Default - `0.00`. Format: `x.xx` [oneOf 2].[allOf 5].[allOf 13].item_tax_type_1 string no **Level III - Line Item:** Type of value-added taxes that are being used. [oneOf 2].[allOf 5].[allOf 13].item_alternate_tax_id_1 string no **Level III - Line Item:** Tax identification number of the merchant that reported the alternate tax amount. [oneOf 2].[allOf 5].[allOf 14].payment_facilitator_id string no **Payment Facilitator:** Payment Facilitator/Aggregator/ISO's ID Number [oneOf 2].[allOf 5].[allOf 14].submerchant_id string no **Payment Facilitator:** Sub-merchant Account ID [oneOf 2].[allOf 5].[allOf 14].submerchant_name string no **Payment Facilitator:** Sub-merchant's Name [oneOf 2].[allOf 5].[allOf 14].submerchant_address string no **Payment Facilitator:** Sub-merchant's Address [oneOf 2].[allOf 5].[allOf 14].submerchant_city string no **Payment Facilitator:** Sub-merchant's City [oneOf 2].[allOf 5].[allOf 14].submerchant_state string no **Payment Facilitator:** Sub-merchant's State [oneOf 2].[allOf 5].[allOf 14].submerchant_postal string no **Payment Facilitator:** Sub-merchant's Zip/Postal Code [oneOf 2].[allOf 5].[allOf 14].submerchant_country string no **Payment Facilitator:** Sub-merchant's Country [oneOf 2].[allOf 5].[allOf 14].submerchant_phone string no **Payment Facilitator:** Sub-merchant's Phone Number [oneOf 2].[allOf 5].[allOf 14].submerchant_email string no **Payment Facilitator:** Sub-merchant's Email Address format: "email" [oneOf 2].[allOf 6].industry string no The industry parameter is supported across multiple transaction types. Its purpose is to identify the merchant industry type for processing enum: ["ecommerce", "moto", "retail", "restaurant", "lodging"] [oneOf 2].[allOf 7].signature_image string no Cardholder signature image. Format: `base64 encoded raw PNG image. (16kiB maximum)` [oneOf 2].[allOf 8].network_tokenize string no Overrides the Customer Token Vault settings and tokenizes the transaction if eligible. Default - `0`. enum: ["0", "1"] [oneOf 3].[allOf 1].security_key string yes API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys [oneOf 3].[allOf 1].type string yes The type of transaction to be processed. enum: ["capture"] [oneOf 3].[allOf 1].transactionid string yes Original payment gateway transaction id. [oneOf 3].[allOf 1].amount string yes Total amount to be settled. This amount must be equal to or less than the original authorized amount. Format: `x.xx` [oneOf 3].[allOf 1].tracking_number string no Shipping tracking number. [oneOf 3].[allOf 1].shipping_carrier string no Shipping carrier. enum: ["ups", "fedex", "dhl", "usps"] [oneOf 3].[allOf 1].orderid string no Order ID. [oneOf 3].[allOf 2].signature_image string no Cardholder signature image. Format: `base64 encoded raw PNG image. (16kiB maximum)` [oneOf 4].[allOf 1].security_key string yes API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys [oneOf 4].[allOf 1].type string yes The type of transaction to be processed. enum: ["validate"] [oneOf 4].[allOf 3].[allOf 1].ccnumber string no Credit card number. <details> <summary>Allowed Card Numbers:</summary> | Card Type | Test Card Number | |:------------------|:---------------------| | Visa | 4111111111111111 | | MasterCard | 5431111111111111 | | Discover | 6011000991300009 | | American Express | 341111111111111 | | Diner's Club | 30205252489926 | | JCB | 3541963594572595 | | Maestro | 6799990100000000019 | </details> enum: ["4111111111111111", "5431111111111111", "6011000991300009", "341111111111111", "30205252489926", "3541963594572595", "6799990100000000019"] [oneOf 4].[allOf 3].[allOf 1].ccexp string no Credit card expiration date. Format: `MMYY` [oneOf 4].[allOf 3].[allOf 2].cvv string no The card security code. While this is not required, it is strongly recommended. [oneOf 4].[allOf 4].[allOf 1].payment_token string no The tokenized version of the customer's card or check information, generated by the [Payment Component](../docs/payment-component) (npm packages / [Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology)) and usable only once. Existing integrations may also supply a token from [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology). [oneOf 4].[allOf 4].[allOf 1].transaction_session_id string no A single use session ID used by Kount to link the transaction and Data Collector information together. * Should be generated every time a payment form is loaded by the cardholder. * Should be random/unpredictable (do not use sequential IDs). * Should not be reused within a 30 day period. This can be used with [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology) or the Payment API when using the [Kount DDC with Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology). Format: `alphanumeric` minLength: 32; maxLength: 32 [oneOf 4].[allOf 4].[allOf 1].applepay_payment_data string no The encrypted token created when integration directly to the Apple Pay SDK. [oneOf 4].[allOf 4].[allOf 1].googlepay_payment_data string no The encrypted token created when [integration directly to the Google Pay SDK](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#googlepay_variables). [oneOf 4].[allOf 4].[allOf 1].surcharge string no Surcharge amount. Format: `x.xx` [oneOf 4].[allOf 4].[allOf 1].convenience_fee string no Convenience fee amount. Format: `x.xx` [oneOf 4].[allOf 4].[allOf 1].misc_fee string no Miscellaneous fee amount. Format: `x.xx` [oneOf 4].[allOf 4].[allOf 1].misc_fee_name string no Custom miscellaneous fee name. Default: `Miscellaneous Fee` [oneOf 4].[allOf 4].[allOf 1].tip number no The final tip amount, included in the transaction, associated with the purchase. Format: `x.xx` [oneOf 4].[allOf 4].[allOf 1].currency string no The transaction currency. Format: `ISO 4217` [oneOf 4].[allOf 4].[allOf 1].processor_id string no If using Multiple MIDs, route to this processor (*processor_id* is obtained under Settings → Transaction Routing in the Control Panel). [oneOf 4].[allOf 4].[allOf 1].dup_seconds integer no Sets the time in seconds for duplicate transaction checking on supported processors. Set to *0* to disable duplicate checking. maximum: 7862400 [oneOf 4].[allOf 4].[allOf 2].descriptor string no Set payment descriptor on supported processors. [oneOf 4].[allOf 4].[allOf 2].descriptor_phone string no Set payment descriptor phone on supported processors. [oneOf 4].[allOf 4].[allOf 2].descriptor_address string no Set payment descriptor address on supported processors. [oneOf 4].[allOf 4].[allOf 2].descriptor_city string no Set payment descriptor city on supported processors. [oneOf 4].[allOf 4].[allOf 2].descriptor_state string no Set payment descriptor state on supported processors. [oneOf 4].[allOf 4].[allOf 2].descriptor_postal string no Set payment descriptor postal code on supported processors. [oneOf 4].[allOf 4].[allOf 2].descriptor_country string no Set payment descriptor country on supported processors. [oneOf 4].[allOf 4].[allOf 2].descriptor_mcc string no Set payment descriptor mcc on supported processors. [oneOf 4].[allOf 4].[allOf 2].descriptor_merchant_id string no Set payment descriptor merchant id on supported processors. [oneOf 4].[allOf 4].[allOf 2].descriptor_url string no Set payment descriptor url on supported processors. [oneOf 4].[allOf 4].[allOf 3].billing_method string no Recurring or installment classification for the processor. - `initial_recurring`: First transaction in a recurring sequence only. - `recurring`: Later charges in that sequence. - `installment`: Installment transactions; use `billing_number` and `billing_total` on supported processors. Which values apply depends on the processor. enum: ["initial_recurring", "recurring", "installment"] [oneOf 4].[allOf 4].[allOf 3].billing_number integer no Specify installment billing number, on supported processors. For use when `billing_method` is set to "installment". minimum: 0; maximum: 99 [oneOf 4].[allOf 4].[allOf 3].billing_total string no Specify installment billing total on supported processors. For use when `billing_method` is set to "installment". [oneOf 4].[allOf 4].[allOf 3].order_template string no Order template ID. [oneOf 4].[allOf 4].[allOf 3].order_description string no Order description. [oneOf 4].[allOf 4].[allOf 3].orderid string no Order Id. [oneOf 4].[allOf 4].[allOf 3].ipaddress string no IP address of cardholder, this field is recommended. Format: `xxx.xxx.xxx.xxx` [oneOf 4].[allOf 4].[allOf 4].first_name string no Cardholder's first name. [oneOf 4].[allOf 4].[allOf 4].last_name string no Cardholder's last name [oneOf 4].[allOf 4].[allOf 4].company string no Cardholder's company [oneOf 4].[allOf 4].[allOf 4].address1 string no Card billing address [oneOf 4].[allOf 4].[allOf 4].address2 string no Card billing address, line 2 [oneOf 4].[allOf 4].[allOf 4].city string no Card billing city [oneOf 4].[allOf 4].[allOf 4].state string no Card billing state. Format: `CC` [oneOf 4].[allOf 4].[allOf 4].zip string no Card billing zip code [oneOf 4].[allOf 4].[allOf 4].country string no Card billing country. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 4].[allOf 4].[allOf 4].phone string no Billing phone number [oneOf 4].[allOf 4].[allOf 4].fax string no Billing fax number [oneOf 4].[allOf 4].[allOf 4].email string no Billing email address format: "email" [oneOf 4].[allOf 4].[allOf 5].drivers_license_number string no Driver's license number. [oneOf 4].[allOf 4].[allOf 5].drivers_license_dob string no Driver's license date of birth. [oneOf 4].[allOf 4].[allOf 5].drivers_license_state string no The state that issued the customer's driver's license. [oneOf 4].[allOf 4].[allOf 6].shipping_firstname string no Shipping first name [oneOf 4].[allOf 4].[allOf 6].shipping_lastname string no Shipping last name [oneOf 4].[allOf 4].[allOf 6].shipping_company string no Shipping company [oneOf 4].[allOf 4].[allOf 6].shipping_address1 string no Shipping address [oneOf 4].[allOf 4].[allOf 6].shipping_address2 string no Shipping address, line 2 [oneOf 4].[allOf 4].[allOf 6].shipping_city string no Shipping city [oneOf 4].[allOf 4].[allOf 6].shipping_state string no Shipping state. Format: `CC` [oneOf 4].[allOf 4].[allOf 6].shipping_zip string no Shipping zip code [oneOf 4].[allOf 4].[allOf 6].shipping_country string no Shipping country. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 4].[allOf 4].[allOf 6].shipping_email string no Shipping email address format: "email" [oneOf 4].[allOf 4].[allOf 7].merchant_defined_field_1 string no Merchant defined field. You can pass custom information in up to 20 fields. Format: `merchant_defined_field_1=Value1`, `merchant_defined_field_2=Value2`, etc... [oneOf 4].[allOf 4].[allOf 8].customer_receipt string no If set to true, when the customer is charged, they will be sent a transaction receipt. enum: ["true", "false"] [oneOf 4].[allOf 4].[allOf 8].cardholder_auth string no Set 3D Secure condition. Value used to determine E-commerce indicator (ECI). **Required for 3D Secure transactions** enum: ["verified", "attempted"] [oneOf 4].[allOf 4].[allOf 8].cavv string no Cardholder authentication verification value. Format: `base64 encoded` **Required for 3D Secure transactions** [oneOf 4].[allOf 4].[allOf 8].xid string no Cardholder authentication transaction id. Format: `base64 encoded` **Required for 3D Secure transactions** [oneOf 4].[allOf 4].[allOf 8].three_ds_version string no 3DSecure version. **Required for 3D Secure transactions** enum: ["2.0.0", "2.2.0"] [oneOf 4].[allOf 4].[allOf 8].directory_server_id string no Directory Server Transaction ID. May be provided as part of 3DSecure 2.0 authentication. Format: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` [oneOf 4].[allOf 4].[allOf 8].source_transaction_id string no Specifies a payment gateway transaction id in order to associate payment information with a Subscription or Customer Vault record. Must be set with a 'recurring' or 'customer_vault' action. [oneOf 4].[allOf 4].[allOf 8].pinless_debit_override string no Set to 'Y' if you have Pinless Debit Conversion enabled but want to opt out for this transaction. Feature applies to selected processors only. [oneOf 4].[allOf 4].[allOf 9].recurring string no **Recurring Field:** Recurring action to be processed. enum: ["add_subscription"] [oneOf 4].[allOf 4].[allOf 9].plan_id string no **Recurring Field:** Create a subscription tied to a Plan ID if the sale/auth transaction is successful. Required when **recurring** variable is set to `add_subscription` [oneOf 4].[allOf 4].[allOf 9].plan_payments integer no **Recurring Field:** The number of payments before the recurring plan is complete. Note: Use '0' for until canceled Required when **recurring** variable is set to `add_subscription` [oneOf 4].[allOf 4].[allOf 9].plan_amount number no **Recurring Field:** The plan amount to be charged each billing cycle. Format: `x.xx` Required when **recurring** variable is set to `add_subscription` [oneOf 4].[allOf 4].[allOf 9].month_frequency integer no **Recurring Field:** How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'. Required when **recurring** variable is set to `add_subscription` minimum: 1; maximum: 24 [oneOf 4].[allOf 4].[allOf 9].day_of_month integer no **Recurring Field:** The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'. For months without 29, 30, or 31 days, the charge will be on the last day Required when **recurring** variable is set to `add_subscription` minimum: 1; maximum: 31 [oneOf 4].[allOf 4].[allOf 9].day_frequency integer no **Recurring Field:** How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'. Required when **recurring** variable is set to `add_subscription` [oneOf 4].[allOf 4].[allOf 9].start_date string no **Recurring Field:** The first day that the customer will be charged. Format: `YYYYMMDD` Required when **recurring** variable is set to `add_subscription` format: "date" [oneOf 4].[allOf 4].[allOf 10].customer_vault string no Associate payment information with a Customer Vault record if the transaction is successful. enum: ["add_customer", "update_customer"] [oneOf 4].[allOf 4].[allOf 10].customer_vault_id string no Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id. [oneOf 4].[allOf 4].[allOf 11].initiated_by string no **Stored Credentials (CIT/MIT):** Who initiated the transaction. enum: ["customer", "merchant"] [oneOf 4].[allOf 4].[allOf 11].initial_transaction_id string no **Stored Credentials (CIT/MIT):** Original payment gateway transaction id. [oneOf 4].[allOf 4].[allOf 11].stored_credential_indicator string no **Stored Credentials (CIT/MIT):** The indicator of the stored credential. Use **'stored'** when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system. Use **'used'** when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method. enum: ["stored", "used"] [oneOf 4].[allOf 4].[allOf 12].shipping number no **Level II/III - Order Field:** Freight or shipping amount included in the transaction amount. Default - `0.00`. Format: `x.xx` [oneOf 4].[allOf 4].[allOf 12].tax number no **Level II/III - Order Field:** The sales tax, included in the transaction amount, associated with the purchase. Setting tax equal to '-1' indicates an order that is exempt from sales tax. Default - `0.00`. Format: `x.xx` [oneOf 4].[allOf 4].[allOf 12].ponumber string no **Level II/III - Order Field:** Purchase order number [oneOf 4].[allOf 4].[allOf 12].orderid string no **Level III - Order Field:** Identifier assigned by the merchant. This defaults to gateway transaction id. [oneOf 4].[allOf 4].[allOf 12].shipping_country string no **Level III - Order Field:** Shipping country (e.g. US). Format: `CC` - ISO 3166-1 alpha-2 [oneOf 4].[allOf 4].[allOf 12].shipping_postal string no **Level III - Order Field:** Postal/ZIP code of the address where purchased goods will be delivered. This field can be identical to the 'ship_from_postal' if the customer is present and takes immediate possession of the goods. [oneOf 4].[allOf 4].[allOf 12].ship_from_postal string no **Level III - Order Field:** Postal/ZIP code of the address from where purchased goods are being shipped, defaults to merchant profile postal code. [oneOf 4].[allOf 4].[allOf 12].summary_commodity_code string no **Level III - Order Field:** 4 character international description code of the overall goods or services being supplied. The acquirer or processor will provide a list of current codes. [oneOf 4].[allOf 4].[allOf 12].duty_amount number no **Level III - Order Field:** Amount included in the transaction amount associated with the import of purchased goods. Default - `0.00`. Format: `x.xx` [oneOf 4].[allOf 4].[allOf 12].discount_amount number no **Level III - Order Field:** Amount included in the transaction amount of any discount applied to complete order by the merchant. Default - `0.00`. Format: `x.xx` [oneOf 4].[allOf 4].[allOf 12].national_tax_amount number no **Level III - Order Field:** The national tax amount included in the transaction amount. Default - `0.00`. Format: `x.xx` [oneOf 4].[allOf 4].[allOf 12].alternate_tax_amount number no **Level III - Order Field:** Second tax amount included in the transaction amount in countries where more than one type of tax can be applied to the purchases. Default - `0.00`. Format: `x.xx` [oneOf 4].[allOf 4].[allOf 12].alternate_tax_id string no **Level III - Order Field:** Tax identification number of the merchant that reported the alternate tax amount. [oneOf 4].[allOf 4].[allOf 12].vat_tax_amount number no **Level III - Order Field:** Contains the amount of any value added taxes which can be associated with the purchased item. Default - `0.00`. Format: `x.xx` [oneOf 4].[allOf 4].[allOf 12].vat_tax_rate number no **Level III - Order Field:** Contains the tax rate used to calculate the sales tax amount appearing. Can contain up to 2 decimal places, e.g. 1% = 1.00. Default - `0.00`. Format: `x.xx` [oneOf 4].[allOf 4].[allOf 12].vat_invoice_reference_number string no **Level III - Order Field:** Invoice number that is associated with the VAT invoice. [oneOf 4].[allOf 4].[allOf 12].customer_vat_registration string no **Level III - Order Field:** Value added tax registration number supplied by the cardholder. [oneOf 4].[allOf 4].[allOf 12].merchant_vat_registration string no **Level III - Order Field:** Government assigned tax identification number of the merchant for whom the goods or services were purchased from. [oneOf 4].[allOf 4].[allOf 12].order_date string no **Level III - Order Field:** Purchase order date, defaults to the date of the transaction. Format: `YYMMDD` format: "date" [oneOf 4].[allOf 4].[allOf 13].item_product_code_1 string no **Level III - Line Item:** Merchant defined description code of the item being purchased. *Up to 99 sets of item_* fields are allowed.* [oneOf 4].[allOf 4].[allOf 13].item_description_1 string no **Level III - Line Item:** Description of the item(s) being supplied. [oneOf 4].[allOf 4].[allOf 13].item_commodity_code_1 string no **Level III - Line Item:** International description code of the individual good or service being supplied. The acquirer or processor will provide a list of current codes. [oneOf 4].[allOf 4].[allOf 13].item_unit_of_measure_1 string no **Level III - Line Item:** Code for units of measurement as used in international trade. Default - `EACH`. [oneOf 4].[allOf 4].[allOf 13].item_unit_cost_1 number no **Level III - Line Item:** Unit cost of item purchased, may contain up to 4 decimal places. [oneOf 4].[allOf 4].[allOf 13].item_quantity_1 integer no **Level III - Line Item:** Quantity of the item(s) being purchased. Default - `1`. [oneOf 4].[allOf 4].[allOf 13].item_total_amount_1 number no **Level III - Line Item:** Purchase amount associated with the item. Defaults to: 'item_unit_cost_#' x 'item_quantity_#' rounded to the nearest penny. [oneOf 4].[allOf 4].[allOf 13].item_tax_amount_1 number no **Level III - Line Item:** Amount of sales tax on specific item. Amount should not be included in 'total_amount_#'. Default - `0.00`. Format: `x.xx` [oneOf 4].[allOf 4].[allOf 13].item_tax_rate_1 number no **Level III - Line Item:** Percentage representing the value-added tax applied. Default - `0.00`. Format: `x.xx` [oneOf 4].[allOf 4].[allOf 13].item_discount_amount_1 number no **Level III - Line Item:** Discount amount which can have been applied by the merchant on the sale of the specific item. Amount should not be included in 'total_amount_#'. [oneOf 4].[allOf 4].[allOf 13].item_discount_rate_1 number no **Level III - Line Item:** Discount rate for the line item. Default - `0.00`. Format: `x.xx` [oneOf 4].[allOf 4].[allOf 13].item_tax_type_1 string no **Level III - Line Item:** Type of value-added taxes that are being used. [oneOf 4].[allOf 4].[allOf 13].item_alternate_tax_id_1 string no **Level III - Line Item:** Tax identification number of the merchant that reported the alternate tax amount. [oneOf 4].[allOf 4].[allOf 14].payment_facilitator_id string no **Payment Facilitator:** Payment Facilitator/Aggregator/ISO's ID Number [oneOf 4].[allOf 4].[allOf 14].submerchant_id string no **Payment Facilitator:** Sub-merchant Account ID [oneOf 4].[allOf 4].[allOf 14].submerchant_name string no **Payment Facilitator:** Sub-merchant's Name [oneOf 4].[allOf 4].[allOf 14].submerchant_address string no **Payment Facilitator:** Sub-merchant's Address [oneOf 4].[allOf 4].[allOf 14].submerchant_city string no **Payment Facilitator:** Sub-merchant's City [oneOf 4].[allOf 4].[allOf 14].submerchant_state string no **Payment Facilitator:** Sub-merchant's State [oneOf 4].[allOf 4].[allOf 14].submerchant_postal string no **Payment Facilitator:** Sub-merchant's Zip/Postal Code [oneOf 4].[allOf 4].[allOf 14].submerchant_country string no **Payment Facilitator:** Sub-merchant's Country [oneOf 4].[allOf 4].[allOf 14].submerchant_phone string no **Payment Facilitator:** Sub-merchant's Phone Number [oneOf 4].[allOf 4].[allOf 14].submerchant_email string no **Payment Facilitator:** Sub-merchant's Email Address format: "email" [oneOf 4].[allOf 5].signature_image string no Cardholder signature image. Format: `base64 encoded raw PNG image. (16kiB maximum)` [oneOf 5].[allOf 1].security_key string yes API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys [oneOf 5].[allOf 1].type string yes The type of transaction to be processed. enum: ["credit"] [oneOf 5].[allOf 3].[allOf 1].ccnumber string no Credit card number. <details> <summary>Allowed Card Numbers:</summary> | Card Type | Test Card Number | |:------------------|:---------------------| | Visa | 4111111111111111 | | MasterCard | 5431111111111111 | | Discover | 6011000991300009 | | American Express | 341111111111111 | | Diner's Club | 30205252489926 | | JCB | 3541963594572595 | | Maestro | 6799990100000000019 | </details> enum: ["4111111111111111", "5431111111111111", "6011000991300009", "341111111111111", "30205252489926", "3541963594572595", "6799990100000000019"] [oneOf 5].[allOf 3].[allOf 1].ccexp string no Credit card expiration date. Format: `MMYY` [oneOf 5].[allOf 3].[allOf 2].cvv string no The card security code. While this is not required, it is strongly recommended. [oneOf 5].[allOf 4].amount string no Total amount to be charged. Format: `x.xx` [oneOf 5].[allOf 5].[allOf 1].payment_token string no The tokenized version of the customer's card or check information, generated by the [Payment Component](../docs/payment-component) (npm packages / [Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology)) and usable only once. Existing integrations may also supply a token from [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology). [oneOf 5].[allOf 5].[allOf 1].transaction_session_id string no A single use session ID used by Kount to link the transaction and Data Collector information together. * Should be generated every time a payment form is loaded by the cardholder. * Should be random/unpredictable (do not use sequential IDs). * Should not be reused within a 30 day period. This can be used with [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology) or the Payment API when using the [Kount DDC with Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology). Format: `alphanumeric` minLength: 32; maxLength: 32 [oneOf 5].[allOf 5].[allOf 1].applepay_payment_data string no The encrypted token created when integration directly to the Apple Pay SDK. [oneOf 5].[allOf 5].[allOf 1].googlepay_payment_data string no The encrypted token created when [integration directly to the Google Pay SDK](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#googlepay_variables). [oneOf 5].[allOf 5].[allOf 1].surcharge string no Surcharge amount. Format: `x.xx` [oneOf 5].[allOf 5].[allOf 1].convenience_fee string no Convenience fee amount. Format: `x.xx` [oneOf 5].[allOf 5].[allOf 1].misc_fee string no Miscellaneous fee amount. Format: `x.xx` [oneOf 5].[allOf 5].[allOf 1].misc_fee_name string no Custom miscellaneous fee name. Default: `Miscellaneous Fee` [oneOf 5].[allOf 5].[allOf 1].tip number no The final tip amount, included in the transaction, associated with the purchase. Format: `x.xx` [oneOf 5].[allOf 5].[allOf 1].currency string no The transaction currency. Format: `ISO 4217` [oneOf 5].[allOf 5].[allOf 1].processor_id string no If using Multiple MIDs, route to this processor (*processor_id* is obtained under Settings → Transaction Routing in the Control Panel). [oneOf 5].[allOf 5].[allOf 1].dup_seconds integer no Sets the time in seconds for duplicate transaction checking on supported processors. Set to *0* to disable duplicate checking. maximum: 7862400 [oneOf 5].[allOf 5].[allOf 2].descriptor string no Set payment descriptor on supported processors. [oneOf 5].[allOf 5].[allOf 2].descriptor_phone string no Set payment descriptor phone on supported processors. [oneOf 5].[allOf 5].[allOf 2].descriptor_address string no Set payment descriptor address on supported processors. [oneOf 5].[allOf 5].[allOf 2].descriptor_city string no Set payment descriptor city on supported processors. [oneOf 5].[allOf 5].[allOf 2].descriptor_state string no Set payment descriptor state on supported processors. [oneOf 5].[allOf 5].[allOf 2].descriptor_postal string no Set payment descriptor postal code on supported processors. [oneOf 5].[allOf 5].[allOf 2].descriptor_country string no Set payment descriptor country on supported processors. [oneOf 5].[allOf 5].[allOf 2].descriptor_mcc string no Set payment descriptor mcc on supported processors. [oneOf 5].[allOf 5].[allOf 2].descriptor_merchant_id string no Set payment descriptor merchant id on supported processors. [oneOf 5].[allOf 5].[allOf 2].descriptor_url string no Set payment descriptor url on supported processors. [oneOf 5].[allOf 5].[allOf 3].billing_method string no Recurring or installment classification for the processor. - `initial_recurring`: First transaction in a recurring sequence only. - `recurring`: Later charges in that sequence. - `installment`: Installment transactions; use `billing_number` and `billing_total` on supported processors. Which values apply depends on the processor. enum: ["initial_recurring", "recurring", "installment"] [oneOf 5].[allOf 5].[allOf 3].billing_number integer no Specify installment billing number, on supported processors. For use when `billing_method` is set to "installment". minimum: 0; maximum: 99 [oneOf 5].[allOf 5].[allOf 3].billing_total string no Specify installment billing total on supported processors. For use when `billing_method` is set to "installment". [oneOf 5].[allOf 5].[allOf 3].order_template string no Order template ID. [oneOf 5].[allOf 5].[allOf 3].order_description string no Order description. [oneOf 5].[allOf 5].[allOf 3].orderid string no Order Id. [oneOf 5].[allOf 5].[allOf 3].ipaddress string no IP address of cardholder, this field is recommended. Format: `xxx.xxx.xxx.xxx` [oneOf 5].[allOf 5].[allOf 4].first_name string no Cardholder's first name. [oneOf 5].[allOf 5].[allOf 4].last_name string no Cardholder's last name [oneOf 5].[allOf 5].[allOf 4].company string no Cardholder's company [oneOf 5].[allOf 5].[allOf 4].address1 string no Card billing address [oneOf 5].[allOf 5].[allOf 4].address2 string no Card billing address, line 2 [oneOf 5].[allOf 5].[allOf 4].city string no Card billing city [oneOf 5].[allOf 5].[allOf 4].state string no Card billing state. Format: `CC` [oneOf 5].[allOf 5].[allOf 4].zip string no Card billing zip code [oneOf 5].[allOf 5].[allOf 4].country string no Card billing country. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 5].[allOf 5].[allOf 4].phone string no Billing phone number [oneOf 5].[allOf 5].[allOf 4].fax string no Billing fax number [oneOf 5].[allOf 5].[allOf 4].email string no Billing email address format: "email" [oneOf 5].[allOf 5].[allOf 5].drivers_license_number string no Driver's license number. [oneOf 5].[allOf 5].[allOf 5].drivers_license_dob string no Driver's license date of birth. [oneOf 5].[allOf 5].[allOf 5].drivers_license_state string no The state that issued the customer's driver's license. [oneOf 5].[allOf 5].[allOf 6].shipping_firstname string no Shipping first name [oneOf 5].[allOf 5].[allOf 6].shipping_lastname string no Shipping last name [oneOf 5].[allOf 5].[allOf 6].shipping_company string no Shipping company [oneOf 5].[allOf 5].[allOf 6].shipping_address1 string no Shipping address [oneOf 5].[allOf 5].[allOf 6].shipping_address2 string no Shipping address, line 2 [oneOf 5].[allOf 5].[allOf 6].shipping_city string no Shipping city [oneOf 5].[allOf 5].[allOf 6].shipping_state string no Shipping state. Format: `CC` [oneOf 5].[allOf 5].[allOf 6].shipping_zip string no Shipping zip code [oneOf 5].[allOf 5].[allOf 6].shipping_country string no Shipping country. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 5].[allOf 5].[allOf 6].shipping_email string no Shipping email address format: "email" [oneOf 5].[allOf 5].[allOf 7].merchant_defined_field_1 string no Merchant defined field. You can pass custom information in up to 20 fields. Format: `merchant_defined_field_1=Value1`, `merchant_defined_field_2=Value2`, etc... [oneOf 5].[allOf 5].[allOf 8].customer_receipt string no If set to true, when the customer is charged, they will be sent a transaction receipt. enum: ["true", "false"] [oneOf 5].[allOf 5].[allOf 8].cardholder_auth string no Set 3D Secure condition. Value used to determine E-commerce indicator (ECI). **Required for 3D Secure transactions** enum: ["verified", "attempted"] [oneOf 5].[allOf 5].[allOf 8].cavv string no Cardholder authentication verification value. Format: `base64 encoded` **Required for 3D Secure transactions** [oneOf 5].[allOf 5].[allOf 8].xid string no Cardholder authentication transaction id. Format: `base64 encoded` **Required for 3D Secure transactions** [oneOf 5].[allOf 5].[allOf 8].three_ds_version string no 3DSecure version. **Required for 3D Secure transactions** enum: ["2.0.0", "2.2.0"] [oneOf 5].[allOf 5].[allOf 8].directory_server_id string no Directory Server Transaction ID. May be provided as part of 3DSecure 2.0 authentication. Format: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` [oneOf 5].[allOf 5].[allOf 8].source_transaction_id string no Specifies a payment gateway transaction id in order to associate payment information with a Subscription or Customer Vault record. Must be set with a 'recurring' or 'customer_vault' action. [oneOf 5].[allOf 5].[allOf 8].pinless_debit_override string no Set to 'Y' if you have Pinless Debit Conversion enabled but want to opt out for this transaction. Feature applies to selected processors only. [oneOf 5].[allOf 5].[allOf 9].recurring string no **Recurring Field:** Recurring action to be processed. enum: ["add_subscription"] [oneOf 5].[allOf 5].[allOf 9].plan_id string no **Recurring Field:** Create a subscription tied to a Plan ID if the sale/auth transaction is successful. Required when **recurring** variable is set to `add_subscription` [oneOf 5].[allOf 5].[allOf 9].plan_payments integer no **Recurring Field:** The number of payments before the recurring plan is complete. Note: Use '0' for until canceled Required when **recurring** variable is set to `add_subscription` [oneOf 5].[allOf 5].[allOf 9].plan_amount number no **Recurring Field:** The plan amount to be charged each billing cycle. Format: `x.xx` Required when **recurring** variable is set to `add_subscription` [oneOf 5].[allOf 5].[allOf 9].month_frequency integer no **Recurring Field:** How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'. Required when **recurring** variable is set to `add_subscription` minimum: 1; maximum: 24 [oneOf 5].[allOf 5].[allOf 9].day_of_month integer no **Recurring Field:** The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'. For months without 29, 30, or 31 days, the charge will be on the last day Required when **recurring** variable is set to `add_subscription` minimum: 1; maximum: 31 [oneOf 5].[allOf 5].[allOf 9].day_frequency integer no **Recurring Field:** How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'. Required when **recurring** variable is set to `add_subscription` [oneOf 5].[allOf 5].[allOf 9].start_date string no **Recurring Field:** The first day that the customer will be charged. Format: `YYYYMMDD` Required when **recurring** variable is set to `add_subscription` format: "date" [oneOf 5].[allOf 5].[allOf 10].customer_vault string no Associate payment information with a Customer Vault record if the transaction is successful. enum: ["add_customer", "update_customer"] [oneOf 5].[allOf 5].[allOf 10].customer_vault_id string no Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id. [oneOf 5].[allOf 5].[allOf 11].initiated_by string no **Stored Credentials (CIT/MIT):** Who initiated the transaction. enum: ["customer", "merchant"] [oneOf 5].[allOf 5].[allOf 11].initial_transaction_id string no **Stored Credentials (CIT/MIT):** Original payment gateway transaction id. [oneOf 5].[allOf 5].[allOf 11].stored_credential_indicator string no **Stored Credentials (CIT/MIT):** The indicator of the stored credential. Use **'stored'** when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system. Use **'used'** when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method. enum: ["stored", "used"] [oneOf 5].[allOf 5].[allOf 12].shipping number no **Level II/III - Order Field:** Freight or shipping amount included in the transaction amount. Default - `0.00`. Format: `x.xx` [oneOf 5].[allOf 5].[allOf 12].tax number no **Level II/III - Order Field:** The sales tax, included in the transaction amount, associated with the purchase. Setting tax equal to '-1' indicates an order that is exempt from sales tax. Default - `0.00`. Format: `x.xx` [oneOf 5].[allOf 5].[allOf 12].ponumber string no **Level II/III - Order Field:** Purchase order number [oneOf 5].[allOf 5].[allOf 12].orderid string no **Level III - Order Field:** Identifier assigned by the merchant. This defaults to gateway transaction id. [oneOf 5].[allOf 5].[allOf 12].shipping_country string no **Level III - Order Field:** Shipping country (e.g. US). Format: `CC` - ISO 3166-1 alpha-2 [oneOf 5].[allOf 5].[allOf 12].shipping_postal string no **Level III - Order Field:** Postal/ZIP code of the address where purchased goods will be delivered. This field can be identical to the 'ship_from_postal' if the customer is present and takes immediate possession of the goods. [oneOf 5].[allOf 5].[allOf 12].ship_from_postal string no **Level III - Order Field:** Postal/ZIP code of the address from where purchased goods are being shipped, defaults to merchant profile postal code. [oneOf 5].[allOf 5].[allOf 12].summary_commodity_code string no **Level III - Order Field:** 4 character international description code of the overall goods or services being supplied. The acquirer or processor will provide a list of current codes. [oneOf 5].[allOf 5].[allOf 12].duty_amount number no **Level III - Order Field:** Amount included in the transaction amount associated with the import of purchased goods. Default - `0.00`. Format: `x.xx` [oneOf 5].[allOf 5].[allOf 12].discount_amount number no **Level III - Order Field:** Amount included in the transaction amount of any discount applied to complete order by the merchant. Default - `0.00`. Format: `x.xx` [oneOf 5].[allOf 5].[allOf 12].national_tax_amount number no **Level III - Order Field:** The national tax amount included in the transaction amount. Default - `0.00`. Format: `x.xx` [oneOf 5].[allOf 5].[allOf 12].alternate_tax_amount number no **Level III - Order Field:** Second tax amount included in the transaction amount in countries where more than one type of tax can be applied to the purchases. Default - `0.00`. Format: `x.xx` [oneOf 5].[allOf 5].[allOf 12].alternate_tax_id string no **Level III - Order Field:** Tax identification number of the merchant that reported the alternate tax amount. [oneOf 5].[allOf 5].[allOf 12].vat_tax_amount number no **Level III - Order Field:** Contains the amount of any value added taxes which can be associated with the purchased item. Default - `0.00`. Format: `x.xx` [oneOf 5].[allOf 5].[allOf 12].vat_tax_rate number no **Level III - Order Field:** Contains the tax rate used to calculate the sales tax amount appearing. Can contain up to 2 decimal places, e.g. 1% = 1.00. Default - `0.00`. Format: `x.xx` [oneOf 5].[allOf 5].[allOf 12].vat_invoice_reference_number string no **Level III - Order Field:** Invoice number that is associated with the VAT invoice. [oneOf 5].[allOf 5].[allOf 12].customer_vat_registration string no **Level III - Order Field:** Value added tax registration number supplied by the cardholder. [oneOf 5].[allOf 5].[allOf 12].merchant_vat_registration string no **Level III - Order Field:** Government assigned tax identification number of the merchant for whom the goods or services were purchased from. [oneOf 5].[allOf 5].[allOf 12].order_date string no **Level III - Order Field:** Purchase order date, defaults to the date of the transaction. Format: `YYMMDD` format: "date" [oneOf 5].[allOf 5].[allOf 13].item_product_code_1 string no **Level III - Line Item:** Merchant defined description code of the item being purchased. *Up to 99 sets of item_* fields are allowed.* [oneOf 5].[allOf 5].[allOf 13].item_description_1 string no **Level III - Line Item:** Description of the item(s) being supplied. [oneOf 5].[allOf 5].[allOf 13].item_commodity_code_1 string no **Level III - Line Item:** International description code of the individual good or service being supplied. The acquirer or processor will provide a list of current codes. [oneOf 5].[allOf 5].[allOf 13].item_unit_of_measure_1 string no **Level III - Line Item:** Code for units of measurement as used in international trade. Default - `EACH`. [oneOf 5].[allOf 5].[allOf 13].item_unit_cost_1 number no **Level III - Line Item:** Unit cost of item purchased, may contain up to 4 decimal places. [oneOf 5].[allOf 5].[allOf 13].item_quantity_1 integer no **Level III - Line Item:** Quantity of the item(s) being purchased. Default - `1`. [oneOf 5].[allOf 5].[allOf 13].item_total_amount_1 number no **Level III - Line Item:** Purchase amount associated with the item. Defaults to: 'item_unit_cost_#' x 'item_quantity_#' rounded to the nearest penny. [oneOf 5].[allOf 5].[allOf 13].item_tax_amount_1 number no **Level III - Line Item:** Amount of sales tax on specific item. Amount should not be included in 'total_amount_#'. Default - `0.00`. Format: `x.xx` [oneOf 5].[allOf 5].[allOf 13].item_tax_rate_1 number no **Level III - Line Item:** Percentage representing the value-added tax applied. Default - `0.00`. Format: `x.xx` [oneOf 5].[allOf 5].[allOf 13].item_discount_amount_1 number no **Level III - Line Item:** Discount amount which can have been applied by the merchant on the sale of the specific item. Amount should not be included in 'total_amount_#'. [oneOf 5].[allOf 5].[allOf 13].item_discount_rate_1 number no **Level III - Line Item:** Discount rate for the line item. Default - `0.00`. Format: `x.xx` [oneOf 5].[allOf 5].[allOf 13].item_tax_type_1 string no **Level III - Line Item:** Type of value-added taxes that are being used. [oneOf 5].[allOf 5].[allOf 13].item_alternate_tax_id_1 string no **Level III - Line Item:** Tax identification number of the merchant that reported the alternate tax amount. [oneOf 5].[allOf 5].[allOf 14].payment_facilitator_id string no **Payment Facilitator:** Payment Facilitator/Aggregator/ISO's ID Number [oneOf 5].[allOf 5].[allOf 14].submerchant_id string no **Payment Facilitator:** Sub-merchant Account ID [oneOf 5].[allOf 5].[allOf 14].submerchant_name string no **Payment Facilitator:** Sub-merchant's Name [oneOf 5].[allOf 5].[allOf 14].submerchant_address string no **Payment Facilitator:** Sub-merchant's Address [oneOf 5].[allOf 5].[allOf 14].submerchant_city string no **Payment Facilitator:** Sub-merchant's City [oneOf 5].[allOf 5].[allOf 14].submerchant_state string no **Payment Facilitator:** Sub-merchant's State [oneOf 5].[allOf 5].[allOf 14].submerchant_postal string no **Payment Facilitator:** Sub-merchant's Zip/Postal Code [oneOf 5].[allOf 5].[allOf 14].submerchant_country string no **Payment Facilitator:** Sub-merchant's Country [oneOf 5].[allOf 5].[allOf 14].submerchant_phone string no **Payment Facilitator:** Sub-merchant's Phone Number [oneOf 5].[allOf 5].[allOf 14].submerchant_email string no **Payment Facilitator:** Sub-merchant's Email Address format: "email" [oneOf 5].[allOf 6].industry string no The industry parameter is supported across multiple transaction types. Its purpose is to identify the merchant industry type for processing enum: ["ecommerce", "moto", "retail", "restaurant", "lodging"] [oneOf 5].[allOf 7].signature_image string no Cardholder signature image. Format: `base64 encoded raw PNG image. (16kiB maximum)` [oneOf 5].[allOf 8].network_tokenize string no Overrides the Customer Token Vault settings and tokenizes the transaction if eligible. Default - `0`. enum: ["0", "1"] [oneOf 6].[allOf 1].security_key string yes API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys [oneOf 6].[allOf 1].type string yes The type of transaction to be processed. **Note** that offline transactions need to be enabled. enum: ["offline"] [oneOf 6].[allOf 1].authorization_code string yes Specify authorization code. [oneOf 6].[allOf 3].[allOf 1].ccnumber string no Credit card number. <details> <summary>Allowed Card Numbers:</summary> | Card Type | Test Card Number | |:------------------|:---------------------| | Visa | 4111111111111111 | | MasterCard | 5431111111111111 | | Discover | 6011000991300009 | | American Express | 341111111111111 | | Diner's Club | 30205252489926 | | JCB | 3541963594572595 | | Maestro | 6799990100000000019 | </details> enum: ["4111111111111111", "5431111111111111", "6011000991300009", "341111111111111", "30205252489926", "3541963594572595", "6799990100000000019"] [oneOf 6].[allOf 3].[allOf 1].ccexp string no Credit card expiration date. Format: `MMYY` [oneOf 6].[allOf 3].[allOf 2].cvv string no The card security code. While this is not required, it is strongly recommended. [oneOf 6].[allOf 4].amount string no Total amount to be charged. Format: `x.xx` [oneOf 6].[allOf 5].[allOf 1].payment_token string no The tokenized version of the customer's card or check information, generated by the [Payment Component](../docs/payment-component) (npm packages / [Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology)) and usable only once. Existing integrations may also supply a token from [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology). [oneOf 6].[allOf 5].[allOf 1].transaction_session_id string no A single use session ID used by Kount to link the transaction and Data Collector information together. * Should be generated every time a payment form is loaded by the cardholder. * Should be random/unpredictable (do not use sequential IDs). * Should not be reused within a 30 day period. This can be used with [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology) or the Payment API when using the [Kount DDC with Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology). Format: `alphanumeric` minLength: 32; maxLength: 32 [oneOf 6].[allOf 5].[allOf 1].applepay_payment_data string no The encrypted token created when integration directly to the Apple Pay SDK. [oneOf 6].[allOf 5].[allOf 1].googlepay_payment_data string no The encrypted token created when [integration directly to the Google Pay SDK](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#googlepay_variables). [oneOf 6].[allOf 5].[allOf 1].surcharge string no Surcharge amount. Format: `x.xx` [oneOf 6].[allOf 5].[allOf 1].convenience_fee string no Convenience fee amount. Format: `x.xx` [oneOf 6].[allOf 5].[allOf 1].misc_fee string no Miscellaneous fee amount. Format: `x.xx` [oneOf 6].[allOf 5].[allOf 1].misc_fee_name string no Custom miscellaneous fee name. Default: `Miscellaneous Fee` [oneOf 6].[allOf 5].[allOf 1].tip number no The final tip amount, included in the transaction, associated with the purchase. Format: `x.xx` [oneOf 6].[allOf 5].[allOf 1].currency string no The transaction currency. Format: `ISO 4217` [oneOf 6].[allOf 5].[allOf 1].processor_id string no If using Multiple MIDs, route to this processor (*processor_id* is obtained under Settings → Transaction Routing in the Control Panel). [oneOf 6].[allOf 5].[allOf 1].dup_seconds integer no Sets the time in seconds for duplicate transaction checking on supported processors. Set to *0* to disable duplicate checking. maximum: 7862400 [oneOf 6].[allOf 5].[allOf 2].descriptor string no Set payment descriptor on supported processors. [oneOf 6].[allOf 5].[allOf 2].descriptor_phone string no Set payment descriptor phone on supported processors. [oneOf 6].[allOf 5].[allOf 2].descriptor_address string no Set payment descriptor address on supported processors. [oneOf 6].[allOf 5].[allOf 2].descriptor_city string no Set payment descriptor city on supported processors. [oneOf 6].[allOf 5].[allOf 2].descriptor_state string no Set payment descriptor state on supported processors. [oneOf 6].[allOf 5].[allOf 2].descriptor_postal string no Set payment descriptor postal code on supported processors. [oneOf 6].[allOf 5].[allOf 2].descriptor_country string no Set payment descriptor country on supported processors. [oneOf 6].[allOf 5].[allOf 2].descriptor_mcc string no Set payment descriptor mcc on supported processors. [oneOf 6].[allOf 5].[allOf 2].descriptor_merchant_id string no Set payment descriptor merchant id on supported processors. [oneOf 6].[allOf 5].[allOf 2].descriptor_url string no Set payment descriptor url on supported processors. [oneOf 6].[allOf 5].[allOf 3].billing_method string no Recurring or installment classification for the processor. - `initial_recurring`: First transaction in a recurring sequence only. - `recurring`: Later charges in that sequence. - `installment`: Installment transactions; use `billing_number` and `billing_total` on supported processors. Which values apply depends on the processor. enum: ["initial_recurring", "recurring", "installment"] [oneOf 6].[allOf 5].[allOf 3].billing_number integer no Specify installment billing number, on supported processors. For use when `billing_method` is set to "installment". minimum: 0; maximum: 99 [oneOf 6].[allOf 5].[allOf 3].billing_total string no Specify installment billing total on supported processors. For use when `billing_method` is set to "installment". [oneOf 6].[allOf 5].[allOf 3].order_template string no Order template ID. [oneOf 6].[allOf 5].[allOf 3].order_description string no Order description. [oneOf 6].[allOf 5].[allOf 3].orderid string no Order Id. [oneOf 6].[allOf 5].[allOf 3].ipaddress string no IP address of cardholder, this field is recommended. Format: `xxx.xxx.xxx.xxx` [oneOf 6].[allOf 5].[allOf 4].first_name string no Cardholder's first name. [oneOf 6].[allOf 5].[allOf 4].last_name string no Cardholder's last name [oneOf 6].[allOf 5].[allOf 4].company string no Cardholder's company [oneOf 6].[allOf 5].[allOf 4].address1 string no Card billing address [oneOf 6].[allOf 5].[allOf 4].address2 string no Card billing address, line 2 [oneOf 6].[allOf 5].[allOf 4].city string no Card billing city [oneOf 6].[allOf 5].[allOf 4].state string no Card billing state. Format: `CC` [oneOf 6].[allOf 5].[allOf 4].zip string no Card billing zip code [oneOf 6].[allOf 5].[allOf 4].country string no Card billing country. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 6].[allOf 5].[allOf 4].phone string no Billing phone number [oneOf 6].[allOf 5].[allOf 4].fax string no Billing fax number [oneOf 6].[allOf 5].[allOf 4].email string no Billing email address format: "email" [oneOf 6].[allOf 5].[allOf 5].drivers_license_number string no Driver's license number. [oneOf 6].[allOf 5].[allOf 5].drivers_license_dob string no Driver's license date of birth. [oneOf 6].[allOf 5].[allOf 5].drivers_license_state string no The state that issued the customer's driver's license. [oneOf 6].[allOf 5].[allOf 6].shipping_firstname string no Shipping first name [oneOf 6].[allOf 5].[allOf 6].shipping_lastname string no Shipping last name [oneOf 6].[allOf 5].[allOf 6].shipping_company string no Shipping company [oneOf 6].[allOf 5].[allOf 6].shipping_address1 string no Shipping address [oneOf 6].[allOf 5].[allOf 6].shipping_address2 string no Shipping address, line 2 [oneOf 6].[allOf 5].[allOf 6].shipping_city string no Shipping city [oneOf 6].[allOf 5].[allOf 6].shipping_state string no Shipping state. Format: `CC` [oneOf 6].[allOf 5].[allOf 6].shipping_zip string no Shipping zip code [oneOf 6].[allOf 5].[allOf 6].shipping_country string no Shipping country. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 6].[allOf 5].[allOf 6].shipping_email string no Shipping email address format: "email" [oneOf 6].[allOf 5].[allOf 7].merchant_defined_field_1 string no Merchant defined field. You can pass custom information in up to 20 fields. Format: `merchant_defined_field_1=Value1`, `merchant_defined_field_2=Value2`, etc... [oneOf 6].[allOf 5].[allOf 8].customer_receipt string no If set to true, when the customer is charged, they will be sent a transaction receipt. enum: ["true", "false"] [oneOf 6].[allOf 5].[allOf 8].cardholder_auth string no Set 3D Secure condition. Value used to determine E-commerce indicator (ECI). **Required for 3D Secure transactions** enum: ["verified", "attempted"] [oneOf 6].[allOf 5].[allOf 8].cavv string no Cardholder authentication verification value. Format: `base64 encoded` **Required for 3D Secure transactions** [oneOf 6].[allOf 5].[allOf 8].xid string no Cardholder authentication transaction id. Format: `base64 encoded` **Required for 3D Secure transactions** [oneOf 6].[allOf 5].[allOf 8].three_ds_version string no 3DSecure version. **Required for 3D Secure transactions** enum: ["2.0.0", "2.2.0"] [oneOf 6].[allOf 5].[allOf 8].directory_server_id string no Directory Server Transaction ID. May be provided as part of 3DSecure 2.0 authentication. Format: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` [oneOf 6].[allOf 5].[allOf 8].source_transaction_id string no Specifies a payment gateway transaction id in order to associate payment information with a Subscription or Customer Vault record. Must be set with a 'recurring' or 'customer_vault' action. [oneOf 6].[allOf 5].[allOf 8].pinless_debit_override string no Set to 'Y' if you have Pinless Debit Conversion enabled but want to opt out for this transaction. Feature applies to selected processors only. [oneOf 6].[allOf 5].[allOf 9].recurring string no **Recurring Field:** Recurring action to be processed. enum: ["add_subscription"] [oneOf 6].[allOf 5].[allOf 9].plan_id string no **Recurring Field:** Create a subscription tied to a Plan ID if the sale/auth transaction is successful. Required when **recurring** variable is set to `add_subscription` [oneOf 6].[allOf 5].[allOf 9].plan_payments integer no **Recurring Field:** The number of payments before the recurring plan is complete. Note: Use '0' for until canceled Required when **recurring** variable is set to `add_subscription` [oneOf 6].[allOf 5].[allOf 9].plan_amount number no **Recurring Field:** The plan amount to be charged each billing cycle. Format: `x.xx` Required when **recurring** variable is set to `add_subscription` [oneOf 6].[allOf 5].[allOf 9].month_frequency integer no **Recurring Field:** How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'. Required when **recurring** variable is set to `add_subscription` minimum: 1; maximum: 24 [oneOf 6].[allOf 5].[allOf 9].day_of_month integer no **Recurring Field:** The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'. For months without 29, 30, or 31 days, the charge will be on the last day Required when **recurring** variable is set to `add_subscription` minimum: 1; maximum: 31 [oneOf 6].[allOf 5].[allOf 9].day_frequency integer no **Recurring Field:** How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'. Required when **recurring** variable is set to `add_subscription` [oneOf 6].[allOf 5].[allOf 9].start_date string no **Recurring Field:** The first day that the customer will be charged. Format: `YYYYMMDD` Required when **recurring** variable is set to `add_subscription` format: "date" [oneOf 6].[allOf 5].[allOf 10].customer_vault string no Associate payment information with a Customer Vault record if the transaction is successful. enum: ["add_customer", "update_customer"] [oneOf 6].[allOf 5].[allOf 10].customer_vault_id string no Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id. [oneOf 6].[allOf 5].[allOf 11].initiated_by string no **Stored Credentials (CIT/MIT):** Who initiated the transaction. enum: ["customer", "merchant"] [oneOf 6].[allOf 5].[allOf 11].initial_transaction_id string no **Stored Credentials (CIT/MIT):** Original payment gateway transaction id. [oneOf 6].[allOf 5].[allOf 11].stored_credential_indicator string no **Stored Credentials (CIT/MIT):** The indicator of the stored credential. Use **'stored'** when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system. Use **'used'** when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method. enum: ["stored", "used"] [oneOf 6].[allOf 5].[allOf 12].shipping number no **Level II/III - Order Field:** Freight or shipping amount included in the transaction amount. Default - `0.00`. Format: `x.xx` [oneOf 6].[allOf 5].[allOf 12].tax number no **Level II/III - Order Field:** The sales tax, included in the transaction amount, associated with the purchase. Setting tax equal to '-1' indicates an order that is exempt from sales tax. Default - `0.00`. Format: `x.xx` [oneOf 6].[allOf 5].[allOf 12].ponumber string no **Level II/III - Order Field:** Purchase order number [oneOf 6].[allOf 5].[allOf 12].orderid string no **Level III - Order Field:** Identifier assigned by the merchant. This defaults to gateway transaction id. [oneOf 6].[allOf 5].[allOf 12].shipping_country string no **Level III - Order Field:** Shipping country (e.g. US). Format: `CC` - ISO 3166-1 alpha-2 [oneOf 6].[allOf 5].[allOf 12].shipping_postal string no **Level III - Order Field:** Postal/ZIP code of the address where purchased goods will be delivered. This field can be identical to the 'ship_from_postal' if the customer is present and takes immediate possession of the goods. [oneOf 6].[allOf 5].[allOf 12].ship_from_postal string no **Level III - Order Field:** Postal/ZIP code of the address from where purchased goods are being shipped, defaults to merchant profile postal code. [oneOf 6].[allOf 5].[allOf 12].summary_commodity_code string no **Level III - Order Field:** 4 character international description code of the overall goods or services being supplied. The acquirer or processor will provide a list of current codes. [oneOf 6].[allOf 5].[allOf 12].duty_amount number no **Level III - Order Field:** Amount included in the transaction amount associated with the import of purchased goods. Default - `0.00`. Format: `x.xx` [oneOf 6].[allOf 5].[allOf 12].discount_amount number no **Level III - Order Field:** Amount included in the transaction amount of any discount applied to complete order by the merchant. Default - `0.00`. Format: `x.xx` [oneOf 6].[allOf 5].[allOf 12].national_tax_amount number no **Level III - Order Field:** The national tax amount included in the transaction amount. Default - `0.00`. Format: `x.xx` [oneOf 6].[allOf 5].[allOf 12].alternate_tax_amount number no **Level III - Order Field:** Second tax amount included in the transaction amount in countries where more than one type of tax can be applied to the purchases. Default - `0.00`. Format: `x.xx` [oneOf 6].[allOf 5].[allOf 12].alternate_tax_id string no **Level III - Order Field:** Tax identification number of the merchant that reported the alternate tax amount. [oneOf 6].[allOf 5].[allOf 12].vat_tax_amount number no **Level III - Order Field:** Contains the amount of any value added taxes which can be associated with the purchased item. Default - `0.00`. Format: `x.xx` [oneOf 6].[allOf 5].[allOf 12].vat_tax_rate number no **Level III - Order Field:** Contains the tax rate used to calculate the sales tax amount appearing. Can contain up to 2 decimal places, e.g. 1% = 1.00. Default - `0.00`. Format: `x.xx` [oneOf 6].[allOf 5].[allOf 12].vat_invoice_reference_number string no **Level III - Order Field:** Invoice number that is associated with the VAT invoice. [oneOf 6].[allOf 5].[allOf 12].customer_vat_registration string no **Level III - Order Field:** Value added tax registration number supplied by the cardholder. [oneOf 6].[allOf 5].[allOf 12].merchant_vat_registration string no **Level III - Order Field:** Government assigned tax identification number of the merchant for whom the goods or services were purchased from. [oneOf 6].[allOf 5].[allOf 12].order_date string no **Level III - Order Field:** Purchase order date, defaults to the date of the transaction. Format: `YYMMDD` format: "date" [oneOf 6].[allOf 5].[allOf 13].item_product_code_1 string no **Level III - Line Item:** Merchant defined description code of the item being purchased. *Up to 99 sets of item_* fields are allowed.* [oneOf 6].[allOf 5].[allOf 13].item_description_1 string no **Level III - Line Item:** Description of the item(s) being supplied. [oneOf 6].[allOf 5].[allOf 13].item_commodity_code_1 string no **Level III - Line Item:** International description code of the individual good or service being supplied. The acquirer or processor will provide a list of current codes. [oneOf 6].[allOf 5].[allOf 13].item_unit_of_measure_1 string no **Level III - Line Item:** Code for units of measurement as used in international trade. Default - `EACH`. [oneOf 6].[allOf 5].[allOf 13].item_unit_cost_1 number no **Level III - Line Item:** Unit cost of item purchased, may contain up to 4 decimal places. [oneOf 6].[allOf 5].[allOf 13].item_quantity_1 integer no **Level III - Line Item:** Quantity of the item(s) being purchased. Default - `1`. [oneOf 6].[allOf 5].[allOf 13].item_total_amount_1 number no **Level III - Line Item:** Purchase amount associated with the item. Defaults to: 'item_unit_cost_#' x 'item_quantity_#' rounded to the nearest penny. [oneOf 6].[allOf 5].[allOf 13].item_tax_amount_1 number no **Level III - Line Item:** Amount of sales tax on specific item. Amount should not be included in 'total_amount_#'. Default - `0.00`. Format: `x.xx` [oneOf 6].[allOf 5].[allOf 13].item_tax_rate_1 number no **Level III - Line Item:** Percentage representing the value-added tax applied. Default - `0.00`. Format: `x.xx` [oneOf 6].[allOf 5].[allOf 13].item_discount_amount_1 number no **Level III - Line Item:** Discount amount which can have been applied by the merchant on the sale of the specific item. Amount should not be included in 'total_amount_#'. [oneOf 6].[allOf 5].[allOf 13].item_discount_rate_1 number no **Level III - Line Item:** Discount rate for the line item. Default - `0.00`. Format: `x.xx` [oneOf 6].[allOf 5].[allOf 13].item_tax_type_1 string no **Level III - Line Item:** Type of value-added taxes that are being used. [oneOf 6].[allOf 5].[allOf 13].item_alternate_tax_id_1 string no **Level III - Line Item:** Tax identification number of the merchant that reported the alternate tax amount. [oneOf 6].[allOf 5].[allOf 14].payment_facilitator_id string no **Payment Facilitator:** Payment Facilitator/Aggregator/ISO's ID Number [oneOf 6].[allOf 5].[allOf 14].submerchant_id string no **Payment Facilitator:** Sub-merchant Account ID [oneOf 6].[allOf 5].[allOf 14].submerchant_name string no **Payment Facilitator:** Sub-merchant's Name [oneOf 6].[allOf 5].[allOf 14].submerchant_address string no **Payment Facilitator:** Sub-merchant's Address [oneOf 6].[allOf 5].[allOf 14].submerchant_city string no **Payment Facilitator:** Sub-merchant's City [oneOf 6].[allOf 5].[allOf 14].submerchant_state string no **Payment Facilitator:** Sub-merchant's State [oneOf 6].[allOf 5].[allOf 14].submerchant_postal string no **Payment Facilitator:** Sub-merchant's Zip/Postal Code [oneOf 6].[allOf 5].[allOf 14].submerchant_country string no **Payment Facilitator:** Sub-merchant's Country [oneOf 6].[allOf 5].[allOf 14].submerchant_phone string no **Payment Facilitator:** Sub-merchant's Phone Number [oneOf 6].[allOf 5].[allOf 14].submerchant_email string no **Payment Facilitator:** Sub-merchant's Email Address format: "email" [oneOf 6].[allOf 6].industry string no The industry parameter is supported across multiple transaction types. Its purpose is to identify the merchant industry type for processing enum: ["ecommerce", "moto", "retail", "restaurant", "lodging"] [oneOf 6].[allOf 7].signature_image string no Cardholder signature image. Format: `base64 encoded raw PNG image. (16kiB maximum)` [oneOf 7].[allOf 1].security_key string yes API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys [oneOf 7].[allOf 1].type string yes Will complete a `payment_in_full` transaction that has not been collected in full. This allows industries that require `payment_in_full` but subsequently decide to still settle the transaction even though it has not been collected in full. enum: ["complete_partial_payment"] [oneOf 7].[allOf 1].partial_payments string yes `payment_in_full`: Required that any split tendered transaction is collected in-full before settlement gets initiated. enum: ["payment_in_full"] [oneOf 7].[allOf 3].partial_payment_id string no Unique identifier returned when making the original transaction. This should only be used for secondary transactions. [oneOf 7].[allOf 4].[allOf 1].ccnumber string no Credit card number. <details> <summary>Allowed Card Numbers:</summary> | Card Type | Test Card Number | |:------------------|:---------------------| | Visa | 4111111111111111 | | MasterCard | 5431111111111111 | | Discover | 6011000991300009 | | American Express | 341111111111111 | | Diner's Club | 30205252489926 | | JCB | 3541963594572595 | | Maestro | 6799990100000000019 | </details> enum: ["4111111111111111", "5431111111111111", "6011000991300009", "341111111111111", "30205252489926", "3541963594572595", "6799990100000000019"] [oneOf 7].[allOf 4].[allOf 1].ccexp string no Credit card expiration date. Format: `MMYY` [oneOf 7].[allOf 4].[allOf 2].cvv string no The card security code. While this is not required, it is strongly recommended. [oneOf 7].[allOf 5].amount string no Total amount to be charged. Format: `x.xx` [oneOf 7].[allOf 6].[allOf 1].payment_token string no The tokenized version of the customer's card or check information, generated by the [Payment Component](../docs/payment-component) (npm packages / [Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology)) and usable only once. Existing integrations may also supply a token from [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology). [oneOf 7].[allOf 6].[allOf 1].transaction_session_id string no A single use session ID used by Kount to link the transaction and Data Collector information together. * Should be generated every time a payment form is loaded by the cardholder. * Should be random/unpredictable (do not use sequential IDs). * Should not be reused within a 30 day period. This can be used with [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology) or the Payment API when using the [Kount DDC with Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology). Format: `alphanumeric` minLength: 32; maxLength: 32 [oneOf 7].[allOf 6].[allOf 1].applepay_payment_data string no The encrypted token created when integration directly to the Apple Pay SDK. [oneOf 7].[allOf 6].[allOf 1].googlepay_payment_data string no The encrypted token created when [integration directly to the Google Pay SDK](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#googlepay_variables). [oneOf 7].[allOf 6].[allOf 1].surcharge string no Surcharge amount. Format: `x.xx` [oneOf 7].[allOf 6].[allOf 1].convenience_fee string no Convenience fee amount. Format: `x.xx` [oneOf 7].[allOf 6].[allOf 1].misc_fee string no Miscellaneous fee amount. Format: `x.xx` [oneOf 7].[allOf 6].[allOf 1].misc_fee_name string no Custom miscellaneous fee name. Default: `Miscellaneous Fee` [oneOf 7].[allOf 6].[allOf 1].tip number no The final tip amount, included in the transaction, associated with the purchase. Format: `x.xx` [oneOf 7].[allOf 6].[allOf 1].currency string no The transaction currency. Format: `ISO 4217` [oneOf 7].[allOf 6].[allOf 1].processor_id string no If using Multiple MIDs, route to this processor (*processor_id* is obtained under Settings → Transaction Routing in the Control Panel). [oneOf 7].[allOf 6].[allOf 1].dup_seconds integer no Sets the time in seconds for duplicate transaction checking on supported processors. Set to *0* to disable duplicate checking. maximum: 7862400 [oneOf 7].[allOf 6].[allOf 2].descriptor string no Set payment descriptor on supported processors. [oneOf 7].[allOf 6].[allOf 2].descriptor_phone string no Set payment descriptor phone on supported processors. [oneOf 7].[allOf 6].[allOf 2].descriptor_address string no Set payment descriptor address on supported processors. [oneOf 7].[allOf 6].[allOf 2].descriptor_city string no Set payment descriptor city on supported processors. [oneOf 7].[allOf 6].[allOf 2].descriptor_state string no Set payment descriptor state on supported processors. [oneOf 7].[allOf 6].[allOf 2].descriptor_postal string no Set payment descriptor postal code on supported processors. [oneOf 7].[allOf 6].[allOf 2].descriptor_country string no Set payment descriptor country on supported processors. [oneOf 7].[allOf 6].[allOf 2].descriptor_mcc string no Set payment descriptor mcc on supported processors. [oneOf 7].[allOf 6].[allOf 2].descriptor_merchant_id string no Set payment descriptor merchant id on supported processors. [oneOf 7].[allOf 6].[allOf 2].descriptor_url string no Set payment descriptor url on supported processors. [oneOf 7].[allOf 6].[allOf 3].billing_method string no Recurring or installment classification for the processor. - `initial_recurring`: First transaction in a recurring sequence only. - `recurring`: Later charges in that sequence. - `installment`: Installment transactions; use `billing_number` and `billing_total` on supported processors. Which values apply depends on the processor. enum: ["initial_recurring", "recurring", "installment"] [oneOf 7].[allOf 6].[allOf 3].billing_number integer no Specify installment billing number, on supported processors. For use when `billing_method` is set to "installment". minimum: 0; maximum: 99 [oneOf 7].[allOf 6].[allOf 3].billing_total string no Specify installment billing total on supported processors. For use when `billing_method` is set to "installment". [oneOf 7].[allOf 6].[allOf 3].order_template string no Order template ID. [oneOf 7].[allOf 6].[allOf 3].order_description string no Order description. [oneOf 7].[allOf 6].[allOf 3].orderid string no Order Id. [oneOf 7].[allOf 6].[allOf 3].ipaddress string no IP address of cardholder, this field is recommended. Format: `xxx.xxx.xxx.xxx` [oneOf 7].[allOf 6].[allOf 4].first_name string no Cardholder's first name. [oneOf 7].[allOf 6].[allOf 4].last_name string no Cardholder's last name [oneOf 7].[allOf 6].[allOf 4].company string no Cardholder's company [oneOf 7].[allOf 6].[allOf 4].address1 string no Card billing address [oneOf 7].[allOf 6].[allOf 4].address2 string no Card billing address, line 2 [oneOf 7].[allOf 6].[allOf 4].city string no Card billing city [oneOf 7].[allOf 6].[allOf 4].state string no Card billing state. Format: `CC` [oneOf 7].[allOf 6].[allOf 4].zip string no Card billing zip code [oneOf 7].[allOf 6].[allOf 4].country string no Card billing country. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 7].[allOf 6].[allOf 4].phone string no Billing phone number [oneOf 7].[allOf 6].[allOf 4].fax string no Billing fax number [oneOf 7].[allOf 6].[allOf 4].email string no Billing email address format: "email" [oneOf 7].[allOf 6].[allOf 5].drivers_license_number string no Driver's license number. [oneOf 7].[allOf 6].[allOf 5].drivers_license_dob string no Driver's license date of birth. [oneOf 7].[allOf 6].[allOf 5].drivers_license_state string no The state that issued the customer's driver's license. [oneOf 7].[allOf 6].[allOf 6].shipping_firstname string no Shipping first name [oneOf 7].[allOf 6].[allOf 6].shipping_lastname string no Shipping last name [oneOf 7].[allOf 6].[allOf 6].shipping_company string no Shipping company [oneOf 7].[allOf 6].[allOf 6].shipping_address1 string no Shipping address [oneOf 7].[allOf 6].[allOf 6].shipping_address2 string no Shipping address, line 2 [oneOf 7].[allOf 6].[allOf 6].shipping_city string no Shipping city [oneOf 7].[allOf 6].[allOf 6].shipping_state string no Shipping state. Format: `CC` [oneOf 7].[allOf 6].[allOf 6].shipping_zip string no Shipping zip code [oneOf 7].[allOf 6].[allOf 6].shipping_country string no Shipping country. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 7].[allOf 6].[allOf 6].shipping_email string no Shipping email address format: "email" [oneOf 7].[allOf 6].[allOf 7].merchant_defined_field_1 string no Merchant defined field. You can pass custom information in up to 20 fields. Format: `merchant_defined_field_1=Value1`, `merchant_defined_field_2=Value2`, etc... [oneOf 7].[allOf 6].[allOf 8].customer_receipt string no If set to true, when the customer is charged, they will be sent a transaction receipt. enum: ["true", "false"] [oneOf 7].[allOf 6].[allOf 8].cardholder_auth string no Set 3D Secure condition. Value used to determine E-commerce indicator (ECI). **Required for 3D Secure transactions** enum: ["verified", "attempted"] [oneOf 7].[allOf 6].[allOf 8].cavv string no Cardholder authentication verification value. Format: `base64 encoded` **Required for 3D Secure transactions** [oneOf 7].[allOf 6].[allOf 8].xid string no Cardholder authentication transaction id. Format: `base64 encoded` **Required for 3D Secure transactions** [oneOf 7].[allOf 6].[allOf 8].three_ds_version string no 3DSecure version. **Required for 3D Secure transactions** enum: ["2.0.0", "2.2.0"] [oneOf 7].[allOf 6].[allOf 8].directory_server_id string no Directory Server Transaction ID. May be provided as part of 3DSecure 2.0 authentication. Format: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` [oneOf 7].[allOf 6].[allOf 8].source_transaction_id string no Specifies a payment gateway transaction id in order to associate payment information with a Subscription or Customer Vault record. Must be set with a 'recurring' or 'customer_vault' action. [oneOf 7].[allOf 6].[allOf 8].pinless_debit_override string no Set to 'Y' if you have Pinless Debit Conversion enabled but want to opt out for this transaction. Feature applies to selected processors only. [oneOf 7].[allOf 6].[allOf 9].recurring string no **Recurring Field:** Recurring action to be processed. enum: ["add_subscription"] [oneOf 7].[allOf 6].[allOf 9].plan_id string no **Recurring Field:** Create a subscription tied to a Plan ID if the sale/auth transaction is successful. Required when **recurring** variable is set to `add_subscription` [oneOf 7].[allOf 6].[allOf 9].plan_payments integer no **Recurring Field:** The number of payments before the recurring plan is complete. Note: Use '0' for until canceled Required when **recurring** variable is set to `add_subscription` [oneOf 7].[allOf 6].[allOf 9].plan_amount number no **Recurring Field:** The plan amount to be charged each billing cycle. Format: `x.xx` Required when **recurring** variable is set to `add_subscription` [oneOf 7].[allOf 6].[allOf 9].month_frequency integer no **Recurring Field:** How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'. Required when **recurring** variable is set to `add_subscription` minimum: 1; maximum: 24 [oneOf 7].[allOf 6].[allOf 9].day_of_month integer no **Recurring Field:** The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'. For months without 29, 30, or 31 days, the charge will be on the last day Required when **recurring** variable is set to `add_subscription` minimum: 1; maximum: 31 [oneOf 7].[allOf 6].[allOf 9].day_frequency integer no **Recurring Field:** How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'. Required when **recurring** variable is set to `add_subscription` [oneOf 7].[allOf 6].[allOf 9].start_date string no **Recurring Field:** The first day that the customer will be charged. Format: `YYYYMMDD` Required when **recurring** variable is set to `add_subscription` format: "date" [oneOf 7].[allOf 6].[allOf 10].customer_vault string no Associate payment information with a Customer Vault record if the transaction is successful. enum: ["add_customer", "update_customer"] [oneOf 7].[allOf 6].[allOf 10].customer_vault_id string no Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id. [oneOf 7].[allOf 6].[allOf 11].initiated_by string no **Stored Credentials (CIT/MIT):** Who initiated the transaction. enum: ["customer", "merchant"] [oneOf 7].[allOf 6].[allOf 11].initial_transaction_id string no **Stored Credentials (CIT/MIT):** Original payment gateway transaction id. [oneOf 7].[allOf 6].[allOf 11].stored_credential_indicator string no **Stored Credentials (CIT/MIT):** The indicator of the stored credential. Use **'stored'** when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system. Use **'used'** when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method. enum: ["stored", "used"] [oneOf 7].[allOf 6].[allOf 12].shipping number no **Level II/III - Order Field:** Freight or shipping amount included in the transaction amount. Default - `0.00`. Format: `x.xx` [oneOf 7].[allOf 6].[allOf 12].tax number no **Level II/III - Order Field:** The sales tax, included in the transaction amount, associated with the purchase. Setting tax equal to '-1' indicates an order that is exempt from sales tax. Default - `0.00`. Format: `x.xx` [oneOf 7].[allOf 6].[allOf 12].ponumber string no **Level II/III - Order Field:** Purchase order number [oneOf 7].[allOf 6].[allOf 12].orderid string no **Level III - Order Field:** Identifier assigned by the merchant. This defaults to gateway transaction id. [oneOf 7].[allOf 6].[allOf 12].shipping_country string no **Level III - Order Field:** Shipping country (e.g. US). Format: `CC` - ISO 3166-1 alpha-2 [oneOf 7].[allOf 6].[allOf 12].shipping_postal string no **Level III - Order Field:** Postal/ZIP code of the address where purchased goods will be delivered. This field can be identical to the 'ship_from_postal' if the customer is present and takes immediate possession of the goods. [oneOf 7].[allOf 6].[allOf 12].ship_from_postal string no **Level III - Order Field:** Postal/ZIP code of the address from where purchased goods are being shipped, defaults to merchant profile postal code. [oneOf 7].[allOf 6].[allOf 12].summary_commodity_code string no **Level III - Order Field:** 4 character international description code of the overall goods or services being supplied. The acquirer or processor will provide a list of current codes. [oneOf 7].[allOf 6].[allOf 12].duty_amount number no **Level III - Order Field:** Amount included in the transaction amount associated with the import of purchased goods. Default - `0.00`. Format: `x.xx` [oneOf 7].[allOf 6].[allOf 12].discount_amount number no **Level III - Order Field:** Amount included in the transaction amount of any discount applied to complete order by the merchant. Default - `0.00`. Format: `x.xx` [oneOf 7].[allOf 6].[allOf 12].national_tax_amount number no **Level III - Order Field:** The national tax amount included in the transaction amount. Default - `0.00`. Format: `x.xx` [oneOf 7].[allOf 6].[allOf 12].alternate_tax_amount number no **Level III - Order Field:** Second tax amount included in the transaction amount in countries where more than one type of tax can be applied to the purchases. Default - `0.00`. Format: `x.xx` [oneOf 7].[allOf 6].[allOf 12].alternate_tax_id string no **Level III - Order Field:** Tax identification number of the merchant that reported the alternate tax amount. [oneOf 7].[allOf 6].[allOf 12].vat_tax_amount number no **Level III - Order Field:** Contains the amount of any value added taxes which can be associated with the purchased item. Default - `0.00`. Format: `x.xx` [oneOf 7].[allOf 6].[allOf 12].vat_tax_rate number no **Level III - Order Field:** Contains the tax rate used to calculate the sales tax amount appearing. Can contain up to 2 decimal places, e.g. 1% = 1.00. Default - `0.00`. Format: `x.xx` [oneOf 7].[allOf 6].[allOf 12].vat_invoice_reference_number string no **Level III - Order Field:** Invoice number that is associated with the VAT invoice. [oneOf 7].[allOf 6].[allOf 12].customer_vat_registration string no **Level III - Order Field:** Value added tax registration number supplied by the cardholder. [oneOf 7].[allOf 6].[allOf 12].merchant_vat_registration string no **Level III - Order Field:** Government assigned tax identification number of the merchant for whom the goods or services were purchased from. [oneOf 7].[allOf 6].[allOf 12].order_date string no **Level III - Order Field:** Purchase order date, defaults to the date of the transaction. Format: `YYMMDD` format: "date" [oneOf 7].[allOf 6].[allOf 13].item_product_code_1 string no **Level III - Line Item:** Merchant defined description code of the item being purchased. *Up to 99 sets of item_* fields are allowed.* [oneOf 7].[allOf 6].[allOf 13].item_description_1 string no **Level III - Line Item:** Description of the item(s) being supplied. [oneOf 7].[allOf 6].[allOf 13].item_commodity_code_1 string no **Level III - Line Item:** International description code of the individual good or service being supplied. The acquirer or processor will provide a list of current codes. [oneOf 7].[allOf 6].[allOf 13].item_unit_of_measure_1 string no **Level III - Line Item:** Code for units of measurement as used in international trade. Default - `EACH`. [oneOf 7].[allOf 6].[allOf 13].item_unit_cost_1 number no **Level III - Line Item:** Unit cost of item purchased, may contain up to 4 decimal places. [oneOf 7].[allOf 6].[allOf 13].item_quantity_1 integer no **Level III - Line Item:** Quantity of the item(s) being purchased. Default - `1`. [oneOf 7].[allOf 6].[allOf 13].item_total_amount_1 number no **Level III - Line Item:** Purchase amount associated with the item. Defaults to: 'item_unit_cost_#' x 'item_quantity_#' rounded to the nearest penny. [oneOf 7].[allOf 6].[allOf 13].item_tax_amount_1 number no **Level III - Line Item:** Amount of sales tax on specific item. Amount should not be included in 'total_amount_#'. Default - `0.00`. Format: `x.xx` [oneOf 7].[allOf 6].[allOf 13].item_tax_rate_1 number no **Level III - Line Item:** Percentage representing the value-added tax applied. Default - `0.00`. Format: `x.xx` [oneOf 7].[allOf 6].[allOf 13].item_discount_amount_1 number no **Level III - Line Item:** Discount amount which can have been applied by the merchant on the sale of the specific item. Amount should not be included in 'total_amount_#'. [oneOf 7].[allOf 6].[allOf 13].item_discount_rate_1 number no **Level III - Line Item:** Discount rate for the line item. Default - `0.00`. Format: `x.xx` [oneOf 7].[allOf 6].[allOf 13].item_tax_type_1 string no **Level III - Line Item:** Type of value-added taxes that are being used. [oneOf 7].[allOf 6].[allOf 13].item_alternate_tax_id_1 string no **Level III - Line Item:** Tax identification number of the merchant that reported the alternate tax amount. [oneOf 7].[allOf 6].[allOf 14].payment_facilitator_id string no **Payment Facilitator:** Payment Facilitator/Aggregator/ISO's ID Number [oneOf 7].[allOf 6].[allOf 14].submerchant_id string no **Payment Facilitator:** Sub-merchant Account ID [oneOf 7].[allOf 6].[allOf 14].submerchant_name string no **Payment Facilitator:** Sub-merchant's Name [oneOf 7].[allOf 6].[allOf 14].submerchant_address string no **Payment Facilitator:** Sub-merchant's Address [oneOf 7].[allOf 6].[allOf 14].submerchant_city string no **Payment Facilitator:** Sub-merchant's City [oneOf 7].[allOf 6].[allOf 14].submerchant_state string no **Payment Facilitator:** Sub-merchant's State [oneOf 7].[allOf 6].[allOf 14].submerchant_postal string no **Payment Facilitator:** Sub-merchant's Zip/Postal Code [oneOf 7].[allOf 6].[allOf 14].submerchant_country string no **Payment Facilitator:** Sub-merchant's Country [oneOf 7].[allOf 6].[allOf 14].submerchant_phone string no **Payment Facilitator:** Sub-merchant's Phone Number [oneOf 7].[allOf 6].[allOf 14].submerchant_email string no **Payment Facilitator:** Sub-merchant's Email Address format: "email" [oneOf 7].[allOf 7].industry string no The industry parameter is supported across multiple transaction types. Its purpose is to identify the merchant industry type for processing enum: ["ecommerce", "moto", "retail", "restaurant", "lodging"] [oneOf 7].[allOf 8].signature_image string no Cardholder signature image. Format: `base64 encoded raw PNG image. (16kiB maximum)` [oneOf 8].[allOf 1].security_key string yes API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys [oneOf 8].[allOf 1].type string yes The type of transaction to be processed. enum: ["void"] [oneOf 8].[allOf 1].transactionid string yes Original payment gateway transaction id. [oneOf 8].[allOf 1].payment string no **Required for ACH** The type of payment. Default - `creditcard`. enum: ["check", "creditcard"] [oneOf 8].[allOf 1].void_reason string no **Conditionally Required** if Transaction is EMV. Reason the EMV transaction is being voided. enum: ["fraud", "user_cancel", "icc_rejected", "icc_card_removed", "icc_no_confirmation", "pos_timeout"] [oneOf 9].[allOf 1].security_key string yes API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys [oneOf 9].[allOf 1].type string yes The type of transaction to be processed. enum: ["refund"] [oneOf 9].[allOf 1].transactionid string yes Original payment gateway transaction id. [oneOf 9].[allOf 1].payment string no **Required for ACH** The type of payment. Default - `creditcard`. enum: ["check", "creditcard"] [oneOf 9].[allOf 2].amount string no Total amount to be refunded. This amount may be equal to or less than the settled amount. Setting the amount to `0.00` will refund the entire amount. Format: `x.xx` [oneOf 10].[allOf 1].security_key string yes API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys [oneOf 10].[allOf 1].type string yes The type of transaction to be processed. enum: ["sale"] [oneOf 10].[allOf 1].payment string yes The type of payment. enum: ["check"] [oneOf 10].[allOf 3].checkname string no The name on the customer's ACH account. [oneOf 10].[allOf 3].checkaba string no The customer's bank routing number. minLength: 9; maxLength: 9 [oneOf 10].[allOf 3].checkaccount string no The customer's bank account number. [oneOf 10].[allOf 3].account_holder_type string no The type of ACH account the customer has. enum: ["business", "personal"] [oneOf 10].[allOf 3].account_type string no The type of ACH account the customer has. enum: ["checking", "savings"] [oneOf 10].[allOf 3].sec_code string no The Standard Entry Class code of the ACH transaction. enum: ["PPD", "WEB", "TEL", "CCD"] [oneOf 10].[allOf 4].amount string no Total amount to be charged. Format: `x.xx` [oneOf 10].[allOf 5].[allOf 1].payment_token string no The tokenized version of the customer's card or check information, generated by the [Payment Component](../docs/payment-component) (npm packages / [Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology)) and usable only once. Existing integrations may also supply a token from [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology). [oneOf 10].[allOf 5].[allOf 1].transaction_session_id string no A single use session ID used by Kount to link the transaction and Data Collector information together. * Should be generated every time a payment form is loaded by the cardholder. * Should be random/unpredictable (do not use sequential IDs). * Should not be reused within a 30 day period. This can be used with [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology) or the Payment API when using the [Kount DDC with Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology). Format: `alphanumeric` minLength: 32; maxLength: 32 [oneOf 10].[allOf 5].[allOf 1].applepay_payment_data string no The encrypted token created when integration directly to the Apple Pay SDK. [oneOf 10].[allOf 5].[allOf 1].googlepay_payment_data string no The encrypted token created when [integration directly to the Google Pay SDK](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#googlepay_variables). [oneOf 10].[allOf 5].[allOf 1].surcharge string no Surcharge amount. Format: `x.xx` [oneOf 10].[allOf 5].[allOf 1].convenience_fee string no Convenience fee amount. Format: `x.xx` [oneOf 10].[allOf 5].[allOf 1].misc_fee string no Miscellaneous fee amount. Format: `x.xx` [oneOf 10].[allOf 5].[allOf 1].misc_fee_name string no Custom miscellaneous fee name. Default: `Miscellaneous Fee` [oneOf 10].[allOf 5].[allOf 1].tip number no The final tip amount, included in the transaction, associated with the purchase. Format: `x.xx` [oneOf 10].[allOf 5].[allOf 1].currency string no The transaction currency. Format: `ISO 4217` [oneOf 10].[allOf 5].[allOf 1].processor_id string no If using Multiple MIDs, route to this processor (*processor_id* is obtained under Settings → Transaction Routing in the Control Panel). [oneOf 10].[allOf 5].[allOf 1].dup_seconds integer no Sets the time in seconds for duplicate transaction checking on supported processors. Set to *0* to disable duplicate checking. maximum: 7862400 [oneOf 10].[allOf 5].[allOf 2].descriptor string no Set payment descriptor on supported processors. [oneOf 10].[allOf 5].[allOf 2].descriptor_phone string no Set payment descriptor phone on supported processors. [oneOf 10].[allOf 5].[allOf 2].descriptor_address string no Set payment descriptor address on supported processors. [oneOf 10].[allOf 5].[allOf 2].descriptor_city string no Set payment descriptor city on supported processors. [oneOf 10].[allOf 5].[allOf 2].descriptor_state string no Set payment descriptor state on supported processors. [oneOf 10].[allOf 5].[allOf 2].descriptor_postal string no Set payment descriptor postal code on supported processors. [oneOf 10].[allOf 5].[allOf 2].descriptor_country string no Set payment descriptor country on supported processors. [oneOf 10].[allOf 5].[allOf 2].descriptor_mcc string no Set payment descriptor mcc on supported processors. [oneOf 10].[allOf 5].[allOf 2].descriptor_merchant_id string no Set payment descriptor merchant id on supported processors. [oneOf 10].[allOf 5].[allOf 2].descriptor_url string no Set payment descriptor url on supported processors. [oneOf 10].[allOf 5].[allOf 3].billing_method string no Recurring or installment classification for the processor. - `initial_recurring`: First transaction in a recurring sequence only. - `recurring`: Later charges in that sequence. - `installment`: Installment transactions; use `billing_number` and `billing_total` on supported processors. Which values apply depends on the processor. enum: ["initial_recurring", "recurring", "installment"] [oneOf 10].[allOf 5].[allOf 3].billing_number integer no Specify installment billing number, on supported processors. For use when `billing_method` is set to "installment". minimum: 0; maximum: 99 [oneOf 10].[allOf 5].[allOf 3].billing_total string no Specify installment billing total on supported processors. For use when `billing_method` is set to "installment". [oneOf 10].[allOf 5].[allOf 3].order_template string no Order template ID. [oneOf 10].[allOf 5].[allOf 3].order_description string no Order description. [oneOf 10].[allOf 5].[allOf 3].orderid string no Order Id. [oneOf 10].[allOf 5].[allOf 3].ipaddress string no IP address of cardholder, this field is recommended. Format: `xxx.xxx.xxx.xxx` [oneOf 10].[allOf 5].[allOf 4].first_name string no Cardholder's first name. [oneOf 10].[allOf 5].[allOf 4].last_name string no Cardholder's last name [oneOf 10].[allOf 5].[allOf 4].company string no Cardholder's company [oneOf 10].[allOf 5].[allOf 4].address1 string no Card billing address [oneOf 10].[allOf 5].[allOf 4].address2 string no Card billing address, line 2 [oneOf 10].[allOf 5].[allOf 4].city string no Card billing city [oneOf 10].[allOf 5].[allOf 4].state string no Card billing state. Format: `CC` [oneOf 10].[allOf 5].[allOf 4].zip string no Card billing zip code [oneOf 10].[allOf 5].[allOf 4].country string no Card billing country. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 10].[allOf 5].[allOf 4].phone string no Billing phone number [oneOf 10].[allOf 5].[allOf 4].fax string no Billing fax number [oneOf 10].[allOf 5].[allOf 4].email string no Billing email address format: "email" [oneOf 10].[allOf 5].[allOf 5].drivers_license_number string no Driver's license number. [oneOf 10].[allOf 5].[allOf 5].drivers_license_dob string no Driver's license date of birth. [oneOf 10].[allOf 5].[allOf 5].drivers_license_state string no The state that issued the customer's driver's license. [oneOf 10].[allOf 5].[allOf 6].shipping_firstname string no Shipping first name [oneOf 10].[allOf 5].[allOf 6].shipping_lastname string no Shipping last name [oneOf 10].[allOf 5].[allOf 6].shipping_company string no Shipping company [oneOf 10].[allOf 5].[allOf 6].shipping_address1 string no Shipping address [oneOf 10].[allOf 5].[allOf 6].shipping_address2 string no Shipping address, line 2 [oneOf 10].[allOf 5].[allOf 6].shipping_city string no Shipping city [oneOf 10].[allOf 5].[allOf 6].shipping_state string no Shipping state. Format: `CC` [oneOf 10].[allOf 5].[allOf 6].shipping_zip string no Shipping zip code [oneOf 10].[allOf 5].[allOf 6].shipping_country string no Shipping country. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 10].[allOf 5].[allOf 6].shipping_email string no Shipping email address format: "email" [oneOf 10].[allOf 5].[allOf 7].merchant_defined_field_1 string no Merchant defined field. You can pass custom information in up to 20 fields. Format: `merchant_defined_field_1=Value1`, `merchant_defined_field_2=Value2`, etc... [oneOf 10].[allOf 5].[allOf 8].customer_receipt string no If set to true, when the customer is charged, they will be sent a transaction receipt. enum: ["true", "false"] [oneOf 10].[allOf 5].[allOf 8].cardholder_auth string no Set 3D Secure condition. Value used to determine E-commerce indicator (ECI). **Required for 3D Secure transactions** enum: ["verified", "attempted"] [oneOf 10].[allOf 5].[allOf 8].cavv string no Cardholder authentication verification value. Format: `base64 encoded` **Required for 3D Secure transactions** [oneOf 10].[allOf 5].[allOf 8].xid string no Cardholder authentication transaction id. Format: `base64 encoded` **Required for 3D Secure transactions** [oneOf 10].[allOf 5].[allOf 8].three_ds_version string no 3DSecure version. **Required for 3D Secure transactions** enum: ["2.0.0", "2.2.0"] [oneOf 10].[allOf 5].[allOf 8].directory_server_id string no Directory Server Transaction ID. May be provided as part of 3DSecure 2.0 authentication. Format: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` [oneOf 10].[allOf 5].[allOf 8].source_transaction_id string no Specifies a payment gateway transaction id in order to associate payment information with a Subscription or Customer Vault record. Must be set with a 'recurring' or 'customer_vault' action. [oneOf 10].[allOf 5].[allOf 8].pinless_debit_override string no Set to 'Y' if you have Pinless Debit Conversion enabled but want to opt out for this transaction. Feature applies to selected processors only. [oneOf 10].[allOf 5].[allOf 9].recurring string no **Recurring Field:** Recurring action to be processed. enum: ["add_subscription"] [oneOf 10].[allOf 5].[allOf 9].plan_id string no **Recurring Field:** Create a subscription tied to a Plan ID if the sale/auth transaction is successful. Required when **recurring** variable is set to `add_subscription` [oneOf 10].[allOf 5].[allOf 9].plan_payments integer no **Recurring Field:** The number of payments before the recurring plan is complete. Note: Use '0' for until canceled Required when **recurring** variable is set to `add_subscription` [oneOf 10].[allOf 5].[allOf 9].plan_amount number no **Recurring Field:** The plan amount to be charged each billing cycle. Format: `x.xx` Required when **recurring** variable is set to `add_subscription` [oneOf 10].[allOf 5].[allOf 9].month_frequency integer no **Recurring Field:** How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'. Required when **recurring** variable is set to `add_subscription` minimum: 1; maximum: 24 [oneOf 10].[allOf 5].[allOf 9].day_of_month integer no **Recurring Field:** The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'. For months without 29, 30, or 31 days, the charge will be on the last day Required when **recurring** variable is set to `add_subscription` minimum: 1; maximum: 31 [oneOf 10].[allOf 5].[allOf 9].day_frequency integer no **Recurring Field:** How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'. Required when **recurring** variable is set to `add_subscription` [oneOf 10].[allOf 5].[allOf 9].start_date string no **Recurring Field:** The first day that the customer will be charged. Format: `YYYYMMDD` Required when **recurring** variable is set to `add_subscription` format: "date" [oneOf 10].[allOf 5].[allOf 10].customer_vault string no Associate payment information with a Customer Vault record if the transaction is successful. enum: ["add_customer", "update_customer"] [oneOf 10].[allOf 5].[allOf 10].customer_vault_id string no Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id. [oneOf 10].[allOf 5].[allOf 11].initiated_by string no **Stored Credentials (CIT/MIT):** Who initiated the transaction. enum: ["customer", "merchant"] [oneOf 10].[allOf 5].[allOf 11].initial_transaction_id string no **Stored Credentials (CIT/MIT):** Original payment gateway transaction id. [oneOf 10].[allOf 5].[allOf 11].stored_credential_indicator string no **Stored Credentials (CIT/MIT):** The indicator of the stored credential. Use **'stored'** when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system. Use **'used'** when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method. enum: ["stored", "used"] [oneOf 10].[allOf 5].[allOf 12].shipping number no **Level II/III - Order Field:** Freight or shipping amount included in the transaction amount. Default - `0.00`. Format: `x.xx` [oneOf 10].[allOf 5].[allOf 12].tax number no **Level II/III - Order Field:** The sales tax, included in the transaction amount, associated with the purchase. Setting tax equal to '-1' indicates an order that is exempt from sales tax. Default - `0.00`. Format: `x.xx` [oneOf 10].[allOf 5].[allOf 12].ponumber string no **Level II/III - Order Field:** Purchase order number [oneOf 10].[allOf 5].[allOf 12].orderid string no **Level III - Order Field:** Identifier assigned by the merchant. This defaults to gateway transaction id. [oneOf 10].[allOf 5].[allOf 12].shipping_country string no **Level III - Order Field:** Shipping country (e.g. US). Format: `CC` - ISO 3166-1 alpha-2 [oneOf 10].[allOf 5].[allOf 12].shipping_postal string no **Level III - Order Field:** Postal/ZIP code of the address where purchased goods will be delivered. This field can be identical to the 'ship_from_postal' if the customer is present and takes immediate possession of the goods. [oneOf 10].[allOf 5].[allOf 12].ship_from_postal string no **Level III - Order Field:** Postal/ZIP code of the address from where purchased goods are being shipped, defaults to merchant profile postal code. [oneOf 10].[allOf 5].[allOf 12].summary_commodity_code string no **Level III - Order Field:** 4 character international description code of the overall goods or services being supplied. The acquirer or processor will provide a list of current codes. [oneOf 10].[allOf 5].[allOf 12].duty_amount number no **Level III - Order Field:** Amount included in the transaction amount associated with the import of purchased goods. Default - `0.00`. Format: `x.xx` [oneOf 10].[allOf 5].[allOf 12].discount_amount number no **Level III - Order Field:** Amount included in the transaction amount of any discount applied to complete order by the merchant. Default - `0.00`. Format: `x.xx` [oneOf 10].[allOf 5].[allOf 12].national_tax_amount number no **Level III - Order Field:** The national tax amount included in the transaction amount. Default - `0.00`. Format: `x.xx` [oneOf 10].[allOf 5].[allOf 12].alternate_tax_amount number no **Level III - Order Field:** Second tax amount included in the transaction amount in countries where more than one type of tax can be applied to the purchases. Default - `0.00`. Format: `x.xx` [oneOf 10].[allOf 5].[allOf 12].alternate_tax_id string no **Level III - Order Field:** Tax identification number of the merchant that reported the alternate tax amount. [oneOf 10].[allOf 5].[allOf 12].vat_tax_amount number no **Level III - Order Field:** Contains the amount of any value added taxes which can be associated with the purchased item. Default - `0.00`. Format: `x.xx` [oneOf 10].[allOf 5].[allOf 12].vat_tax_rate number no **Level III - Order Field:** Contains the tax rate used to calculate the sales tax amount appearing. Can contain up to 2 decimal places, e.g. 1% = 1.00. Default - `0.00`. Format: `x.xx` [oneOf 10].[allOf 5].[allOf 12].vat_invoice_reference_number string no **Level III - Order Field:** Invoice number that is associated with the VAT invoice. [oneOf 10].[allOf 5].[allOf 12].customer_vat_registration string no **Level III - Order Field:** Value added tax registration number supplied by the cardholder. [oneOf 10].[allOf 5].[allOf 12].merchant_vat_registration string no **Level III - Order Field:** Government assigned tax identification number of the merchant for whom the goods or services were purchased from. [oneOf 10].[allOf 5].[allOf 12].order_date string no **Level III - Order Field:** Purchase order date, defaults to the date of the transaction. Format: `YYMMDD` format: "date" [oneOf 10].[allOf 5].[allOf 13].item_product_code_1 string no **Level III - Line Item:** Merchant defined description code of the item being purchased. *Up to 99 sets of item_* fields are allowed.* [oneOf 10].[allOf 5].[allOf 13].item_description_1 string no **Level III - Line Item:** Description of the item(s) being supplied. [oneOf 10].[allOf 5].[allOf 13].item_commodity_code_1 string no **Level III - Line Item:** International description code of the individual good or service being supplied. The acquirer or processor will provide a list of current codes. [oneOf 10].[allOf 5].[allOf 13].item_unit_of_measure_1 string no **Level III - Line Item:** Code for units of measurement as used in international trade. Default - `EACH`. [oneOf 10].[allOf 5].[allOf 13].item_unit_cost_1 number no **Level III - Line Item:** Unit cost of item purchased, may contain up to 4 decimal places. [oneOf 10].[allOf 5].[allOf 13].item_quantity_1 integer no **Level III - Line Item:** Quantity of the item(s) being purchased. Default - `1`. [oneOf 10].[allOf 5].[allOf 13].item_total_amount_1 number no **Level III - Line Item:** Purchase amount associated with the item. Defaults to: 'item_unit_cost_#' x 'item_quantity_#' rounded to the nearest penny. [oneOf 10].[allOf 5].[allOf 13].item_tax_amount_1 number no **Level III - Line Item:** Amount of sales tax on specific item. Amount should not be included in 'total_amount_#'. Default - `0.00`. Format: `x.xx` [oneOf 10].[allOf 5].[allOf 13].item_tax_rate_1 number no **Level III - Line Item:** Percentage representing the value-added tax applied. Default - `0.00`. Format: `x.xx` [oneOf 10].[allOf 5].[allOf 13].item_discount_amount_1 number no **Level III - Line Item:** Discount amount which can have been applied by the merchant on the sale of the specific item. Amount should not be included in 'total_amount_#'. [oneOf 10].[allOf 5].[allOf 13].item_discount_rate_1 number no **Level III - Line Item:** Discount rate for the line item. Default - `0.00`. Format: `x.xx` [oneOf 10].[allOf 5].[allOf 13].item_tax_type_1 string no **Level III - Line Item:** Type of value-added taxes that are being used. [oneOf 10].[allOf 5].[allOf 13].item_alternate_tax_id_1 string no **Level III - Line Item:** Tax identification number of the merchant that reported the alternate tax amount. [oneOf 10].[allOf 5].[allOf 14].payment_facilitator_id string no **Payment Facilitator:** Payment Facilitator/Aggregator/ISO's ID Number [oneOf 10].[allOf 5].[allOf 14].submerchant_id string no **Payment Facilitator:** Sub-merchant Account ID [oneOf 10].[allOf 5].[allOf 14].submerchant_name string no **Payment Facilitator:** Sub-merchant's Name [oneOf 10].[allOf 5].[allOf 14].submerchant_address string no **Payment Facilitator:** Sub-merchant's Address [oneOf 10].[allOf 5].[allOf 14].submerchant_city string no **Payment Facilitator:** Sub-merchant's City [oneOf 10].[allOf 5].[allOf 14].submerchant_state string no **Payment Facilitator:** Sub-merchant's State [oneOf 10].[allOf 5].[allOf 14].submerchant_postal string no **Payment Facilitator:** Sub-merchant's Zip/Postal Code [oneOf 10].[allOf 5].[allOf 14].submerchant_country string no **Payment Facilitator:** Sub-merchant's Country [oneOf 10].[allOf 5].[allOf 14].submerchant_phone string no **Payment Facilitator:** Sub-merchant's Phone Number [oneOf 10].[allOf 5].[allOf 14].submerchant_email string no **Payment Facilitator:** Sub-merchant's Email Address format: "email" [oneOf 10].[allOf 6].social_security_number string no Customer's social security number, checked against bad check writers database if check verification is enabled. [oneOf 10].[allOf 7].signature_image string no Cardholder signature image. Format: `base64 encoded raw PNG image. (16kiB maximum)` [oneOf 11].[allOf 1].security_key string yes API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys [oneOf 11].[allOf 1].type string yes The type of transaction to be processed. Note that credits need to be enabled. enum: ["credit"] [oneOf 11].[allOf 1].payment string yes The type of payment. enum: ["check", "cash"] [oneOf 11].[allOf 3].checkname string no The name on the customer's ACH account. [oneOf 11].[allOf 3].checkaba string no The customer's bank routing number. minLength: 9; maxLength: 9 [oneOf 11].[allOf 3].checkaccount string no The customer's bank account number. [oneOf 11].[allOf 3].account_holder_type string no The type of ACH account the customer has. enum: ["business", "personal"] [oneOf 11].[allOf 3].account_type string no The type of ACH account the customer has. enum: ["checking", "savings"] [oneOf 11].[allOf 3].sec_code string no The Standard Entry Class code of the ACH transaction. enum: ["PPD", "WEB", "TEL", "CCD"] [oneOf 11].[allOf 4].amount string no Total amount to be charged. Format: `x.xx` [oneOf 11].[allOf 5].[allOf 1].payment_token string no The tokenized version of the customer's card or check information, generated by the [Payment Component](../docs/payment-component) (npm packages / [Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology)) and usable only once. Existing integrations may also supply a token from [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology). [oneOf 11].[allOf 5].[allOf 1].transaction_session_id string no A single use session ID used by Kount to link the transaction and Data Collector information together. * Should be generated every time a payment form is loaded by the cardholder. * Should be random/unpredictable (do not use sequential IDs). * Should not be reused within a 30 day period. This can be used with [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology) or the Payment API when using the [Kount DDC with Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology). Format: `alphanumeric` minLength: 32; maxLength: 32 [oneOf 11].[allOf 5].[allOf 1].applepay_payment_data string no The encrypted token created when integration directly to the Apple Pay SDK. [oneOf 11].[allOf 5].[allOf 1].googlepay_payment_data string no The encrypted token created when [integration directly to the Google Pay SDK](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#googlepay_variables). [oneOf 11].[allOf 5].[allOf 1].surcharge string no Surcharge amount. Format: `x.xx` [oneOf 11].[allOf 5].[allOf 1].convenience_fee string no Convenience fee amount. Format: `x.xx` [oneOf 11].[allOf 5].[allOf 1].misc_fee string no Miscellaneous fee amount. Format: `x.xx` [oneOf 11].[allOf 5].[allOf 1].misc_fee_name string no Custom miscellaneous fee name. Default: `Miscellaneous Fee` [oneOf 11].[allOf 5].[allOf 1].tip number no The final tip amount, included in the transaction, associated with the purchase. Format: `x.xx` [oneOf 11].[allOf 5].[allOf 1].currency string no The transaction currency. Format: `ISO 4217` [oneOf 11].[allOf 5].[allOf 1].processor_id string no If using Multiple MIDs, route to this processor (*processor_id* is obtained under Settings → Transaction Routing in the Control Panel). [oneOf 11].[allOf 5].[allOf 1].dup_seconds integer no Sets the time in seconds for duplicate transaction checking on supported processors. Set to *0* to disable duplicate checking. maximum: 7862400 [oneOf 11].[allOf 5].[allOf 2].descriptor string no Set payment descriptor on supported processors. [oneOf 11].[allOf 5].[allOf 2].descriptor_phone string no Set payment descriptor phone on supported processors. [oneOf 11].[allOf 5].[allOf 2].descriptor_address string no Set payment descriptor address on supported processors. [oneOf 11].[allOf 5].[allOf 2].descriptor_city string no Set payment descriptor city on supported processors. [oneOf 11].[allOf 5].[allOf 2].descriptor_state string no Set payment descriptor state on supported processors. [oneOf 11].[allOf 5].[allOf 2].descriptor_postal string no Set payment descriptor postal code on supported processors. [oneOf 11].[allOf 5].[allOf 2].descriptor_country string no Set payment descriptor country on supported processors. [oneOf 11].[allOf 5].[allOf 2].descriptor_mcc string no Set payment descriptor mcc on supported processors. [oneOf 11].[allOf 5].[allOf 2].descriptor_merchant_id string no Set payment descriptor merchant id on supported processors. [oneOf 11].[allOf 5].[allOf 2].descriptor_url string no Set payment descriptor url on supported processors. [oneOf 11].[allOf 5].[allOf 3].billing_method string no Recurring or installment classification for the processor. - `initial_recurring`: First transaction in a recurring sequence only. - `recurring`: Later charges in that sequence. - `installment`: Installment transactions; use `billing_number` and `billing_total` on supported processors. Which values apply depends on the processor. enum: ["initial_recurring", "recurring", "installment"] [oneOf 11].[allOf 5].[allOf 3].billing_number integer no Specify installment billing number, on supported processors. For use when `billing_method` is set to "installment". minimum: 0; maximum: 99 [oneOf 11].[allOf 5].[allOf 3].billing_total string no Specify installment billing total on supported processors. For use when `billing_method` is set to "installment". [oneOf 11].[allOf 5].[allOf 3].order_template string no Order template ID. [oneOf 11].[allOf 5].[allOf 3].order_description string no Order description. [oneOf 11].[allOf 5].[allOf 3].orderid string no Order Id. [oneOf 11].[allOf 5].[allOf 3].ipaddress string no IP address of cardholder, this field is recommended. Format: `xxx.xxx.xxx.xxx` [oneOf 11].[allOf 5].[allOf 4].first_name string no Cardholder's first name. [oneOf 11].[allOf 5].[allOf 4].last_name string no Cardholder's last name [oneOf 11].[allOf 5].[allOf 4].company string no Cardholder's company [oneOf 11].[allOf 5].[allOf 4].address1 string no Card billing address [oneOf 11].[allOf 5].[allOf 4].address2 string no Card billing address, line 2 [oneOf 11].[allOf 5].[allOf 4].city string no Card billing city [oneOf 11].[allOf 5].[allOf 4].state string no Card billing state. Format: `CC` [oneOf 11].[allOf 5].[allOf 4].zip string no Card billing zip code [oneOf 11].[allOf 5].[allOf 4].country string no Card billing country. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 11].[allOf 5].[allOf 4].phone string no Billing phone number [oneOf 11].[allOf 5].[allOf 4].fax string no Billing fax number [oneOf 11].[allOf 5].[allOf 4].email string no Billing email address format: "email" [oneOf 11].[allOf 5].[allOf 5].drivers_license_number string no Driver's license number. [oneOf 11].[allOf 5].[allOf 5].drivers_license_dob string no Driver's license date of birth. [oneOf 11].[allOf 5].[allOf 5].drivers_license_state string no The state that issued the customer's driver's license. [oneOf 11].[allOf 5].[allOf 6].shipping_firstname string no Shipping first name [oneOf 11].[allOf 5].[allOf 6].shipping_lastname string no Shipping last name [oneOf 11].[allOf 5].[allOf 6].shipping_company string no Shipping company [oneOf 11].[allOf 5].[allOf 6].shipping_address1 string no Shipping address [oneOf 11].[allOf 5].[allOf 6].shipping_address2 string no Shipping address, line 2 [oneOf 11].[allOf 5].[allOf 6].shipping_city string no Shipping city [oneOf 11].[allOf 5].[allOf 6].shipping_state string no Shipping state. Format: `CC` [oneOf 11].[allOf 5].[allOf 6].shipping_zip string no Shipping zip code [oneOf 11].[allOf 5].[allOf 6].shipping_country string no Shipping country. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 11].[allOf 5].[allOf 6].shipping_email string no Shipping email address format: "email" [oneOf 11].[allOf 5].[allOf 7].merchant_defined_field_1 string no Merchant defined field. You can pass custom information in up to 20 fields. Format: `merchant_defined_field_1=Value1`, `merchant_defined_field_2=Value2`, etc... [oneOf 11].[allOf 5].[allOf 8].customer_receipt string no If set to true, when the customer is charged, they will be sent a transaction receipt. enum: ["true", "false"] [oneOf 11].[allOf 5].[allOf 8].cardholder_auth string no Set 3D Secure condition. Value used to determine E-commerce indicator (ECI). **Required for 3D Secure transactions** enum: ["verified", "attempted"] [oneOf 11].[allOf 5].[allOf 8].cavv string no Cardholder authentication verification value. Format: `base64 encoded` **Required for 3D Secure transactions** [oneOf 11].[allOf 5].[allOf 8].xid string no Cardholder authentication transaction id. Format: `base64 encoded` **Required for 3D Secure transactions** [oneOf 11].[allOf 5].[allOf 8].three_ds_version string no 3DSecure version. **Required for 3D Secure transactions** enum: ["2.0.0", "2.2.0"] [oneOf 11].[allOf 5].[allOf 8].directory_server_id string no Directory Server Transaction ID. May be provided as part of 3DSecure 2.0 authentication. Format: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` [oneOf 11].[allOf 5].[allOf 8].source_transaction_id string no Specifies a payment gateway transaction id in order to associate payment information with a Subscription or Customer Vault record. Must be set with a 'recurring' or 'customer_vault' action. [oneOf 11].[allOf 5].[allOf 8].pinless_debit_override string no Set to 'Y' if you have Pinless Debit Conversion enabled but want to opt out for this transaction. Feature applies to selected processors only. [oneOf 11].[allOf 5].[allOf 9].recurring string no **Recurring Field:** Recurring action to be processed. enum: ["add_subscription"] [oneOf 11].[allOf 5].[allOf 9].plan_id string no **Recurring Field:** Create a subscription tied to a Plan ID if the sale/auth transaction is successful. Required when **recurring** variable is set to `add_subscription` [oneOf 11].[allOf 5].[allOf 9].plan_payments integer no **Recurring Field:** The number of payments before the recurring plan is complete. Note: Use '0' for until canceled Required when **recurring** variable is set to `add_subscription` [oneOf 11].[allOf 5].[allOf 9].plan_amount number no **Recurring Field:** The plan amount to be charged each billing cycle. Format: `x.xx` Required when **recurring** variable is set to `add_subscription` [oneOf 11].[allOf 5].[allOf 9].month_frequency integer no **Recurring Field:** How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'. Required when **recurring** variable is set to `add_subscription` minimum: 1; maximum: 24 [oneOf 11].[allOf 5].[allOf 9].day_of_month integer no **Recurring Field:** The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'. For months without 29, 30, or 31 days, the charge will be on the last day Required when **recurring** variable is set to `add_subscription` minimum: 1; maximum: 31 [oneOf 11].[allOf 5].[allOf 9].day_frequency integer no **Recurring Field:** How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'. Required when **recurring** variable is set to `add_subscription` [oneOf 11].[allOf 5].[allOf 9].start_date string no **Recurring Field:** The first day that the customer will be charged. Format: `YYYYMMDD` Required when **recurring** variable is set to `add_subscription` format: "date" [oneOf 11].[allOf 5].[allOf 10].customer_vault string no Associate payment information with a Customer Vault record if the transaction is successful. enum: ["add_customer", "update_customer"] [oneOf 11].[allOf 5].[allOf 10].customer_vault_id string no Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id. [oneOf 11].[allOf 5].[allOf 11].initiated_by string no **Stored Credentials (CIT/MIT):** Who initiated the transaction. enum: ["customer", "merchant"] [oneOf 11].[allOf 5].[allOf 11].initial_transaction_id string no **Stored Credentials (CIT/MIT):** Original payment gateway transaction id. [oneOf 11].[allOf 5].[allOf 11].stored_credential_indicator string no **Stored Credentials (CIT/MIT):** The indicator of the stored credential. Use **'stored'** when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system. Use **'used'** when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method. enum: ["stored", "used"] [oneOf 11].[allOf 5].[allOf 12].shipping number no **Level II/III - Order Field:** Freight or shipping amount included in the transaction amount. Default - `0.00`. Format: `x.xx` [oneOf 11].[allOf 5].[allOf 12].tax number no **Level II/III - Order Field:** The sales tax, included in the transaction amount, associated with the purchase. Setting tax equal to '-1' indicates an order that is exempt from sales tax. Default - `0.00`. Format: `x.xx` [oneOf 11].[allOf 5].[allOf 12].ponumber string no **Level II/III - Order Field:** Purchase order number [oneOf 11].[allOf 5].[allOf 12].orderid string no **Level III - Order Field:** Identifier assigned by the merchant. This defaults to gateway transaction id. [oneOf 11].[allOf 5].[allOf 12].shipping_country string no **Level III - Order Field:** Shipping country (e.g. US). Format: `CC` - ISO 3166-1 alpha-2 [oneOf 11].[allOf 5].[allOf 12].shipping_postal string no **Level III - Order Field:** Postal/ZIP code of the address where purchased goods will be delivered. This field can be identical to the 'ship_from_postal' if the customer is present and takes immediate possession of the goods. [oneOf 11].[allOf 5].[allOf 12].ship_from_postal string no **Level III - Order Field:** Postal/ZIP code of the address from where purchased goods are being shipped, defaults to merchant profile postal code. [oneOf 11].[allOf 5].[allOf 12].summary_commodity_code string no **Level III - Order Field:** 4 character international description code of the overall goods or services being supplied. The acquirer or processor will provide a list of current codes. [oneOf 11].[allOf 5].[allOf 12].duty_amount number no **Level III - Order Field:** Amount included in the transaction amount associated with the import of purchased goods. Default - `0.00`. Format: `x.xx` [oneOf 11].[allOf 5].[allOf 12].discount_amount number no **Level III - Order Field:** Amount included in the transaction amount of any discount applied to complete order by the merchant. Default - `0.00`. Format: `x.xx` [oneOf 11].[allOf 5].[allOf 12].national_tax_amount number no **Level III - Order Field:** The national tax amount included in the transaction amount. Default - `0.00`. Format: `x.xx` [oneOf 11].[allOf 5].[allOf 12].alternate_tax_amount number no **Level III - Order Field:** Second tax amount included in the transaction amount in countries where more than one type of tax can be applied to the purchases. Default - `0.00`. Format: `x.xx` [oneOf 11].[allOf 5].[allOf 12].alternate_tax_id string no **Level III - Order Field:** Tax identification number of the merchant that reported the alternate tax amount. [oneOf 11].[allOf 5].[allOf 12].vat_tax_amount number no **Level III - Order Field:** Contains the amount of any value added taxes which can be associated with the purchased item. Default - `0.00`. Format: `x.xx` [oneOf 11].[allOf 5].[allOf 12].vat_tax_rate number no **Level III - Order Field:** Contains the tax rate used to calculate the sales tax amount appearing. Can contain up to 2 decimal places, e.g. 1% = 1.00. Default - `0.00`. Format: `x.xx` [oneOf 11].[allOf 5].[allOf 12].vat_invoice_reference_number string no **Level III - Order Field:** Invoice number that is associated with the VAT invoice. [oneOf 11].[allOf 5].[allOf 12].customer_vat_registration string no **Level III - Order Field:** Value added tax registration number supplied by the cardholder. [oneOf 11].[allOf 5].[allOf 12].merchant_vat_registration string no **Level III - Order Field:** Government assigned tax identification number of the merchant for whom the goods or services were purchased from. [oneOf 11].[allOf 5].[allOf 12].order_date string no **Level III - Order Field:** Purchase order date, defaults to the date of the transaction. Format: `YYMMDD` format: "date" [oneOf 11].[allOf 5].[allOf 13].item_product_code_1 string no **Level III - Line Item:** Merchant defined description code of the item being purchased. *Up to 99 sets of item_* fields are allowed.* [oneOf 11].[allOf 5].[allOf 13].item_description_1 string no **Level III - Line Item:** Description of the item(s) being supplied. [oneOf 11].[allOf 5].[allOf 13].item_commodity_code_1 string no **Level III - Line Item:** International description code of the individual good or service being supplied. The acquirer or processor will provide a list of current codes. [oneOf 11].[allOf 5].[allOf 13].item_unit_of_measure_1 string no **Level III - Line Item:** Code for units of measurement as used in international trade. Default - `EACH`. [oneOf 11].[allOf 5].[allOf 13].item_unit_cost_1 number no **Level III - Line Item:** Unit cost of item purchased, may contain up to 4 decimal places. [oneOf 11].[allOf 5].[allOf 13].item_quantity_1 integer no **Level III - Line Item:** Quantity of the item(s) being purchased. Default - `1`. [oneOf 11].[allOf 5].[allOf 13].item_total_amount_1 number no **Level III - Line Item:** Purchase amount associated with the item. Defaults to: 'item_unit_cost_#' x 'item_quantity_#' rounded to the nearest penny. [oneOf 11].[allOf 5].[allOf 13].item_tax_amount_1 number no **Level III - Line Item:** Amount of sales tax on specific item. Amount should not be included in 'total_amount_#'. Default - `0.00`. Format: `x.xx` [oneOf 11].[allOf 5].[allOf 13].item_tax_rate_1 number no **Level III - Line Item:** Percentage representing the value-added tax applied. Default - `0.00`. Format: `x.xx` [oneOf 11].[allOf 5].[allOf 13].item_discount_amount_1 number no **Level III - Line Item:** Discount amount which can have been applied by the merchant on the sale of the specific item. Amount should not be included in 'total_amount_#'. [oneOf 11].[allOf 5].[allOf 13].item_discount_rate_1 number no **Level III - Line Item:** Discount rate for the line item. Default - `0.00`. Format: `x.xx` [oneOf 11].[allOf 5].[allOf 13].item_tax_type_1 string no **Level III - Line Item:** Type of value-added taxes that are being used. [oneOf 11].[allOf 5].[allOf 13].item_alternate_tax_id_1 string no **Level III - Line Item:** Tax identification number of the merchant that reported the alternate tax amount. [oneOf 11].[allOf 5].[allOf 14].payment_facilitator_id string no **Payment Facilitator:** Payment Facilitator/Aggregator/ISO's ID Number [oneOf 11].[allOf 5].[allOf 14].submerchant_id string no **Payment Facilitator:** Sub-merchant Account ID [oneOf 11].[allOf 5].[allOf 14].submerchant_name string no **Payment Facilitator:** Sub-merchant's Name [oneOf 11].[allOf 5].[allOf 14].submerchant_address string no **Payment Facilitator:** Sub-merchant's Address [oneOf 11].[allOf 5].[allOf 14].submerchant_city string no **Payment Facilitator:** Sub-merchant's City [oneOf 11].[allOf 5].[allOf 14].submerchant_state string no **Payment Facilitator:** Sub-merchant's State [oneOf 11].[allOf 5].[allOf 14].submerchant_postal string no **Payment Facilitator:** Sub-merchant's Zip/Postal Code [oneOf 11].[allOf 5].[allOf 14].submerchant_country string no **Payment Facilitator:** Sub-merchant's Country [oneOf 11].[allOf 5].[allOf 14].submerchant_phone string no **Payment Facilitator:** Sub-merchant's Phone Number [oneOf 11].[allOf 5].[allOf 14].submerchant_email string no **Payment Facilitator:** Sub-merchant's Email Address format: "email" [oneOf 11].[allOf 6].social_security_number string no Customer's social security number, checked against bad check writers database if check verification is enabled. [oneOf 11].[allOf 7].signature_image string no Cardholder signature image. Format: `base64 encoded raw PNG image. (16kiB maximum)` [oneOf 12].[allOf 1].security_key string yes API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys [oneOf 12].[allOf 1].type string yes The type of transaction to be processed. enum: ["sale"] [oneOf 12].[allOf 1].payment string yes The type of payment. enum: ["cash"] [oneOf 12].[allOf 3].amount string no Total amount to be charged. Format: `x.xx` [oneOf 12].[allOf 4].[allOf 1].payment_token string no The tokenized version of the customer's card or check information, generated by the [Payment Component](../docs/payment-component) (npm packages / [Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology)) and usable only once. Existing integrations may also supply a token from [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology). [oneOf 12].[allOf 4].[allOf 1].transaction_session_id string no A single use session ID used by Kount to link the transaction and Data Collector information together. * Should be generated every time a payment form is loaded by the cardholder. * Should be random/unpredictable (do not use sequential IDs). * Should not be reused within a 30 day period. This can be used with [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology) or the Payment API when using the [Kount DDC with Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology). Format: `alphanumeric` minLength: 32; maxLength: 32 [oneOf 12].[allOf 4].[allOf 1].applepay_payment_data string no The encrypted token created when integration directly to the Apple Pay SDK. [oneOf 12].[allOf 4].[allOf 1].googlepay_payment_data string no The encrypted token created when [integration directly to the Google Pay SDK](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#googlepay_variables). [oneOf 12].[allOf 4].[allOf 1].surcharge string no Surcharge amount. Format: `x.xx` [oneOf 12].[allOf 4].[allOf 1].convenience_fee string no Convenience fee amount. Format: `x.xx` [oneOf 12].[allOf 4].[allOf 1].misc_fee string no Miscellaneous fee amount. Format: `x.xx` [oneOf 12].[allOf 4].[allOf 1].misc_fee_name string no Custom miscellaneous fee name. Default: `Miscellaneous Fee` [oneOf 12].[allOf 4].[allOf 1].tip number no The final tip amount, included in the transaction, associated with the purchase. Format: `x.xx` [oneOf 12].[allOf 4].[allOf 1].currency string no The transaction currency. Format: `ISO 4217` [oneOf 12].[allOf 4].[allOf 1].processor_id string no If using Multiple MIDs, route to this processor (*processor_id* is obtained under Settings → Transaction Routing in the Control Panel). [oneOf 12].[allOf 4].[allOf 1].dup_seconds integer no Sets the time in seconds for duplicate transaction checking on supported processors. Set to *0* to disable duplicate checking. maximum: 7862400 [oneOf 12].[allOf 4].[allOf 2].descriptor string no Set payment descriptor on supported processors. [oneOf 12].[allOf 4].[allOf 2].descriptor_phone string no Set payment descriptor phone on supported processors. [oneOf 12].[allOf 4].[allOf 2].descriptor_address string no Set payment descriptor address on supported processors. [oneOf 12].[allOf 4].[allOf 2].descriptor_city string no Set payment descriptor city on supported processors. [oneOf 12].[allOf 4].[allOf 2].descriptor_state string no Set payment descriptor state on supported processors. [oneOf 12].[allOf 4].[allOf 2].descriptor_postal string no Set payment descriptor postal code on supported processors. [oneOf 12].[allOf 4].[allOf 2].descriptor_country string no Set payment descriptor country on supported processors. [oneOf 12].[allOf 4].[allOf 2].descriptor_mcc string no Set payment descriptor mcc on supported processors. [oneOf 12].[allOf 4].[allOf 2].descriptor_merchant_id string no Set payment descriptor merchant id on supported processors. [oneOf 12].[allOf 4].[allOf 2].descriptor_url string no Set payment descriptor url on supported processors. [oneOf 12].[allOf 4].[allOf 3].billing_method string no Recurring or installment classification for the processor. - `initial_recurring`: First transaction in a recurring sequence only. - `recurring`: Later charges in that sequence. - `installment`: Installment transactions; use `billing_number` and `billing_total` on supported processors. Which values apply depends on the processor. enum: ["initial_recurring", "recurring", "installment"] [oneOf 12].[allOf 4].[allOf 3].billing_number integer no Specify installment billing number, on supported processors. For use when `billing_method` is set to "installment". minimum: 0; maximum: 99 [oneOf 12].[allOf 4].[allOf 3].billing_total string no Specify installment billing total on supported processors. For use when `billing_method` is set to "installment". [oneOf 12].[allOf 4].[allOf 3].order_template string no Order template ID. [oneOf 12].[allOf 4].[allOf 3].order_description string no Order description. [oneOf 12].[allOf 4].[allOf 3].orderid string no Order Id. [oneOf 12].[allOf 4].[allOf 3].ipaddress string no IP address of cardholder, this field is recommended. Format: `xxx.xxx.xxx.xxx` [oneOf 12].[allOf 4].[allOf 4].first_name string no Cardholder's first name. [oneOf 12].[allOf 4].[allOf 4].last_name string no Cardholder's last name [oneOf 12].[allOf 4].[allOf 4].company string no Cardholder's company [oneOf 12].[allOf 4].[allOf 4].address1 string no Card billing address [oneOf 12].[allOf 4].[allOf 4].address2 string no Card billing address, line 2 [oneOf 12].[allOf 4].[allOf 4].city string no Card billing city [oneOf 12].[allOf 4].[allOf 4].state string no Card billing state. Format: `CC` [oneOf 12].[allOf 4].[allOf 4].zip string no Card billing zip code [oneOf 12].[allOf 4].[allOf 4].country string no Card billing country. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 12].[allOf 4].[allOf 4].phone string no Billing phone number [oneOf 12].[allOf 4].[allOf 4].fax string no Billing fax number [oneOf 12].[allOf 4].[allOf 4].email string no Billing email address format: "email" [oneOf 12].[allOf 4].[allOf 5].drivers_license_number string no Driver's license number. [oneOf 12].[allOf 4].[allOf 5].drivers_license_dob string no Driver's license date of birth. [oneOf 12].[allOf 4].[allOf 5].drivers_license_state string no The state that issued the customer's driver's license. [oneOf 12].[allOf 4].[allOf 6].shipping_firstname string no Shipping first name [oneOf 12].[allOf 4].[allOf 6].shipping_lastname string no Shipping last name [oneOf 12].[allOf 4].[allOf 6].shipping_company string no Shipping company [oneOf 12].[allOf 4].[allOf 6].shipping_address1 string no Shipping address [oneOf 12].[allOf 4].[allOf 6].shipping_address2 string no Shipping address, line 2 [oneOf 12].[allOf 4].[allOf 6].shipping_city string no Shipping city [oneOf 12].[allOf 4].[allOf 6].shipping_state string no Shipping state. Format: `CC` [oneOf 12].[allOf 4].[allOf 6].shipping_zip string no Shipping zip code [oneOf 12].[allOf 4].[allOf 6].shipping_country string no Shipping country. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 12].[allOf 4].[allOf 6].shipping_email string no Shipping email address format: "email" [oneOf 12].[allOf 4].[allOf 7].merchant_defined_field_1 string no Merchant defined field. You can pass custom information in up to 20 fields. Format: `merchant_defined_field_1=Value1`, `merchant_defined_field_2=Value2`, etc... [oneOf 12].[allOf 4].[allOf 8].customer_receipt string no If set to true, when the customer is charged, they will be sent a transaction receipt. enum: ["true", "false"] [oneOf 12].[allOf 4].[allOf 8].cardholder_auth string no Set 3D Secure condition. Value used to determine E-commerce indicator (ECI). **Required for 3D Secure transactions** enum: ["verified", "attempted"] [oneOf 12].[allOf 4].[allOf 8].cavv string no Cardholder authentication verification value. Format: `base64 encoded` **Required for 3D Secure transactions** [oneOf 12].[allOf 4].[allOf 8].xid string no Cardholder authentication transaction id. Format: `base64 encoded` **Required for 3D Secure transactions** [oneOf 12].[allOf 4].[allOf 8].three_ds_version string no 3DSecure version. **Required for 3D Secure transactions** enum: ["2.0.0", "2.2.0"] [oneOf 12].[allOf 4].[allOf 8].directory_server_id string no Directory Server Transaction ID. May be provided as part of 3DSecure 2.0 authentication. Format: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` [oneOf 12].[allOf 4].[allOf 8].source_transaction_id string no Specifies a payment gateway transaction id in order to associate payment information with a Subscription or Customer Vault record. Must be set with a 'recurring' or 'customer_vault' action. [oneOf 12].[allOf 4].[allOf 8].pinless_debit_override string no Set to 'Y' if you have Pinless Debit Conversion enabled but want to opt out for this transaction. Feature applies to selected processors only. [oneOf 12].[allOf 4].[allOf 9].recurring string no **Recurring Field:** Recurring action to be processed. enum: ["add_subscription"] [oneOf 12].[allOf 4].[allOf 9].plan_id string no **Recurring Field:** Create a subscription tied to a Plan ID if the sale/auth transaction is successful. Required when **recurring** variable is set to `add_subscription` [oneOf 12].[allOf 4].[allOf 9].plan_payments integer no **Recurring Field:** The number of payments before the recurring plan is complete. Note: Use '0' for until canceled Required when **recurring** variable is set to `add_subscription` [oneOf 12].[allOf 4].[allOf 9].plan_amount number no **Recurring Field:** The plan amount to be charged each billing cycle. Format: `x.xx` Required when **recurring** variable is set to `add_subscription` [oneOf 12].[allOf 4].[allOf 9].month_frequency integer no **Recurring Field:** How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'. Required when **recurring** variable is set to `add_subscription` minimum: 1; maximum: 24 [oneOf 12].[allOf 4].[allOf 9].day_of_month integer no **Recurring Field:** The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'. For months without 29, 30, or 31 days, the charge will be on the last day Required when **recurring** variable is set to `add_subscription` minimum: 1; maximum: 31 [oneOf 12].[allOf 4].[allOf 9].day_frequency integer no **Recurring Field:** How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'. Required when **recurring** variable is set to `add_subscription` [oneOf 12].[allOf 4].[allOf 9].start_date string no **Recurring Field:** The first day that the customer will be charged. Format: `YYYYMMDD` Required when **recurring** variable is set to `add_subscription` format: "date" [oneOf 12].[allOf 4].[allOf 10].customer_vault string no Associate payment information with a Customer Vault record if the transaction is successful. enum: ["add_customer", "update_customer"] [oneOf 12].[allOf 4].[allOf 10].customer_vault_id string no Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id. [oneOf 12].[allOf 4].[allOf 11].initiated_by string no **Stored Credentials (CIT/MIT):** Who initiated the transaction. enum: ["customer", "merchant"] [oneOf 12].[allOf 4].[allOf 11].initial_transaction_id string no **Stored Credentials (CIT/MIT):** Original payment gateway transaction id. [oneOf 12].[allOf 4].[allOf 11].stored_credential_indicator string no **Stored Credentials (CIT/MIT):** The indicator of the stored credential. Use **'stored'** when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system. Use **'used'** when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method. enum: ["stored", "used"] [oneOf 12].[allOf 4].[allOf 12].shipping number no **Level II/III - Order Field:** Freight or shipping amount included in the transaction amount. Default - `0.00`. Format: `x.xx` [oneOf 12].[allOf 4].[allOf 12].tax number no **Level II/III - Order Field:** The sales tax, included in the transaction amount, associated with the purchase. Setting tax equal to '-1' indicates an order that is exempt from sales tax. Default - `0.00`. Format: `x.xx` [oneOf 12].[allOf 4].[allOf 12].ponumber string no **Level II/III - Order Field:** Purchase order number [oneOf 12].[allOf 4].[allOf 12].orderid string no **Level III - Order Field:** Identifier assigned by the merchant. This defaults to gateway transaction id. [oneOf 12].[allOf 4].[allOf 12].shipping_country string no **Level III - Order Field:** Shipping country (e.g. US). Format: `CC` - ISO 3166-1 alpha-2 [oneOf 12].[allOf 4].[allOf 12].shipping_postal string no **Level III - Order Field:** Postal/ZIP code of the address where purchased goods will be delivered. This field can be identical to the 'ship_from_postal' if the customer is present and takes immediate possession of the goods. [oneOf 12].[allOf 4].[allOf 12].ship_from_postal string no **Level III - Order Field:** Postal/ZIP code of the address from where purchased goods are being shipped, defaults to merchant profile postal code. [oneOf 12].[allOf 4].[allOf 12].summary_commodity_code string no **Level III - Order Field:** 4 character international description code of the overall goods or services being supplied. The acquirer or processor will provide a list of current codes. [oneOf 12].[allOf 4].[allOf 12].duty_amount number no **Level III - Order Field:** Amount included in the transaction amount associated with the import of purchased goods. Default - `0.00`. Format: `x.xx` [oneOf 12].[allOf 4].[allOf 12].discount_amount number no **Level III - Order Field:** Amount included in the transaction amount of any discount applied to complete order by the merchant. Default - `0.00`. Format: `x.xx` [oneOf 12].[allOf 4].[allOf 12].national_tax_amount number no **Level III - Order Field:** The national tax amount included in the transaction amount. Default - `0.00`. Format: `x.xx` [oneOf 12].[allOf 4].[allOf 12].alternate_tax_amount number no **Level III - Order Field:** Second tax amount included in the transaction amount in countries where more than one type of tax can be applied to the purchases. Default - `0.00`. Format: `x.xx` [oneOf 12].[allOf 4].[allOf 12].alternate_tax_id string no **Level III - Order Field:** Tax identification number of the merchant that reported the alternate tax amount. [oneOf 12].[allOf 4].[allOf 12].vat_tax_amount number no **Level III - Order Field:** Contains the amount of any value added taxes which can be associated with the purchased item. Default - `0.00`. Format: `x.xx` [oneOf 12].[allOf 4].[allOf 12].vat_tax_rate number no **Level III - Order Field:** Contains the tax rate used to calculate the sales tax amount appearing. Can contain up to 2 decimal places, e.g. 1% = 1.00. Default - `0.00`. Format: `x.xx` [oneOf 12].[allOf 4].[allOf 12].vat_invoice_reference_number string no **Level III - Order Field:** Invoice number that is associated with the VAT invoice. [oneOf 12].[allOf 4].[allOf 12].customer_vat_registration string no **Level III - Order Field:** Value added tax registration number supplied by the cardholder. [oneOf 12].[allOf 4].[allOf 12].merchant_vat_registration string no **Level III - Order Field:** Government assigned tax identification number of the merchant for whom the goods or services were purchased from. [oneOf 12].[allOf 4].[allOf 12].order_date string no **Level III - Order Field:** Purchase order date, defaults to the date of the transaction. Format: `YYMMDD` format: "date" [oneOf 12].[allOf 4].[allOf 13].item_product_code_1 string no **Level III - Line Item:** Merchant defined description code of the item being purchased. *Up to 99 sets of item_* fields are allowed.* [oneOf 12].[allOf 4].[allOf 13].item_description_1 string no **Level III - Line Item:** Description of the item(s) being supplied. [oneOf 12].[allOf 4].[allOf 13].item_commodity_code_1 string no **Level III - Line Item:** International description code of the individual good or service being supplied. The acquirer or processor will provide a list of current codes. [oneOf 12].[allOf 4].[allOf 13].item_unit_of_measure_1 string no **Level III - Line Item:** Code for units of measurement as used in international trade. Default - `EACH`. [oneOf 12].[allOf 4].[allOf 13].item_unit_cost_1 number no **Level III - Line Item:** Unit cost of item purchased, may contain up to 4 decimal places. [oneOf 12].[allOf 4].[allOf 13].item_quantity_1 integer no **Level III - Line Item:** Quantity of the item(s) being purchased. Default - `1`. [oneOf 12].[allOf 4].[allOf 13].item_total_amount_1 number no **Level III - Line Item:** Purchase amount associated with the item. Defaults to: 'item_unit_cost_#' x 'item_quantity_#' rounded to the nearest penny. [oneOf 12].[allOf 4].[allOf 13].item_tax_amount_1 number no **Level III - Line Item:** Amount of sales tax on specific item. Amount should not be included in 'total_amount_#'. Default - `0.00`. Format: `x.xx` [oneOf 12].[allOf 4].[allOf 13].item_tax_rate_1 number no **Level III - Line Item:** Percentage representing the value-added tax applied. Default - `0.00`. Format: `x.xx` [oneOf 12].[allOf 4].[allOf 13].item_discount_amount_1 number no **Level III - Line Item:** Discount amount which can have been applied by the merchant on the sale of the specific item. Amount should not be included in 'total_amount_#'. [oneOf 12].[allOf 4].[allOf 13].item_discount_rate_1 number no **Level III - Line Item:** Discount rate for the line item. Default - `0.00`. Format: `x.xx` [oneOf 12].[allOf 4].[allOf 13].item_tax_type_1 string no **Level III - Line Item:** Type of value-added taxes that are being used. [oneOf 12].[allOf 4].[allOf 13].item_alternate_tax_id_1 string no **Level III - Line Item:** Tax identification number of the merchant that reported the alternate tax amount. [oneOf 12].[allOf 4].[allOf 14].payment_facilitator_id string no **Payment Facilitator:** Payment Facilitator/Aggregator/ISO's ID Number [oneOf 12].[allOf 4].[allOf 14].submerchant_id string no **Payment Facilitator:** Sub-merchant Account ID [oneOf 12].[allOf 4].[allOf 14].submerchant_name string no **Payment Facilitator:** Sub-merchant's Name [oneOf 12].[allOf 4].[allOf 14].submerchant_address string no **Payment Facilitator:** Sub-merchant's Address [oneOf 12].[allOf 4].[allOf 14].submerchant_city string no **Payment Facilitator:** Sub-merchant's City [oneOf 12].[allOf 4].[allOf 14].submerchant_state string no **Payment Facilitator:** Sub-merchant's State [oneOf 12].[allOf 4].[allOf 14].submerchant_postal string no **Payment Facilitator:** Sub-merchant's Zip/Postal Code [oneOf 12].[allOf 4].[allOf 14].submerchant_country string no **Payment Facilitator:** Sub-merchant's Country [oneOf 12].[allOf 4].[allOf 14].submerchant_phone string no **Payment Facilitator:** Sub-merchant's Phone Number [oneOf 12].[allOf 4].[allOf 14].submerchant_email string no **Payment Facilitator:** Sub-merchant's Email Address format: "email" [oneOf 12].[allOf 5].social_security_number string no Customer's social security number, checked against bad check writers database if check verification is enabled. [oneOf 12].[allOf 6].signature_image string no Cardholder signature image. Format: `base64 encoded raw PNG image. (16kiB maximum)` [oneOf 13].[allOf 1].security_key string yes API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys [oneOf 13].[allOf 1].payment string no The type of payment. enum: ["creditcard"] [oneOf 13].[allOf 2].type string no Type of transactions. enum: ["update"] [oneOf 13].[allOf 2].transactionid string no Original payment gateway transaction id [oneOf 13].[allOf 2].tracking_number integer no Shipping tracking number [oneOf 13].[allOf 2].shipping number no Total shipping amount. Format: `x.xx` [oneOf 13].[allOf 2].shipping_postal integer no Postal/ZIP code of the address where purchased goods will be delivered. This field can be identical to the `ship_from_postal` if the customer is present and takes immediate possession of the goods. [oneOf 13].[allOf 2].shipping_country string no Shipping Country Code. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 13].[allOf 2].shipping_carrier string no Shipping carrier. enum: ["ups", "fedex", "dhl", "usps"] [oneOf 13].[allOf 2].shipping_date string no Shipping date. Format: `YYYYMMDD` format: "date" [oneOf 13].[allOf 2].order_description string no Order Description. Legacy variable includes: orderdescription [oneOf 13].[allOf 2].customer_receipt boolean no If set to true, when the customer is charged, they will be sent a transaction receipt. enum: [true, false] [oneOf 13].[allOf 2].signature_image string no Cardholder signature image. Format: `base64 encoded raw PNG image. (16kiB maximum)` [oneOf 13].[allOf 2].ponumber string no Cardholder's purchase order number. [oneOf 13].[allOf 2].summary_commodity_code string no 4 character international description code of the overall goods or services being supplied. The acquirer or processor will provide a list of current codes. minLength: 4; maxLength: 4 [oneOf 13].[allOf 2].duty_amount number no Amount included in the transaction amount associated with the import of purchased goods. Format: `x.xx` [oneOf 13].[allOf 2].discount_amount number no Amount included in the transaction amount of any discount applied to complete order by the merchant. Format: `x.xx` [oneOf 13].[allOf 3].tax number no The sales tax, included in the transaction amount, associated with the purchase. Setting tax equal to '-1' indicates an order that is exempt from sales tax. Default - `0.00`. format: "float" [oneOf 13].[allOf 3].national_tax_amount number no The national tax amount included in the transaction amount. Format: `x.xx` [oneOf 13].[allOf 3].alternate_tax_amount number no Second tax amount included in the transaction amount in countries where more than one type of tax can be applied to the purchases. Format: `x.xx` [oneOf 13].[allOf 3].alternate_tax_id integer no Tax identification number of the merchant that reported the alternate tax amount. [oneOf 13].[allOf 3].vat_tax_amount number no Contains the amount of any value added taxes which can be associated with the purchased item. [oneOf 13].[allOf 3].vat_tax_rate number no Contains the tax rate used to calculate the sales tax amount appearing. Can contain up to 2 decimal places, e.g. 1% = 1.00. format: "float" [oneOf 13].[allOf 3].vat_invoice_reference_number number no Invoice number that is associated with the VAT invoice. [oneOf 13].[allOf 3].customer_vat_registration number no Value added tax registration number supplied by the cardholder. [oneOf 13].[allOf 3].merchant_vat_registration number no Government assigned tax identification number of the merchant for whom the goods or services were purchased from. [oneOf 13].[allOf 4].merchant_defined_field_1 string no Merchant defined field. You can pass custom information in up to 20 fields. Format: `merchant_defined_field_1=Value1`, `merchant_defined_field_2=Value2`, etc... [oneOf 14].[allOf 1].security_key string yes API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys [oneOf 14].[allOf 1].payment string yes The type of payment. enum: ["check"] [oneOf 14].[allOf 2].type string no Type of transactions. enum: ["update"] [oneOf 14].[allOf 2].transactionid string no Original payment gateway transaction id [oneOf 14].[allOf 2].tracking_number integer no Shipping tracking number [oneOf 14].[allOf 2].shipping number no Total shipping amount. Format: `x.xx` [oneOf 14].[allOf 2].shipping_postal integer no Postal/ZIP code of the address where purchased goods will be delivered. This field can be identical to the `ship_from_postal` if the customer is present and takes immediate possession of the goods. [oneOf 14].[allOf 2].shipping_country string no Shipping Country Code. *Country codes are as shown in ISO 3166-1 alpha-2*. Format: `CC` [oneOf 14].[allOf 2].shipping_carrier string no Shipping carrier. enum: ["ups", "fedex", "dhl", "usps"] [oneOf 14].[allOf 2].shipping_date string no Shipping date. Format: `YYYYMMDD` format: "date" [oneOf 14].[allOf 2].order_description string no Order Description. Legacy variable includes: orderdescription [oneOf 14].[allOf 2].customer_receipt boolean no If set to true, when the customer is charged, they will be sent a transaction receipt. enum: [true, false] [oneOf 14].[allOf 2].signature_image string no Cardholder signature image. Format: `base64 encoded raw PNG image. (16kiB maximum)` [oneOf 14].[allOf 2].ponumber string no Cardholder's purchase order number. [oneOf 14].[allOf 2].summary_commodity_code string no 4 character international description code of the overall goods or services being supplied. The acquirer or processor will provide a list of current codes. minLength: 4; maxLength: 4 [oneOf 14].[allOf 2].duty_amount number no Amount included in the transaction amount associated with the import of purchased goods. Format: `x.xx` [oneOf 14].[allOf 2].discount_amount number no Amount included in the transaction amount of any discount applied to complete order by the merchant. Format: `x.xx` [oneOf 14].[allOf 3].tax number no The sales tax, included in the transaction amount, associated with the purchase. Setting tax equal to '-1' indicates an order that is exempt from sales tax. Default - `0.00`. format: "float" [oneOf 14].[allOf 3].national_tax_amount number no The national tax amount included in the transaction amount. Format: `x.xx` [oneOf 14].[allOf 3].alternate_tax_amount number no Second tax amount included in the transaction amount in countries where more than one type of tax can be applied to the purchases. Format: `x.xx` [oneOf 14].[allOf 3].alternate_tax_id integer no Tax identification number of the merchant that reported the alternate tax amount. [oneOf 14].[allOf 3].vat_tax_amount number no Contains the amount of any value added taxes which can be associated with the purchased item. [oneOf 14].[allOf 3].vat_tax_rate number no Contains the tax rate used to calculate the sales tax amount appearing. Can contain up to 2 decimal places, e.g. 1% = 1.00. format: "float" [oneOf 14].[allOf 3].vat_invoice_reference_number number no Invoice number that is associated with the VAT invoice. [oneOf 14].[allOf 3].customer_vat_registration number no Value added tax registration number supplied by the cardholder. [oneOf 14].[allOf 3].merchant_vat_registration number no Government assigned tax identification number of the merchant for whom the goods or services were purchased from. [oneOf 14].[allOf 4].merchant_defined_field_1 string no Merchant defined field. You can pass custom information in up to 20 fields. Format: `merchant_defined_field_1=Value1`, `merchant_defined_field_2=Value2`, etc... { "content": { "application/x-www-form-urlencoded": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreditCardSaleRequest" }, { "$ref": "#/components/schemas/CreditCardAuthorizeRequest" }, { "$ref": "#/components/schemas/CreditCardCaptureRequest" }, { "$ref": "#/components/schemas/CreditCardValidateRequest" }, { "$ref": "#/components/schemas/CreditCardCreditRequest" }, { "$ref": "#/components/schemas/CreditCardOfflineRequest" }, { "$ref": "#/components/schemas/CreditCardPaymentInFullPartialRequest" }, { "$ref": "#/components/schemas/VoidRequest" }, { "$ref": "#/components/schemas/RefundRequest" }, { "$ref": "#/components/schemas/ACHSaleRequest" }, { "$ref": "#/components/schemas/ACHCreditRequest" }, { "$ref": "#/components/schemas/CashSaleRequest" }, { "$ref": "#/components/schemas/TransactionUpdateRequest" }, { "$ref": "#/components/schemas/ACHTransactionUpdateRequest" } ] }, "examples": { "CreditCardSale": { "$ref": "#/components/examples/CreditCardSale" }, "CreditCardDecline": { "$ref": "#/components/examples/CreditCardDecline" }, "CreditCardAuth": { "$ref": "#/components/examples/CreditCardAuth" }, "CreditCardValidate": { "$ref": "#/components/examples/CreditCardValidate" }, "CreditCardCredit": { "$ref": "#/components/examples/CreditCardCredit" }, "CreditCardOffline": { "$ref": "#/components/examples/CreditCardOffline" }, "CreditCardRefund": { "$ref": "#/components/examples/CreditCardRefund" }, "CreditCardVoid": { "$ref": "#/components/examples/CreditCardVoid" }, "CreditCardCapture": { "$ref": "#/components/examples/CreditCardCapture" }, "CreditCardPartialPaymentExample": { "$ref": "#/components/examples/CreditCardPartialPaymentExample" }, "CreditCardPartialPaymentInFullExample": { "$ref": "#/components/examples/CreditCardPartialPaymentInFullExample" }, "ACHSale": { "$ref": "#/components/examples/ACHSale" }, "ACHRefund": { "$ref": "#/components/examples/ACHRefund" }, "ACHVoid": { "$ref": "#/components/examples/ACHVoid" }, "CashSale": { "$ref": "#/components/examples/CashSale" }, "Update Transaction": { "$ref": "#/components/examples/UpdateTransaction" }, "Update ACH Transaction": { "$ref": "#/components/examples/UpdateACHTransaction" } } } } } true
Response contract
The Classic methodology describes ampersand-delimited name/value responses. Where this schema advertises JSON media, that declaration is retained below as a source inconsistency; do not assume REST response parsing. For payments, response 1/2/3 distinguishes approval, decline and error. A transport success alone does not prove a payment was approved. { "200": { "description": "Transaction processed successfully", "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Response" }, "examples": { "CreditCardSale": { "$ref": "#/components/examples/CreditCardSaleResponse" }, "CreditCardDeclined": { "$ref": "#/components/examples/CreditCardDeclinedResponse" }, "CreditCardAuth": { "$ref": "#/components/examples/CreditCardAuthResponse" }, "CreditCardValidate": { "$ref": "#/components/examples/CreditCardValidateResponse" }, "CreditCardCredit": { "$ref": "#/components/examples/CreditCardCreditResponse" }, "CreditCardOffline": { "$ref": "#/components/examples/CreditCardOfflineResponse" }, "CreditCardRefund": { "$ref": "#/components/examples/CreditCardRefundResponse" }, "CreditCardVoid": { "$ref": "#/components/examples/CreditCardVoidResponse" }, "CreditCardCapture": { "$ref": "#/components/examples/CreditCardCaptureResponse" }, "CreditCardPartialPayment": { "$ref": "#/components/examples/CreditCardPartialPayment" }, "CreditCardPartialPaymentInFull": { "$ref": "#/components/examples/CreditCardPartialPaymentInFull" }, "ACHSale": { "$ref": "#/components/examples/ACHSaleResponse" }, "ACHRefund": { "$ref": "#/components/examples/ACHRefundResponse" }, "ACHVoid": { "$ref": "#/components/examples/ACHVoidResponse" }, "CashSale": { "$ref": "#/components/examples/CashSaleResponse" }, "Transaction Updated": { "$ref": "#/components/examples/TransactionUpdated" }, "Declined Request": { "$ref": "#/components/examples/DeclinedResponse" } } } } } } true
Referenced schema definitions
All schemas and source example objects are preserved here, including descriptions, enums and references. Sample data may be historical. These JSON objects describe form parameters; they are not instructions to send JSON to Classic. { "schemas": { "SecurityKey": { "type": "string", "description": "API Security Key assigned to a merchant account. New keys can be generated from the merchant control panel in Settings > Security Keys" }, "PartialPaymentInfo": { "type": "object", "properties": { "partial_payment_id": { "type": "string", "description": "Unique identifier returned when making the original transaction. This should only be used for secondary transactions." } } }, "CreditCard": { "type": "object", "properties": { "ccnumber": { "type": "string", "enum": [ "4111111111111111", "5431111111111111", "6011000991300009", "341111111111111", "30205252489926", "3541963594572595", "6799990100000000019" ], "description": "Credit card number.\n\n<details>\n<summary>Allowed Card Numbers:</summary>\n\n| Card Type | Test Card Number |\n|:------------------|:---------------------|\n| Visa | 4111111111111111 |\n| MasterCard | 5431111111111111 |\n| Discover | 6011000991300009 |\n| American Express | 341111111111111 |\n| Diner's Club | 30205252489926 |\n| JCB | 3541963594572595 |\n| Maestro | 6799990100000000019 |\n</details>" }, "ccexp": { "type": "string", "description": "Credit card expiration date.\n \nFormat: `MMYY`" } } }, "CreditCardWithCvv": { "allOf": [ { "$ref": "#/components/schemas/CreditCard" }, { "type": "object", "properties": { "cvv": { "type": "string", "description": "The card security code. While this is not required, it is strongly recommended." } } } ] }, "Amount": { "type": "object", "properties": { "amount": { "type": "string", "description": "Total amount to be charged.\n \nFormat: `x.xx`" } } }, "Descriptor": { "type": "object", "properties": { "descriptor": { "type": "string", "description": "Set payment descriptor on supported processors." }, "descriptor_phone": { "type": "string", "description": "Set payment descriptor phone on supported processors." }, "descriptor_address": { "type": "string", "description": "Set payment descriptor address on supported processors." }, "descriptor_city": { "type": "string", "description": "Set payment descriptor city on supported processors." }, "descriptor_state": { "type": "string", "description": "Set payment descriptor state on supported processors." }, "descriptor_postal": { "type": "string", "description": "Set payment descriptor postal code on supported processors." }, "descriptor_country": { "type": "string", "description": "Set payment descriptor country on supported processors." }, "descriptor_mcc": { "type": "string", "description": "Set payment descriptor mcc on supported processors." }, "descriptor_merchant_id": { "type": "string", "description": "Set payment descriptor merchant id on supported processors." }, "descriptor_url": { "type": "string", "description": "Set payment descriptor url on supported processors." } } }, "DriversLicense": { "type": "object", "properties": { "drivers_license_number": { "type": "string", "description": "Driver's license number." }, "drivers_license_dob": { "type": "string", "description": "Driver's license date of birth." }, "drivers_license_state": { "type": "string", "description": "The state that issued the customer's driver's license." } } }, "Shipping": { "type": "object", "properties": { "shipping_firstname": { "type": "string", "description": "Shipping first name" }, "shipping_lastname": { "type": "string", "description": "Shipping last name" }, "shipping_company": { "type": "string", "description": "Shipping company" }, "shipping_address1": { "type": "string", "description": "Shipping address" }, "shipping_address2": { "type": "string", "description": "Shipping address, line 2" }, "shipping_city": { "type": "string", "description": "Shipping city" }, "shipping_state": { "type": "string", "description": "Shipping state.\n \nFormat: `CC`" }, "shipping_zip": { "type": "string", "description": "Shipping zip code" }, "shipping_country": { "type": "string", "description": "Shipping country. *Country codes are as shown in ISO 3166-1 alpha-2*.\n \nFormat: `CC`" }, "shipping_email": { "type": "string", "format": "email", "description": "Shipping email address" } } }, "MerchantDefinedField": { "type": "object", "properties": { "merchant_defined_field_1": { "type": "string", "description": "Merchant defined field. You can pass custom information in up to 20 fields.\n\nFormat: `merchant_defined_field_1=Value1`, `merchant_defined_field_2=Value2`, etc..." } } }, "CustomerVaultFields": { "type": "object", "properties": { "customer_vault": { "type": "string", "enum": [ "add_customer", "update_customer" ], "description": "Associate payment information with a Customer Vault record if the transaction is successful.", "x-group-key": "Customer Vault" }, "customer_vault_id": { "type": "string", "description": "Specifies a Customer Vault id. If not set, the payment gateway will randomly generate a Customer Vault id.", "x-group-key": "Customer Vault" } } }, "StoredCredentialsFields": { "type": "object", "properties": { "initiated_by": { "type": "string", "enum": [ "customer", "merchant" ], "description": "**Stored Credentials (CIT/MIT):** Who initiated the transaction." }, "initial_transaction_id": { "type": "string", "description": "**Stored Credentials (CIT/MIT):** Original payment gateway transaction id." }, "stored_credential_indicator": { "type": "string", "enum": [ "stored", "used" ], "description": "**Stored Credentials (CIT/MIT):** The indicator of the stored credential.\n\nUse **'stored'** when processing the initial transaction in which you are storing a customer's payment details (customer credentials) in the Customer Vault or other third-party payment storage system.\n\nUse **'used'** when processing a subsequent or follow-up transaction using the customer payment details (customer credentials) you have already stored to the Customer Vault or third-party payment storage method." } } }, "LevelThreeOrderFields": { "type": "object", "properties": { "shipping": { "type": "number", "description": "**Level II/III - Order Field:** Freight or shipping amount included in the transaction amount. Default - `0.00`.\n\nFormat: `x.xx`", "x-group-key": "Level III - Order" }, "tax": { "type": "number", "description": "**Level II/III - Order Field:** The sales tax, included in the transaction amount, associated with the purchase. Setting tax equal to '-1' indicates an order that is exempt from sales tax. Default - `0.00`.\n\nFormat: `x.xx`", "x-group-key": "Level III - Order" }, "ponumber": { "type": "string", "description": "**Level II/III - Order Field:** Purchase order number", "x-group-key": "Level III - Order" }, "orderid": { "type": "string", "description": "**Level III - Order Field:** Identifier assigned by the merchant. This defaults to gateway transaction id.", "x-group-key": "Level III - Order" }, "shipping_country": { "type": "string", "description": "**Level III - Order Field:** Shipping country (e.g. US).\n \nFormat: `CC` - ISO 3166-1 alpha-2", "x-group-key": "Level III - Order" }, "shipping_postal": { "type": "string", "description": "**Level III - Order Field:** Postal/ZIP code of the address where purchased goods will be delivered. This field can be identical to the 'ship_from_postal' if the customer is present and takes immediate possession of the goods.", "x-group-key": "Level III - Order" }, "ship_from_postal": { "type": "string", "description": "**Level III - Order Field:** Postal/ZIP code of the address from where purchased goods are being shipped, defaults to merchant profile postal code.", "x-group-key": "Level III - Order" }, "summary_commodity_code": { "type": "string", "description": "**Level III - Order Field:** 4 character international description code of the overall goods or services being supplied. The acquirer or processor will provide a list of current codes.", "x-group-key": "Level III - Order" }, "duty_amount": { "type": "number", "description": "**Level III - Order Field:** Amount included in the transaction amount associated with the import of purchased goods. Default - `0.00`.\n\nFormat: `x.xx`", "x-group-key": "Level III - Order" }, "discount_amount": { "type": "number", "description": "**Level III - Order Field:** Amount included in the transaction amount of any discount applied to complete order by the merchant. Default - `0.00`.\n\nFormat: `x.xx`", "x-group-key": "Level III - Order" }, "national_tax_amount": { "type": "number", "description": "**Level III - Order Field:** The national tax amount included in the transaction amount. Default - `0.00`.\n\nFormat: `x.xx`", "x-group-key": "Level III - Order" }, "alternate_tax_amount": { "type": "number", "description": "**Level III - Order Field:** Second tax amount included in the transaction amount in countries where more than one type of tax can be applied to the purchases. Default - `0.00`.\n\nFormat: `x.xx`", "x-group-key": "Level III - Order" }, "alternate_tax_id": { "type": "string", "description": "**Level III - Order Field:** Tax identification number of the merchant that reported the alternate tax amount.", "x-group-key": "Level III - Order" }, "vat_tax_amount": { "type": "number", "description": "**Level III - Order Field:** Contains the amount of any value added taxes which can be associated with the purchased item. Default - `0.00`.\n\nFormat: `x.xx`", "x-group-key": "Level III - Order" }, "vat_tax_rate": { "type": "number", "description": "**Level III - Order Field:** Contains the tax rate used to calculate the sales tax amount appearing. Can contain up to 2 decimal places, e.g. 1% = 1.00. Default - `0.00`.\n\nFormat: `x.xx`", "x-group-key": "Level III - Order" }, "vat_invoice_reference_number": { "type": "string", "description": "**Level III - Order Field:** Invoice number that is associated with the VAT invoice.", "x-group-key": "Level III - Order" }, "customer_vat_registration": { "type": "string", "description": "**Level III - Order Field:** Value added tax registration number supplied by the cardholder.", "x-group-key": "Level III - Order" }, "merchant_vat_registration": { "type": "string", "description": "**Level III - Order Field:** Government assigned tax identification number of the merchant for whom the goods or services were purchased from.", "x-group-key": "Level III - Order" }, "order_date": { "type": "string", "format": "date", "description": "**Level III - Order Field:** Purchase order date, defaults to the date of the transaction.\n\nFormat: `YYMMDD`", "x-group-key": "Level III - Order" } } }, "LevelThreeLineItemDetailFields": { "type": "object", "properties": { "item_product_code_1": { "type": "string", "description": "**Level III - Line Item:** Merchant defined description code of the item being purchased.\n\n*Up to 99 sets of item_* fields are allowed.*", "x-group-key": "Level III - Line Item(s)" }, "item_description_1": { "type": "string", "description": "**Level III - Line Item:** Description of the item(s) being supplied.", "x-group-key": "Level III - Line Item(s)" }, "item_commodity_code_1": { "type": "string", "description": "**Level III - Line Item:** International description code of the individual good or service being supplied. The acquirer or processor will provide a list of current codes.", "x-group-key": "Level III - Line Item(s)" }, "item_unit_of_measure_1": { "type": "string", "description": "**Level III - Line Item:** Code for units of measurement as used in international trade. Default - `EACH`.", "x-group-key": "Level III - Line Item(s)" }, "item_unit_cost_1": { "type": "number", "description": "**Level III - Line Item:** Unit cost of item purchased, may contain up to 4 decimal places.", "x-group-key": "Level III - Line Item(s)" }, "item_quantity_1": { "type": "integer", "description": "**Level III - Line Item:** Quantity of the item(s) being purchased. Default - `1`.", "x-group-key": "Level III - Line Item(s)" }, "item_total_amount_1": { "type": "number", "description": "**Level III - Line Item:** Purchase amount associated with the item. Defaults to: 'item_unit_cost_#' x 'item_quantity_#' rounded to the nearest penny.", "x-group-key": "Level III - Line Item(s)" }, "item_tax_amount_1": { "type": "number", "description": "**Level III - Line Item:** Amount of sales tax on specific item. Amount should not be included in 'total_amount_#'. Default - `0.00`.\n\nFormat: `x.xx`", "x-group-key": "Level III - Line Item(s)" }, "item_tax_rate_1": { "type": "number", "description": "**Level III - Line Item:** Percentage representing the value-added tax applied. Default - `0.00`.\n\nFormat: `x.xx`", "x-group-key": "Level III - Line Item(s)" }, "item_discount_amount_1": { "type": "number", "description": "**Level III - Line Item:** Discount amount which can have been applied by the merchant on the sale of the specific item. Amount should not be included in 'total_amount_#'.", "x-group-key": "Level III - Line Item(s)" }, "item_discount_rate_1": { "type": "number", "description": "**Level III - Line Item:** Discount rate for the line item. Default - `0.00`.\n\nFormat: `x.xx`", "x-group-key": "Level III - Line Item(s)" }, "item_tax_type_1": { "type": "string", "description": "**Level III - Line Item:** Type of value-added taxes that are being used.", "x-group-key": "Level III - Line Item(s)" }, "item_alternate_tax_id_1": { "type": "string", "description": "**Level III - Line Item:** Tax identification number of the merchant that reported the alternate tax amount.", "x-group-key": "Level III - Line Item(s)" } } }, "PaymentFacilitatorFields": { "type": "object", "properties": { "payment_facilitator_id": { "type": "string", "description": "**Payment Facilitator:** Payment Facilitator/Aggregator/ISO's ID Number", "x-group-key": "Payment Facilitator" }, "submerchant_id": { "type": "string", "description": "**Payment Facilitator:** Sub-merchant Account ID", "x-group-key": "Payment Facilitator" }, "submerchant_name": { "type": "string", "description": "**Payment Facilitator:** Sub-merchant's Name", "x-group-key": "Payment Facilitator" }, "submerchant_address": { "type": "string", "description": "**Payment Facilitator:** Sub-merchant's Address", "x-group-key": "Payment Facilitator" }, "submerchant_city": { "type": "string", "description": "**Payment Facilitator:** Sub-merchant's City", "x-group-key": "Payment Facilitator" }, "submerchant_state": { "type": "string", "description": "**Payment Facilitator:** Sub-merchant's State", "x-group-key": "Payment Facilitator" }, "submerchant_postal": { "type": "string", "description": "**Payment Facilitator:** Sub-merchant's Zip/Postal Code", "x-group-key": "Payment Facilitator" }, "submerchant_country": { "type": "string", "description": "**Payment Facilitator:** Sub-merchant's Country", "x-group-key": "Payment Facilitator" }, "submerchant_phone": { "type": "string", "description": "**Payment Facilitator:** Sub-merchant's Phone Number", "x-group-key": "Payment Facilitator" }, "submerchant_email": { "type": "string", "format": "email", "description": "**Payment Facilitator:** Sub-merchant's Email Address", "x-group-key": "Payment Facilitator" } } }, "BaseTransaction": { "allOf": [ { "type": "object", "properties": { "payment_token": { "type": "string", "description": "The tokenized version of the customer's card or check information, generated by the [Payment Component](../docs/payment-component) (npm packages / [Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology)) and usable only once. Existing integrations may also supply a token from [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology)." }, "transaction_session_id": { "type": "string", "minLength": 32, "maxLength": 32, "description": "A single use session ID used by Kount to link the transaction and Data Collector information together.\n\n* Should be generated every time a payment form is loaded by the cardholder.\n* Should be random/unpredictable (do not use sequential IDs).\n* Should not be reused within a 30 day period.\n\nThis can be used with [Collect.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#cjs_methodology) or the Payment API when using the [Kount DDC with Gateway.js](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#gjs_methodology).\n\nFormat: `alphanumeric`" }, "applepay_payment_data": { "type": "string", "description": "The encrypted token created when integration directly to the Apple Pay SDK." }, "googlepay_payment_data": { "type": "string", "description": "The encrypted token created when [integration directly to the Google Pay SDK](https://secure.networkmerchants.com/merchants/resources/integration/integration_portal.php#googlepay_variables)." }, "surcharge": { "type": "string", "description": "Surcharge amount.\n \nFormat: `x.xx`" }, "convenience_fee": { "type": "string", "description": "Convenience fee amount.\n \nFormat: `x.xx`" }, "misc_fee": { "type": "string", "description": "Miscellaneous fee amount.\n \nFormat: `x.xx`" }, "misc_fee_name": { "type": "string", "description": "Custom miscellaneous fee name.\n \nDefault: `Miscellaneous Fee`" }, "tip": { "type": "number", "description": "The final tip amount, included in the transaction, associated with the purchase.\n \nFormat: `x.xx`" }, "currency": { "type": "string", "description": "The transaction currency.\n \nFormat: `ISO 4217`" }, "processor_id": { "type": "string", "description": "If using Multiple MIDs, route to this processor (*processor_id* is obtained under Settings \u2192 Transaction Routing in the Control Panel)." }, "dup_seconds": { "type": "integer", "maximum": 7862400, "description": "Sets the time in seconds for duplicate transaction checking on supported processors. Set to *0* to disable duplicate checking." } } }, { "$ref": "#/components/schemas/Descriptor" }, { "type": "object", "properties": { "billing_method": { "type": "string", "enum": [ "initial_recurring", "recurring", "installment" ], "description": "Recurring or installment classification for the processor.\n\n- `initial_recurring`: First transaction in a recurring sequence only.\n- `recurring`: Later charges in that sequence.\n- `installment`: Installment transactions; use `billing_number` and `billing_total` on supported processors.\n\nWhich values apply depends on the processor." }, "billing_number": { "type": "integer", "minimum": 0, "maximum": 99, "description": "Specify installment billing number, on supported processors. For use when `billing_method` is set to \"installment\"." }, "billing_total": { "type": "string", "description": "Specify installment billing total on supported processors. For use when `billing_method` is set to \"installment\"." }, "order_template": { "type": "string", "description": "Order template ID." }, "order_description": { "type": "string", "description": "Order description." }, "orderid": { "type": "string", "description": "Order Id." }, "ipaddress": { "type": "string", "description": "IP address of cardholder, this field is recommended.\n \nFormat: `xxx.xxx.xxx.xxx`" } } }, { "type": "object", "properties": { "first_name": { "type": "string", "description": "Cardholder's first name." }, "last_name": { "type": "string", "description": "Cardholder's last name" }, "company": { "type": "string", "description": "Cardholder's company" }, "address1": { "type": "string", "description": "Card billing address" }, "address2": { "type": "string", "description": "Card billing address, line 2" }, "city": { "type": "string", "description": "Card billing city" }, "state": { "type": "string", "description": "Card billing state.\n \nFormat: `CC`" }, "zip": { "type": "string", "description": "Card billing zip code" }, "country": { "type": "string", "description": "Card billing country. *Country codes are as shown in ISO 3166-1 alpha-2*.\n \nFormat: `CC`" }, "phone": { "type": "string", "description": "Billing phone number" }, "fax": { "type": "string", "description": "Billing fax number" }, "email": { "type": "string", "format": "email", "description": "Billing email address" } } }, { "$ref": "#/components/schemas/DriversLicense" }, { "$ref": "#/components/schemas/Shipping" }, { "$ref": "#/components/schemas/MerchantDefinedField" }, { "type": "object", "properties": { "customer_receipt": { "type": "string", "enum": [ "true", "false" ], "description": "If set to true, when the customer is charged, they will be sent a transaction receipt." }, "cardholder_auth": { "type": "string", "enum": [ "verified", "attempted" ], "description": "Set 3D Secure condition. Value used to determine E-commerce indicator (ECI).\n \n**Required for 3D Secure transactions**" }, "cavv": { "type": "string", "description": "Cardholder authentication verification value.\n \nFormat: `base64 encoded` **Required for 3D Secure transactions**" }, "xid": { "type": "string", "description": "Cardholder authentication transaction id.\n \nFormat: `base64 encoded` **Required for 3D Secure transactions**" }, "three_ds_version": { "type": "string", "enum": [ "2.0.0", "2.2.0" ], "description": "3DSecure version. **Required for 3D Secure transactions**" }, "directory_server_id": { "type": "string", "description": "Directory Server Transaction ID. May be provided as part of 3DSecure 2.0 authentication.\n \nFormat: `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`" }, "source_transaction_id": { "type": "string", "description": "Specifies a payment gateway transaction id in order to associate payment information with a Subscription or Customer Vault record. Must be set with a 'recurring' or 'customer_vault' action." }, "pinless_debit_override": { "type": "string", "description": "Set to 'Y' if you have Pinless Debit Conversion enabled but want to opt out for this transaction. Feature applies to selected processors only." } } }, { "type": "object", "properties": { "recurring": { "type": "string", "enum": [ "add_subscription" ], "description": "**Recurring Field:** Recurring action to be processed.", "x-group-key": "Recurring" }, "plan_id": { "type": "string", "description": "**Recurring Field:** Create a subscription tied to a Plan ID if the sale/auth transaction is successful.\n\nRequired when **recurring** variable is set to `add_subscription`", "x-group-key": "Recurring" }, "plan_payments": { "type": "integer", "description": "**Recurring Field:** The number of payments before the recurring plan is complete.\n\nNote: Use '0' for until canceled\n\nRequired when **recurring** variable is set to `add_subscription`", "x-group-key": "Recurring" }, "plan_amount": { "type": "number", "description": "**Recurring Field:** The plan amount to be charged each billing cycle.\n\nFormat: `x.xx`\n\nRequired when **recurring** variable is set to `add_subscription`", "x-group-key": "Recurring" }, "month_frequency": { "type": "integer", "minimum": 1, "maximum": 24, "description": "**Recurring Field:** How often, in months, to charge the customer. Cannot be set with 'day_frequency'. Must be set with 'day_of_month'. \n\nRequired when **recurring** variable is set to `add_subscription`", "x-group-key": "Recurring" }, "day_of_month": { "type": "integer", "minimum": 1, "maximum": 31, "description": "**Recurring Field:** The day that the customer will be charged. Cannot be set with 'day_frequency'. Must be set with 'month_frequency'. For months without 29, 30, or 31 days, the charge will be on the last day\n\nRequired when **recurring** variable is set to `add_subscription`", "x-group-key": "Recurring" }, "day_frequency": { "type": "integer", "description": "**Recurring Field:** How often, in days, to charge the customer. Cannot be set with 'month_frequency' or 'day_of_month'.\n\nRequired when **recurring** variable is set to `add_subscription`", "x-group-key": "Recurring" }, "start_date": { "type": "string", "format": "date", "description": "**Recurring Field:** The first day that the customer will be charged.\n\nFormat: `YYYYMMDD`\n\nRequired when **recurring** variable is set to `add_subscription`", "x-group-key": "Recurring" } } }, { "$ref": "#/components/schemas/CustomerVaultFields" }, { "$ref": "#/components/schemas/StoredCredentialsFields" }, { "$ref": "#/components/schemas/LevelThreeOrderFields" }, { "$ref": "#/components/schemas/LevelThreeLineItemDetailFields" }, { "$ref": "#/components/schemas/PaymentFacilitatorFields" } ] }, "Industry": { "type": "object", "properties": { "industry": { "type": "string", "enum": [ "ecommerce", "moto", "retail", "restaurant", "lodging" ], "description": "The industry parameter is supported across multiple transaction types. Its purpose is to identify the merchant industry type for processing" } } }, "SignatureImage": { "type": "object", "properties": { "signature_image": { "type": "string", "description": "Cardholder signature image.\n \nFormat: `base64 encoded raw PNG image. (16kiB maximum)`" } } }, "CustomerTokenVaultFields": { "type": "object", "properties": { "network_tokenize": { "type": "string", "enum": [ "0", "1" ], "description": "Overrides the Customer Token Vault settings and tokenizes the transaction if eligible. Default - `0`.", "x-group-key": "Customer Token Vault" } } }, "CreditCardSaleRequest": { "title": "Credit Card - Sale", "allOf": [ { "type": "object", "required": [ "type", "ccnumber", "ccexp", "amount", "security_key" ], "properties": { "security_key": { "$ref": "#/components/schemas/SecurityKey" }, "type": { "type": "string", "description": "The type of transaction to be processed. Must be `sale`" }, "partial_payments": { "type": "string", "enum": [ "settle_partial", "payment_in_full" ], "description": "`settle_partial`: Settles any amount of tender collected (captured partial auth's and approved partial sales) at cut off.\n\n`payment_in_full`: Required that any split tendered transaction is collected in-full before settlement gets initiated." } } }, { "additionalProperties": { "type": "string", "description": "Up to 20 `merchant_defined_field_#` are allowed." } }, { "$ref": "#/components/schemas/PartialPaymentInfo" }, { "$ref": "#/components/schemas/CreditCardWithCvv" }, { "$ref": "#/components/schemas/Amount" }, { "$ref": "#/components/schemas/BaseTransaction" }, { "$ref": "#/components/schemas/Industry" }, { "$ref": "#/components/schemas/SignatureImage" }, { "$ref": "#/components/schemas/CustomerTokenVaultFields" } ] }, "CreditCardAuthorizeRequest": { "title": "Credit Card - Authorize", "allOf": [ { "type": "object", "required": [ "type", "ccnumber", "ccexp", "amount", "security_key" ], "properties": { "security_key": { "$ref": "#/components/schemas/SecurityKey" }, "type": { "type": "string", "enum": [ "auth" ], "description": "The type of transaction to be processed." } } }, { "additionalProperties": { "type": "string", "description": "Up to 20 `merchant_defined_field_#` are allowed." } }, { "$ref": "#/components/schemas/CreditCardWithCvv" }, { "$ref": "#/components/schemas/Amount" }, { "$ref": "#/components/schemas/BaseTransaction" }, { "$ref": "#/components/schemas/Industry" }, { "$ref": "#/components/schemas/SignatureImage" }, { "$ref": "#/components/schemas/CustomerTokenVaultFields" } ] }, "CreditCardCaptureRequest": { "title": "Credit Card - Capture", "allOf": [ { "type": "object", "required": [ "type", "transactionid", "amount", "security_key" ], "properties": { "security_key": { "$ref": "#/components/schemas/SecurityKey" }, "type": { "type": "string", "enum": [ "capture" ], "description": "The type of transaction to be processed." }, "transactionid": { "type": "string", "description": "Original payment gateway transaction id." }, "amount": { "type": "string", "description": "Total amount to be settled. This amount must be equal to or less than the original authorized amount.\n \nFormat: `x.xx`" }, "tracking_number": { "type": "string", "description": "Shipping tracking number." }, "shipping_carrier": { "type": "string", "enum": [ "ups", "fedex", "dhl", "usps" ], "description": "Shipping carrier." }, "orderid": { "type": "string", "description": "Order ID." } } }, { "$ref": "#/components/schemas/SignatureImage" } ] }, "CreditCardValidateRequest": { "title": "Credit Card - Validate", "allOf": [ { "type": "object", "required": [ "type", "ccnumber", "ccexp", "security_key" ], "properties": { "security_key": { "$ref": "#/components/schemas/SecurityKey" }, "type": { "type": "string", "enum": [ "validate" ], "description": "The type of transaction to be processed." } } }, { "additionalProperties": { "type": "string", "description": "Up to 20 `merchant_defined_field_#` are allowed." } }, { "$ref": "#/components/schemas/CreditCardWithCvv" }, { "$ref": "#/components/schemas/BaseTransaction" }, { "$ref": "#/components/schemas/SignatureImage" } ] }, "CreditCardCreditRequest": { "title": "Credit Card - Credit", "allOf": [ { "type": "object", "required": [ "type", "ccnumber", "ccexp", "amount", "security_key" ], "properties": { "security_key": { "$ref": "#/components/schemas/SecurityKey" }, "type": { "type": "string", "enum": [ "credit" ], "description": "The type of transaction to be processed." } } }, { "additionalProperties": { "type": "string", "description": "Up to 20 `merchant_defined_field_#` are allowed." } }, { "$ref": "#/components/schemas/CreditCardWithCvv" }, { "$ref": "#/components/schemas/Amount" }, { "$ref": "#/components/schemas/BaseTransaction" }, { "$ref": "#/components/schemas/Industry" }, { "$ref": "#/components/schemas/SignatureImage" }, { "$ref": "#/components/schemas/CustomerTokenVaultFields" } ] }, "CreditCardOfflineRequest": { "title": "Credit Card - Offline", "allOf": [ { "type": "object", "required": [ "type", "ccnumber", "ccexp", "amount", "authorization_code", "security_key" ], "properties": { "security_key": { "$ref": "#/components/schemas/SecurityKey" }, "type": { "type": "string", "enum": [ "offline" ], "description": "The type of transaction to be processed. **Note** that offline transactions need to be enabled." }, "authorization_code": { "type": "string", "description": "Specify authorization code." } } }, { "additionalProperties": { "type": "string", "description": "Up to 20 `merchant_defined_field_#` are allowed." } }, { "$ref": "#/components/schemas/CreditCardWithCvv" }, { "$ref": "#/components/schemas/Amount" }, { "$ref": "#/components/schemas/BaseTransaction" }, { "$ref": "#/components/schemas/Industry" }, { "$ref": "#/components/schemas/SignatureImage" } ] }, "CreditCardPaymentInFullPartialRequest": { "title": "Credit Card - Complete Partial Payment in Full", "allOf": [ { "type": "object", "required": [ "type", "ccnumber", "ccexp", "amount", "partial_payment_id", "partial_payments", "security_key" ], "properties": { "security_key": { "$ref": "#/components/schemas/SecurityKey" }, "type": { "type": "string", "enum": [ "complete_partial_payment" ], "description": "Will complete a `payment_in_full` transaction that has not been collected in full. This allows industries that require `payment_in_full` but subsequently decide to still settle the transaction even though it has not been collected in full." }, "partial_payments": { "type": "string", "enum": [ "payment_in_full" ], "description": "`payment_in_full`: Required that any split tendered transaction is collected in-full before settlement gets initiated." } } }, { "additionalProperties": { "type": "string", "description": "Up to 20 `merchant_defined_field_#` are allowed." } }, { "$ref": "#/components/schemas/PartialPaymentInfo" }, { "$ref": "#/components/schemas/CreditCardWithCvv" }, { "$ref": "#/components/schemas/Amount" }, { "$ref": "#/components/schemas/BaseTransaction" }, { "$ref": "#/components/schemas/Industry" }, { "$ref": "#/components/schemas/SignatureImage" } ] }, "VoidRequest": { "title": "Void Transaction", "allOf": [ { "type": "object", "required": [ "type", "transactionid", "security_key" ], "properties": { "security_key": { "$ref": "#/components/schemas/SecurityKey" }, "type": { "type": "string", "enum": [ "void" ], "description": "The type of transaction to be processed." }, "transactionid": { "type": "string", "description": "Original payment gateway transaction id." }, "payment": { "type": "string", "enum": [ "check", "creditcard" ], "description": "**Required for ACH** The type of payment. Default - `creditcard`." }, "void_reason": { "type": "string", "enum": [ "fraud", "user_cancel", "icc_rejected", "icc_card_removed", "icc_no_confirmation", "pos_timeout" ], "description": "**Conditionally Required** if Transaction is EMV. Reason the EMV transaction is being voided." } } } ] }, "RefundAmount": { "type": "object", "properties": { "amount": { "type": "string", "description": "Total amount to be refunded. This amount may be equal to or less than the settled amount. Setting the amount to `0.00` will refund the entire amount.\n \nFormat: `x.xx`" } } }, "RefundRequest": { "title": "Refund Transaction", "allOf": [ { "type": "object", "required": [ "type", "transactionid", "security_key" ], "properties": { "security_key": { "$ref": "#/components/schemas/SecurityKey" }, "type": { "type": "string", "enum": [ "refund" ], "description": "The type of transaction to be processed." }, "transactionid": { "type": "string", "description": "Original payment gateway transaction id." }, "payment": { "type": "string", "enum": [ "check", "creditcard" ], "description": "**Required for ACH** The type of payment. Default - `creditcard`." } } }, { "$ref": "#/components/schemas/RefundAmount" } ] }, "ACH": { "type": "object", "properties": { "checkname": { "type": "string", "description": "The name on the customer's ACH account." }, "checkaba": { "type": "string", "minLength": 9, "maxLength": 9, "description": "The customer's bank routing number." }, "checkaccount": { "type": "string", "description": "The customer's bank account number." }, "account_holder_type": { "type": "string", "enum": [ "business", "personal" ], "description": "The type of ACH account the customer has." }, "account_type": { "type": "string", "enum": [ "checking", "savings" ], "description": "The type of ACH account the customer has." }, "sec_code": { "type": "string", "enum": [ "PPD", "WEB", "TEL", "CCD" ], "description": "The Standard Entry Class code of the ACH transaction." } } }, "ACHSaleRequest": { "title": "ACH - Sale", "allOf": [ { "type": "object", "required": [ "type", "checkname", "checkaba", "checkaccount", "amount", "payment", "security_key" ], "properties": { "security_key": { "$ref": "#/components/schemas/SecurityKey" }, "type": { "type": "string", "enum": [ "sale" ], "description": "The type of transaction to be processed." }, "payment": { "type": "string", "description": "The type of payment.", "enum": [ "check" ] } } }, { "additionalProperties": { "type": "string", "description": "Up to 20 `merchant_defined_field_#` are allowed." } }, { "$ref": "#/components/schemas/ACH" }, { "$ref": "#/components/schemas/Amount" }, { "$ref": "#/components/schemas/BaseTransaction" }, { "type": "object", "properties": { "social_security_number": { "type": "string", "description": "Customer's social security number, checked against bad check writers database if check verification is enabled." } } }, { "$ref": "#/components/schemas/SignatureImage" } ] }, "ACHCreditRequest": { "title": "ACH - Credit", "allOf": [ { "type": "object", "required": [ "type", "checkname", "checkaba", "checkaccount", "payment", "security_key" ], "properties": { "security_key": { "$ref": "#/components/schemas/SecurityKey" }, "type": { "type": "string", "enum": [ "credit" ], "description": "The type of transaction to be processed. Note that credits need to be enabled." }, "payment": { "type": "string", "description": "The type of payment.", "enum": [ "check", "cash" ] } } }, { "additionalProperties": { "type": "string", "description": "Up to 20 `merchant_defined_field_#` are allowed." } }, { "$ref": "#/components/schemas/ACH" }, { "$ref": "#/components/schemas/Amount" }, { "$ref": "#/components/schemas/BaseTransaction" }, { "type": "object", "properties": { "social_security_number": { "type": "string", "description": "Customer's social security number, checked against bad check writers database if check verification is enabled." } } }, { "$ref": "#/components/schemas/SignatureImage" } ] }, "CashSaleRequest": { "title": "Cash - Sale", "allOf": [ { "type": "object", "required": [ "type", "payment", "amount", "security_key" ], "properties": { "security_key": { "$ref": "#/components/schemas/SecurityKey" }, "type": { "type": "string", "enum": [ "sale" ], "description": "The type of transaction to be processed." }, "payment": { "type": "string", "description": "The type of payment.", "enum": [ "cash" ] } } }, { "additionalProperties": { "type": "string", "description": "Up to 20 `merchant_defined_field_#` are allowed." } }, { "$ref": "#/components/schemas/Amount" }, { "$ref": "#/components/schemas/BaseTransaction" }, { "type": "object", "properties": { "social_security_number": { "type": "string", "description": "Customer's social security number, checked against bad check writers database if check verification is enabled." } } }, { "$ref": "#/components/schemas/SignatureImage" } ] }, "BaseUpdateTransaction": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "update" ], "description": "Type of transactions." }, "transactionid": { "type": "string", "description": "Original payment gateway transaction id" }, "tracking_number": { "type": "integer", "description": "Shipping tracking number" }, "shipping": { "type": "number", "description": "Total shipping amount.\n\nFormat: `x.xx`" }, "shipping_postal": { "type": "integer", "description": "Postal/ZIP code of the address where purchased goods will be delivered. This field can be identical to the `ship_from_postal` if the customer is present and takes immediate possession of the goods." }, "shipping_country": { "type": "string", "description": "Shipping Country Code. *Country codes are as shown in ISO 3166-1 alpha-2*.\n \nFormat: `CC`" }, "shipping_carrier": { "type": "string", "enum": [ "ups", "fedex", "dhl", "usps" ], "description": "Shipping carrier." }, "shipping_date": { "type": "string", "format": "date", "description": "Shipping date.\n\nFormat: `YYYYMMDD`" }, "order_description": { "type": "string", "description": "Order Description.\n\nLegacy variable includes: orderdescription" }, "customer_receipt": { "type": "boolean", "enum": [ true, false ], "description": "If set to true, when the customer is charged, they will be sent a transaction receipt." }, "signature_image": { "type": "string", "description": "Cardholder signature image.\n\nFormat: `base64 encoded raw PNG image. (16kiB maximum)`" }, "ponumber": { "type": "string", "description": "Cardholder's purchase order number." }, "summary_commodity_code": { "type": "string", "minLength": 4, "maxLength": 4, "description": "4 character international description code of the overall goods or services being supplied. The acquirer or processor will provide a list of current codes." }, "duty_amount": { "type": "number", "description": "Amount included in the transaction amount associated with the import of purchased goods.\n\nFormat: `x.xx`" }, "discount_amount": { "type": "number", "description": "Amount included in the transaction amount of any discount applied to complete order by the merchant.\n\nFormat: `x.xx`" } } }, "Tax": { "type": "object", "properties": { "tax": { "type": "number", "format": "float", "description": "The sales tax, included in the transaction amount, associated with the purchase. Setting tax equal to '-1' indicates an order that is exempt from sales tax. Default - `0.00`." }, "national_tax_amount": { "type": "number", "description": "The national tax amount included in the transaction amount.\n\nFormat: `x.xx`" }, "alternate_tax_amount": { "type": "number", "description": "Second tax amount included in the transaction amount in countries where more than one type of tax can be applied to the purchases.\n\nFormat: `x.xx`" }, "alternate_tax_id": { "type": "integer", "description": "Tax identification number of the merchant that reported the alternate tax amount." }, "vat_tax_amount": { "type": "number", "description": "Contains the amount of any value added taxes which can be associated with the purchased item." }, "vat_tax_rate": { "type": "number", "format": "float", "description": "Contains the tax rate used to calculate the sales tax amount appearing. Can contain up to 2 decimal places, e.g. 1% = 1.00." }, "vat_invoice_reference_number": { "type": "number", "description": "Invoice number that is associated with the VAT invoice." }, "customer_vat_registration": { "type": "number", "description": "Value added tax registration number supplied by the cardholder." }, "merchant_vat_registration": { "type": "number", "description": "Government assigned tax identification number of the merchant for whom the goods or services were purchased from." } } }, "TransactionUpdateRequest": { "title": "Update Transaction", "allOf": [ { "type": "object", "required": [ "type", "transactionid", "security_key" ], "properties": { "security_key": { "$ref": "#/components/schemas/SecurityKey" }, "payment": { "type": "string", "enum": [ "creditcard" ], "description": "The type of payment." } } }, { "$ref": "#/components/schemas/BaseUpdateTransaction" }, { "$ref": "#/components/schemas/Tax" }, { "$ref": "#/components/schemas/MerchantDefinedField" } ] }, "ACHTransactionUpdateRequest": { "title": "Update ACH Transaction", "allOf": [ { "type": "object", "required": [ "type", "transactionid", "payment", "security_key" ], "properties": { "security_key": { "$ref": "#/components/schemas/SecurityKey" }, "payment": { "type": "string", "enum": [ "check" ], "description": "The type of payment." } } }, { "$ref": "#/components/schemas/BaseUpdateTransaction" }, { "$ref": "#/components/schemas/Tax" }, { "$ref": "#/components/schemas/MerchantDefinedField" } ] }, "Response": { "type": "object", "title": "Response", "properties": { "response": { "type": "string", "enum": [ "1", "2", "3" ], "description": "Status code for the operation. (1) - success, (2) - failed, (3) system error" }, "responsetext": { "type": "string", "description": "Textual description of the operation's result." }, "authcode": { "type": "string", "description": "Authorization code for the operation." }, "amount_authorized": { "type": "string", "description": "(Conditional) This will optionally come back when requesting partial payment. Authorization amount." }, "transactionid": { "type": "string", "description": "(Conditional - Payment) Payment gateway transaction id." }, "invoice_id": { "type": "string", "description": "(Conditional - Invoice) Identifier for the invoice." }, "avsresponse": { "type": "string", "description": "Address Verification Service response code." }, "cvvresponse": { "type": "string", "description": "Card Verification Value response." }, "orderid": { "type": "string", "description": "Identifier for an order related to this invoice." }, "type": { "type": "string", "enum": [ "sale", "auth", "validate", "credit", "offline", "capture", "void", "refund", "complete_partial_payment", "add_invoice", "update_invoice", "send_invoice", "close_invoice", "add_plan", "edit_plan", "add_subscription", "" ], "description": "Type of operation that this response is for." }, "partial_payment_id": { "type": "string", "description": "(Conditional) This will optionally come back when requesting partial payment. A numeric identifier which is used when submitting subsequent transactions." }, "partial_payment_balance": { "type": "string", "description": "(Conditional) This will optionally come back when requesting partial payment. The payment's remaining balance." }, "platform_id": { "type": "string", "description": "Platform ID associated with the transaction." }, "response_code": { "type": "string", "description": "Another status or result code for the operation. See [Response Code Table](#section/Appendixes/Payment-API-Response-Codes)" }, "subscription_id": { "type": "string", "description": "(Conditional - Subscription) The subscription ID that was created" }, "emv_auth_response_data": { "type": "string", "description": "(Conditional) This will optionally come back when any chip card data is provided on the authorization. This data needs to be sent back to the SDK after an authorization." }, "payment_terms": { "type": "string", "description": "(Conditional - Invoice) The terms of payment for the invoice." }, "customer_vault_id": { "type": "string", "description": "(Conditional - Customer Vault) The original customer_vault_id passed in the transaction request or the resulting customer_vault_id created on an approved transaction.\n\nNote: Only returned when the \"Customer Vault\" service is active." }, "kount_score": { "type": "string", "description": "The Kount \"Omniscore\" indicating the level of risk on a given transaction. The higher the score, the lower the risk.\n\nNote: Only returned when the \"Kount\" service is active." } } } }, "examples": { "CreditCardSale": { "summary": "Credit Card Sale", "description": "Create credit card sale transaction", "value": { "type": "sale", "ccnumber": "4111111111111111", "ccexp": "1025", "cvv": "123", "amount": "1", "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "CreditCardDecline": { "summary": "Credit Card Decline", "description": "Decline a credit card sale transaction", "value": { "type": "sale", "ccnumber": "4111111111111111", "ccexp": "1025", "cvv": "123", "amount": "0.5", "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "CreditCardAuth": { "summary": "Credit Card Authorize", "description": "Authorize credit card transaction", "value": { "type": "auth", "ccnumber": "4111111111111111", "ccexp": "1025", "cvv": "123", "amount": "10", "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "CreditCardValidate": { "summary": "Validate Credit Card", "description": "Validate credit card transaction", "value": { "type": "validate", "ccnumber": "4111111111111111", "ccexp": "1025", "cvv": "123", "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "CreditCardCredit": { "summary": "Credit Card Credit Transaction", "description": "Credit the credit card with the given amount", "value": { "type": "sale", "ccnumber": "4111111111111111", "ccexp": "1025", "cvv": "123", "amount": "1", "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "CreditCardOffline": { "summary": "Credit Card Offline Transaction", "description": "Create credit card offline transaction", "value": { "type": "offline", "ccnumber": "4111111111111111", "ccexp": "1025", "cvv": "123", "amount": "10", "authorization_code": "123456", "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "CreditCardRefund": { "summary": "Refund Credit Card Transaction", "description": "Refund full amount of a credit card transaction", "value": { "type": "refund", "transactionid": "8564830211", "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "CreditCardVoid": { "summary": "Void Credit Card Transaction", "description": "Void credit card transaction", "value": { "type": "void", "transactionid": "8564830211", "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "CreditCardCapture": { "summary": "Capture Credit Card Transaction", "description": "Capture credit card transaction", "value": { "type": "capture", "transactionid": "8564830211", "amount": "10", "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "CreditCardPartialPaymentExample": { "summary": "Credit Card Partial Payment", "description": "Create a partial payment for credit card sale transaction", "value": { "type": "sale", "ccnumber": "4111111111111111", "ccexp": "1025", "cvv": "123", "amount": "100", "partial_payment_id": "123456789", "partial_payments": "settle_partial", "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "CreditCardPartialPaymentInFullExample": { "summary": "Partial Payment Pay in Full", "description": "Pay partial payment in full", "value": { "type": "complete_partial_payment", "ccnumber": "4111111111111111", "ccexp": "1025", "cvv": "123", "amount": "100", "partial_payment_id": "123456789", "partial_payments": "payment_in_full", "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "ACHSale": { "summary": "ACH Sale", "description": "Create ACH sale transaction", "value": { "type": "sale", "payment": "check", "checkname": "Smith", "checkaba": "123123123", "checkaccount": "123123123", "amount": "10", "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "ACHRefund": { "summary": "Refund ACH Transaction", "description": "Refund full amount of an ACH transaction", "value": { "type": "refund", "transactionid": "8564830211", "payment": "check", "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "ACHVoid": { "summary": "Void ACH Transaction", "description": "Void ACH transaction", "value": { "type": "void", "transactionid": "8564875333", "payment": "check", "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "CashSale": { "summary": "Cash Sale", "description": "Create cash sale transaction", "value": { "type": "sale", "payment": "cash", "amount": "10", "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "UpdateTransaction": { "summary": "Update Transaction", "description": "Update transaction - change tracking number", "value": { "type": "update", "transactionid": "8543919398", "tracking_number": 123456, "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "UpdateACHTransaction": { "summary": "Update ACH Transaction", "description": "Update ACH transaction - change tracking number", "value": { "type": "update", "transactionid": "8543919398", "payment": "check", "tracking_number": 123456, "security_key": "6457Thfj624V5r7WUwc5v6a68Zsd6YEm" } }, "CreditCardSaleResponse": { "summary": "Credit Card Sale Transaction", "description": "A successful credit card sale transaction", "value": { "response": "1", "responsetext": "SUCCESS", "authcode": "123456", "transactionid": "8558644015", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "sale", "response_code": "100" } }, "CreditCardDeclinedResponse": { "summary": "Credit Card Transaction Declined", "description": "Credit card transaction has been declined", "value": { "response": "2", "responsetext": "DECLINE", "authcode": "", "transactionid": "8558718571", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "sale", "response_code": "200" } }, "CreditCardAuthResponse": { "summary": "Credit Card Transaction Authorized", "description": "Credit card transaction with the given amount has been successfully authorized", "value": { "response": "1", "responsetext": "SUCCESS", "authcode": "123456", "transactionid": "8558644015", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "auth", "response_code": "100" } }, "CreditCardValidateResponse": { "summary": "Credit Card Transaction Validated", "description": "Credit card transaction has been successfully validated", "value": { "response": "1", "responsetext": "SUCCESS", "authcode": "", "transactionid": "8559444951", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "validate", "response_code": "100" } }, "CreditCardCreditResponse": { "summary": "Credit Card Transaction Credited", "description": "Amount has been credited to the credit card", "value": { "response": "1", "responsetext": "SUCCESS", "authcode": "", "transactionid": "8559453367", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "credit", "response_code": "100" } }, "CreditCardOfflineResponse": { "summary": "Credit Card Offline Transaction Created", "description": "Offline credit card transaction has been created", "value": { "response": "1", "responsetext": "SUCCESS", "authcode": "", "transactionid": "8558644018", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "offline", "response_code": "100" } }, "CreditCardRefundResponse": { "summary": "Credit Card Transaction Refunded", "description": "Credit card transaction has been successfully refunded", "value": { "response": "1", "responsetext": "SUCCESS", "authcode": "123456", "transactionid": "8564972358", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "refund", "response_code": "100" } }, "CreditCardVoidResponse": { "summary": "Credit Card Transaction Voided", "description": "Credit card transaction has been successfully voided", "value": { "response": "1", "responsetext": "Transaction Void Successful", "authcode": "123456", "transactionid": "8564830211", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "void", "response_code": "100" } }, "CreditCardCaptureResponse": { "summary": "Credit Card Transaction Captured", "description": "Credit card transaction with the given amount has been successfully captured", "value": { "response": "1", "responsetext": "SUCCESS", "authcode": "123456", "transactionid": "8564830211", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "capture", "response_code": "100" } }, "CreditCardPartialPayment": { "summary": "Credit Card Partial Payment", "description": "Partial payment for credit card sale transaction created", "value": { "response": "1", "responsetext": "APPROVED", "authcode": "", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "sale", "response_code": "100", "partial_payment_id": "123456789", "partial_payment_balance": "70", "amount_authorized": "30" } }, "CreditCardPartialPaymentInFull": { "summary": "Partial Payment Pay in Full", "description": "Partial payment payed in full", "value": { "response": "1", "responsetext": "APPROVED", "authcode": "", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "complete_partial_payment", "response_code": "100", "partial_payment_id": "123456789", "partial_payment_balance": "0", "amount_authorized": "70" } }, "ACHSaleResponse": { "summary": "ACH Sale Transaction", "description": "A successful ACH sale transaction", "value": { "response": "1", "responsetext": "SUCCESS", "authcode": "123456", "transactionid": "8561989100", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "sale", "response_code": "100" } }, "ACHRefundResponse": { "summary": "ACH Transaction Refunded", "description": "ACH transaction has been successfully refunded", "value": { "response": "1", "responsetext": "SUCCESS", "authcode": "123456", "transactionid": "8564972359", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "refund", "response_code": "100" } }, "ACHVoidResponse": { "summary": "ACH Transaction Voided", "description": "ACH transaction has been successfully voided", "value": { "response": "1", "responsetext": "SUCCESS", "authcode": "123456", "transactionid": "8564875333", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "void", "response_code": "100" } }, "CashSaleResponse": { "summary": "Cash Sale Transaction", "description": "A successful cash sale transaction", "value": { "response": "1", "responsetext": "APPROVED", "authcode": "", "transactionid": "8561993922", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "sale", "response_code": "100" } }, "TransactionUpdated": { "summary": "Transaction Updated", "description": "Transaction has been updated successfully", "value": { "response": "1", "responsetext": "Transaction Updated Successfully", "authcode": "123456", "transactionid": "8558644015", "avsresponse": "", "cvvresponse": "", "orderid": "123456789", "response_code": "100" } }, "DeclinedResponse": { "summary": "Failed to Create Plan", "description": "Failed to create a new plan", "value": { "response": "3", "responsetext": "There is already a plan using the SKU you have specified. REFID:1203610329", "authcode": "", "transactionid": "", "avsresponse": "", "cvvresponse": "", "orderid": "", "type": "", "response_code": "100" } } } } true
Published operation notes
Additional operation-specific source notes, including legacy outcome tables where published. Read alongside the family guidance above; source marketing claims are not compliance guarantees. <details> <summary>Methodology</summary> **Steps:** 1. The customer sends their payment information to the merchant's web site. 2. The merchant web site posts the payment data to the Payment Gateway. 3. The Payment Gateway responds immediately with the results of the transactions. 4. The merchant web site displays the appropriate message to the customer. The communication method used to send messages to the Payment Gateway's server is the standard HTTP protocol over an SSL connection. In the Payment API method, the communications with the cardholder (Steps 1 and 4) are developed completely by the merchant and therefore are not defined by the Payment Gateway. Step 1 should simply collect the payment data from the cardholder and Step 4 should display the appropriate transaction receipt or declined message. In Step 2, transaction details should be delivered to the Payment Gateway using the POST method with the appropriate variables defined below posted along with the request. In Step 3, the transaction responses are returned in the body of the HTTP response in a query string name/value format delimited by ampersands. For example: `variable1=value1&variable2=value2&variable3=value3` ### Customer Vault The Customer Vault was designed specifically for businesses of any size to address concerns about handling customer payment information. Visa and MasterCard have instituted the Payment Card Industry (PCI) Data Security to protect cardholder data, wherever it resides, ensuring that members, merchants, and service providers maintain the highest information security standards. These associations have also deemed that merchants will be held liable for any breach of cardholder data. This has become a major concern for merchants who handle credit card or electronic check payments. The Customer Vault is designed for these merchants who desire to avoid the tremendous costs and resources involved in becoming PCI compliant under these circumstances. The Customer Vault does this by allowing merchants to transmit their payment information through a Secure Sockets Layer (SSL) connection for storage in our Level 1 PCI certified data facility. Once the customer record has been securely transmitted to the Customer Vault, the merchant can then initiate transactions remotely without having to access cardholder information directly. This process is accomplished without the merchant storing the customer's payment information in their local database or payment application. </details> <details> <summary>Response Code Table</summary> | Code | Description | |:------|:-------------------------------------------------------------------| | 100 | Transaction was approved. | | 200 | Transaction was declined by processor. | | 201 | Do not honor. | | 202 | Insufficient funds. | | 203 | Over limit. | | 204 | Transaction not allowed. | | 220 | Incorrect payment information. | | 221 | No such card issuer. | | 222 | No card number on file with issuer. | | 223 | Expired card. | | 224 | Invalid expiration date. | | 225 | Invalid card security code. | | 226 | Invalid PIN. | | 240 | Call issuer for further information. | | 250 | Pick up card. | | 251 | Lost card. | | 252 | Stolen card. | | 253 | Fraudulent card. | | 260 | Declined with further instructions available. (See response text) | | 261 | Declined-Stop all recurring payments. | | 262 | Declined-Stop this recurring program. | | 263 | Declined-Update cardholder data available. | | 264 | Declined-Retry in a few days. | | 300 | Transaction was rejected by gateway. | | 400 | Transaction error returned by processor. | | 410 | Invalid merchant configuration. | | 411 | Merchant account is inactive. | | 420 | Communication error. | | 421 | Communication error with issuer. | | 430 | Duplicate transaction at processor. | | 440 | Processor format error. | | 441 | Invalid transaction information. | | 460 | Processor feature not available. | | 461 | Unsupported card type. | </details> true
Reconcile outcomes
Persist the returned transaction or object identifier and inspect the operation result before changing application state. Investigate interrupted financial responses before retrying. Saved methods, invoice delivery, schedules and refunds have different side effects; select the corresponding variant explicitly. Account and processor behavior have not been executed in this audit.