Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

With credit card transactions, Level II and Level III different levels of data submission is are critical for businesses engaged in different types of transactions. Major card brands Visa & MasterCard, each have specific requirements that merchants must adhere to to offer the best interchange rates. (American Express and Discover do not offer Level III data submission for interchange rates at this time).

Below is a breakdown of the key data required for Level II and Level III data submission for each card brand.

...

There are three levels of interchange data submission available:

Level I

Basic transaction data like card number and transaction amount that is required for standard consumer transactions and provides standard interchange rates.

Level II

More detailed transaction data like sales tax that is required for B2B transactions and provides lower interchange rates.

Level III

Comprehensive transaction information like line item details and shipping, that is required for high-value (large ticket) B2B transaction and provides the lowest interchange rates.

Major card brands Visa & MasterCard each have specific requirements that merchants must adhere to to offer them the best interchange rates. American Express and Discover do not accept direct Level II or Level III data submissions for lower interchange rates at this time.

Below is a breakdown of the key data required for Level II and Level III data submission for each card brand.

Info

Note: Each additional level of data submission, Level I to Level II to Level III data, requires all data from the previous level in addition to the new data required.

Example: In order to submit Level III data, all Level I and Level II data requirements must already be met to qualify for Level III interchange rates.

...

Once you are familiar with these requirements, visit <<Submit Level II & III interchange data article>> to learn the different methods available to submit this data.

Tip

Visa - The Data Requirements Standard

Tip: For developers and Portal users, we recommend using Visa’s Level II and Level III requirements as your data submission foundation for Level II and Level II submission for any card brand.

Visa’s stringent standards cover all necessary elements for detailed transaction reporting.

Visa

Below is a list of Visa qualifying card types, interchange requirements, and prohibited merchant types (MCCs).

Expand
titleVisa - Qualifying Card Types for Interchange Data Submission

The following card types can be used for Level II & Level III data submission and interchange rates:

  • Business Cards

  • Corporate Cards

  • Purchasing Cards

...

titleVisa - Level II Data Requirements

Level II data must include all Level I data requirements in addition to the requirements listed below.

Sales Tax Information - Sales tax information for each transaction including:

...

Sales Tax Amount

...

The total amount of sales tax applied to the transaction.

...

Sales Tax Indicator

...

Specify whether sales tax is included in the transaction amount or not.

Merchant Information - Details about the Merchant selling the product or service items including:

...

Customer Code

...

The unique identifier assigned to customers or entities within the Merchant’s records.

...

Merchant Zip Code

...

The zip code where the Merchant’s business is located.

...

Merchant TIN

...

The tax identification number issued to the Merchant by their governmental tax agency.

...

titleVisa - Level III Data Requirements

Level III data must include all Level II data requirements in addition to the requirements listed below.

Line Item Details - Must provide detailed information for each item listed in a transaction including:

...

Discount Amount

...

Monetary reductions applied to the transaction total.

...

Discount Per Line Item

...

Monetary reductions applied to the product or service price for the line item.

...

Invoice number

...

A unique identifier for the transaction's associated customer invoice.

...

Item Commodity Code

Standardized numerical 7-digit NIGP commodity code used to classify products for customs.

Attached is a partial list of available 7-digit codes.

View file
namenigplist.pdf

...

Item Description

...

A detailed description of the product or service sold.

...

Line Item Total

...

Total transaction line item cost, calculated with quantity, unit price, discounts, tax, and shipping.

...

Order number

...

A unique identifier for the transaction's associated order within your business.

...

Product Code

...

A unique identifier used by the Merchant business to identify the specific product.

...

Quantity

...

The number of units sold.

...

Unit Price

...

The price per item unit.

...

Unit of Measure

...

A standardized unit used to quantify the quantity of the product or service.

...

Unit of Cost

...

A standardized unit used to measure the cost of a single unit.

Shipping & Customs Details - Must provide shipping, duty, and tax information (if applicable) including:

...

Duty Amount

...

The monetary value of customs duties or taxes related to product import and export.

...

Shipping Amount

...

The cost associated with transporting products from Merchant to customer.

...

Shipping Destination Country

...

The country of the address where purchased products will be delivered.

...

Shipping Destination Zip Code

...

The postal code of the address where purchased products will be delivered.

...

Shipping Origin Zip Code

...

The postal code of the address where the purchased products were shipped from.

Expand
titleVisa - Additional Qualification Requirements

In addition to the interchange data requirements above, the Visa card network has specific additional requirements to qualify:

  • The transaction must be compliant with the Visa Custom Payment Service (CPS).

  • A ‘capture’ request must follow the ‘authorization’ request:

    • Within 1 business day (no more than 24 hours between auth and capture) or;

    • Within 7 days (for eligible large ticket transactions using corporate/purchasing cards).

  • Transaction must be authorized online and cannot be a cardholder-activated terminal (CAT) location.

  • The transaction must always include a non-zero tax amount

  • Business Card type transactions must always include an Address Verification System (AVS) reference.

Large Ticket transactions refer to transactions with a larger total dollar amount.

Based on the transaction amount, your interchange rate may change to offer better pricing from Visa’s large ticket program for high-dollar-value transactions.

In addition to the data
Expand
titleVisa - Large Ticket Requirements
Note

Warning: For all ‘tax’ amount values, ensure the amount always corresponds to your local state or province regulations to ensure tax compliance.

Visa

In addition to the parameter qualifications below, Visa also requires the following conditions to be met from Merchants before they can submit Level II or Level III data for lower interchange rates:

  1. Merchants must process 1 to 6 million Visa transactions per year.

  2. Merchants must process between $20,000 and $1,000,000 in e-commerce transactions per year.

  3. Merchants must submit the following forms to the Visa Verification team:

    1. Annual Attestation of Compliance (AOC)

    2. Annual Self-Assessment Questionnaire (SAQ)

    3. Quarterly Network Scan by an Approved Scan Vendor (ASV2)

Read more information about Visa requirements below:

Expand
titleVisa - Qualifying Card Types for Interchange Data Submission

The following card types can be used for Level II data submission:

  • Corporate Purchasing

  • Business Credit

  • Enhanced Business Credit

  • Signature Business Credit


In addition to the above, the following card types can be used for Level III data submission:

  • Corporate Credit

  • Purchasing Credit

Note

Commercial Prepaid card type is not eligible.

Expand
titleVisa - Level II Data Requirements

Level II data must include all Level I data requirements in addition to the requirements listed below.

Sales Tax and Order Information - Sales tax information for each transaction including:

Sales Tax Amount

The total amount of sales tax applied to the transaction.

Note

Warning: The tax amount must be between 0.1% - 22% of the payment total to qualify. This is submitted using either a Sale or a Capture transaction type.

Sales Tax Indicator

Specify whether sales tax is included in the transaction amount or not.

Order Number

A unique identifier used by the merchant to locate the specific transaction information.

Note: “Order Number” and “Invoice Number” are interchangeable terms for Level II and Level III data submission.

Merchant Information - Details about the Merchant selling the product or service items including:

Customer Code

The unique identifier assigned to customers or entities within the Merchant’s records.

Merchant Zip Code

The zip code where the Merchant’s business is located.

Merchant TIN

The tax identification number issued to the Merchant by their governmental tax agency.

Expand
titleVisa - Level III Data Requirements

Level III data must include all Level II data requirements in addition to the requirements listed below.

Order (Line) Item Details - Must provide detailed information for each item listed in a transaction including:

Description

A detailed description of the product or service sold.

Commodity Code

Standardized numerical 7-digit NIGP commodity code used to classify products for customs.

Attached is a partial list of available 7-digit codes.

View file
namenigplist.pdf

Product Code

A unique identifier used by the Merchant business to identify the specific product.

Item Price

The price per item unit.

Item Discount

Monetary reductions applied to the product or service price for the line item.

Quantity

The number of units sold.

Unit of Measure

A standardized unit used to quantify the quantity of the product or service.

Item Total

Total transaction line item cost, calculated with quantity, unit price, discounts, tax, and shipping.

Discount, Shipping & Duty - Must provide shipping, duty, and tax information (if applicable) including:

Shipping Amount

The cost associated with transporting products from Merchant to customer.

Duty Amount

The monetary value of customs duties or taxes related to product import and export.

Order Discount

Monetary reductions applied to the transaction total.

Expand
titleVisa - Additional Qualification Requirements

In addition to the interchange data requirements above, the Visa card network has specific additional requirements to qualify for Large Ticket interchange pricing:

American Express

Merchants processing American Express transactions are required to obtain pre-approval before initiating Level II data processing. Level II data parameters from Visa or MasterCard would apply here.

To receive approval, Merchants must submit a “Level 2 Merchant’s Validation Documentation” which includes summaries from Quarterly Network Scan and a completed PCI Self Assessment Questionaire. Once granted, American Express accepts both Level I and Level II data, offering Level II interchange rates.

Visit the American Express US Data Security site for more information.

Warning

Unavailable: American Express does not offer discounts or changes in interchanges rates for Level III data submissions

Discover

The following Merchant Commercial Code (MCC) types are disqualified from Level II or Level III data submission for interchange rate improvements:

Visa Non-Compliant MCCs List:

Warning
Unavailable: American Express does not offer any discounts or changes in interchanges rates for Level II or Level III data submissions.
  • Clearing must follow authorization within 2 business days (no more than 1 day The transaction must be compliant with the Visa Custom Payment Service (CPS).

  • A ‘capture’ request must follow the ‘authorization’ request:

    • Within 1 business day (no more than 24 hours between auth and capture)

Expand
titleVisa - Prohibited Merchant Business Types (MCCs)

Non-Compliant MCCs

Description of Merchant Business Type

3000–3999

Airlines/Car Rental Companies/Hotels

4112

Passenger Railways

4411

Steamship and Cruise Lines

4511

Airlines and Air Carriers

4722

Travel Agencies and Tour Operators

5812

Eating Places and Restaurants

5814

Fast Food Restaurants

5962

Direct Marketing – Travel Related Arrangements Services (High Risk)

5966

Direct Marketing – Outbound Telemarketing Merchant (High Risk)

5967

Direct Marketing – Inbound Teleservices Merchant (High Risk)

7011

Lodging – Hotels, Motels, and Resorts

7512

Automobile Rental Agency

7513

Truck & Utility Trailer Rentals

MasterCard

Below is a list of MasterCard qualifying card types, interchange requirements, and prohibited merchant types (MCCs).

Expand
titleMasterCard - Qualifying Card Types for Interchange Data Submission

The following card types can be used for Level II & Level III data submission and interchange rates:

  • Business Cards

  • Corporate Cards

  • Purchasing Cards

Note

Warning: The following card types are ineligible for Level III interchange with MasterCard:

  • MBS - Mastercard B2B Product 1

  • MEF - Mastercard Electronic Payment Account

...

titleMasterCard - Level II Data Requirements

Level II data must include all Level I data requirements in addition to the requirements listed below.

Sales Tax Information - Sales tax information for each transaction including:

...

Sales Tax Amount

...

The total amount of sales tax applied to the transaction.

...

Sales Tax Indicator

...

Specify whether sales tax is included in the transaction amount or not.

Merchant Information - Details about the Merchant selling the product or service items including:

...

Customer Code

...

The unique identifier assigned to customers or entities within the Merchant’s records.

...

Merchant TIN

...

The tax identification number issued to the Merchant by their governmental tax agency.

...

titleMasterCard - Level III Data Requirements

Level III data must include all Level II data requirements in addition to the requirements listed below.

Line Item Details - Must provide detailed information for each item listed in a transaction including:

...

Discount Amount

...

Monetary reductions applied to the transaction total.

...

Discount Per Line Item

...

Monetary reductions applied to the product or service price for the line item.

...

Item Description

...

A detailed description of the product or service sold.

...

Line Item Total

...

Total transaction line item cost, calculated with quantity, unit price, discounts, tax, and shipping.

...

Product Code

...

A unique identifier used by the Merchant business to identify the specific product.

...

Quantity

...

The number of units sold.

...

Unit of Measure

...

A standardized unit used to quantify the quantity of the product or service.

Note

Warning: The following card types are ineligible for Level III interchange with MasterCard:

  • MBS - Mastercard B2B Product 1

  • MEF - Mastercard Electronic Payment Account

Expand
titleMasterCard - Additional Qualification Requirements

In addition to the interchange data requirements above, the MasterCard card network has specific additional requirements to qualify:

  • Clearing must follow an authorization request within 3 business days (no more than 2 days between auth and capture).

Expand
titleMasterCard - Large Ticket Requirements

Large Ticket transactions refer to transactions with a larger total dollar amount. Based on the transaction amount, your interchange rate may change to offer better pricing from MasterCard’s large ticket program for high-dollar-value transactions.

In addition to the data requirements above, the MasterCard network has specific additional requirements to qualify for Large Ticket interchange pricing:

  • Clearing must follow authorization within 2 business days (no more than 1 day between auth and capture).

Note

Warning: The following card types are ineligible for MasterCard’s large ticket program:

  • MAP - Mastercard Commercial Payments Account

  • MAQ - Mastercard Prepaid Commercial Payments Account

  • MEF - Mastercard Electronic Payment Account

...

titleMasterCard - Prohibited Merchant Business Types (MCCs)

The following Merchant Commercial Code (MCC) types are disqualified from Level II or Level III data submission for interchange rate improvements:

MasterCard Non-Compliant MCCs List:

...

Non-Compliant MCCs

...

Description of Merchant Business Type

...

3000–3999

...

Airlines/Car Rental Companies/Hotels

...

4112

...

Passenger Railways

...

4411

...

Steamship and Cruise Lines

...

4511

...

Airlines and Air Carriers

...

4722

...

Travel Agencies and Tour Operators

...

5812

...

Eating Places and Restaurants

...

5814

...

Fast Food Restaurants

...

5962

...

Direct Marketing – Travel Related Arrangements Services (High Risk)

...

5966

...

Direct Marketing – Outbound Telemarketing Merchant (High Risk)

...

5967

...

Direct Marketing – Inbound Teleservices Merchant (High Risk)

...

7011

...

Lodging – Hotels, Motels, and Resorts

...

7512

...

Automobile Rental Agency

...

7513

...

Truck & Utility Trailer Rentals

    • or;

    • Within 7 days (for eligible large ticket transactions using corporate/purchasing cards).

  • Transaction must be authorized online and cannot be a cardholder-activated terminal (CAT) location.

  • The transaction must always include a non-zero tax amount

  • Business Card type transactions must always include an Address Verification System (AVS) reference.

Expand
titleVisa - Large Ticket Requirements

Large Ticket transactions refer to transactions with a larger total dollar amount.

Based on the transaction amount, your interchange rate may change to offer better pricing from Visa’s large ticket program for high-dollar-value transactions.

In addition to the data requirements above, the Visa card network has specific additional requirements to qualify for Large Ticket interchange pricing:

  • Clearing must follow authorization within 2 business days (no more than 1 day between auth and capture)

Expand
titleVisa - Prohibited Merchant Business Types (MCCs)

The following Merchant Commercial Code (MCC) types are disqualified from Level II or Level III data submission for interchange rate improvements:

Visa Non-Compliant MCCs List:

Non-Compliant MCCs

Description of Merchant Business Type

3000–3999

Airlines/Car Rental Companies/Hotels

4112

Passenger Railways

4411

Steamship and Cruise Lines

4511

Airlines and Air Carriers

4722

Travel Agencies and Tour Operators

5812

Eating Places and Restaurants

5814

Fast Food Restaurants

5962

Direct Marketing – Travel Related Arrangements Services (High Risk)

5966

Direct Marketing – Outbound Telemarketing Merchant (High Risk)

5967

Direct Marketing – Inbound Teleservices Merchant (High Risk)

7011

Lodging – Hotels, Motels, and Resorts

7512

Automobile Rental Agency

7513

Truck & Utility Trailer Rentals

...

MasterCard

In addition to the parameter qualifications below, MasterCard also requires the following conditions to be met from Merchants before they can submit Level II or Level III data for lower interchange rates:

  1. Merchants must process a combined total of 1 to 6 million MasterCard & Maestro transactions per year.

  2. Merchants must process between $20,000 and $1,000,000 in e-commerce transactions per year.

  3. Merchants must submit the following forms to the MasterCard:

    1. Annual Attestation of Compliance (AOC)

    2. Annual Self-Assessment Questionnaire (SAQ)

    3. Quarterly Network Scan by an Approved Scan Vendor (ASV2)

Read more information about MasterCard requirements below:

Expand
titleMasterCard - Qualifying Card Types for Interchange Data Submission

The following card types can be used for Level II data submission:

  • Corporate Purchasing

  • Business Credit

  • Enhanced Business Credit

  • Signature Business Credit


In addition to the above, the following card types can be used for Level III data submission:

  • Corporate Credit

  • Purchasing Credit

Note

Commercial Prepaid card type is not eligible.

Note

Warning: The following card types are ineligible for Level III data submission with MasterCard:

  • MBS - Mastercard B2B Product 1

  • MEF - Mastercard Electronic Payment Account

Expand
titleMasterCard - Level II Data Requirements

Level II data must include all Level I data requirements in addition to the requirements listed below.

Sales Tax Information - Sales tax information for each transaction including:

Sales Tax Amount

The total amount of sales tax applied to the transaction.

Note

Warning: The tax amount must be between 0.1% - 30% of the payment total to qualify. This is submitted using either a Sale or a Capture transaction type.

Sales Tax Indicator

Specify whether sales tax is included in the transaction amount or not.

Order Number

A unique identifier used by the merchant to locate the specific transaction information.

Note: “Order Number” and “Invoice Number” are interchangeable terms for Level II and Level III data submission.

Merchant Information - Details about the Merchant selling the product or service items including:

Customer Code

The unique identifier assigned to customers or entities within the Merchant’s records.

Merchant TIN

The tax identification number issued to the Merchant by their governmental tax agency.

Expand
titleMasterCard - Level III Data Requirements

Level III data must include all Level II data requirements in addition to the requirements listed below.

Line Item Details - Must provide detailed information for each item listed in a transaction including:

Discount Amount

Monetary reductions applied to the transaction total.

Discount Per Line Item

Monetary reductions applied to the product or service price for the line item.

Item Description

A detailed description of the product or service sold.

Line Item Total

Total transaction line item cost, calculated with quantity, unit price, discounts, tax, and shipping.

Product Code

A unique identifier used by the Merchant business to identify the specific product.

Quantity

The number of units sold.

Unit of Measure

A standardized unit used to quantify the quantity of the product or service.

Note

Warning: The following card types are ineligible for Level III interchange with MasterCard:

  • MBS - Mastercard B2B Product 1

  • MEF - Mastercard Electronic Payment Account

Expand
titleMasterCard - Additional Qualification Requirements

In addition to the interchange data requirements above, the MasterCard card network has specific additional requirements to qualify:

  • Clearing must follow an authorization request within 3 business days (no more than 2 days between auth and capture).

Expand
titleMasterCard - Large Ticket Requirements

Large Ticket transactions refer to transactions with a larger total dollar amount. Based on the transaction amount, your interchange rate may change to offer better pricing from MasterCard’s large ticket program for high-dollar-value transactions.

In addition to the data requirements above, the MasterCard network has specific additional requirements to qualify for Large Ticket interchange pricing:

  • Clearing must follow authorization within 2 business days (no more than 1 day between auth and capture).

Note

Warning: The following card types are ineligible for MasterCard’s large ticket program:

  • MAP - Mastercard Commercial Payments Account

  • MAQ - Mastercard Prepaid Commercial Payments Account

  • MEF - Mastercard Electronic Payment Account

Expand
titleMasterCard - Prohibited Merchant Business Types (MCCs)

The following Merchant Commercial Code (MCC) types are disqualified from Level II or Level III data submission for interchange rate improvements:

MasterCard Non-Compliant MCCs List:

Non-Compliant MCCs

Description of Merchant Business Type

3000–3999

Airlines/Car Rental Companies/Hotels

4112

Passenger Railways

4411

Steamship and Cruise Lines

4511

Airlines and Air Carriers

4722

Travel Agencies and Tour Operators

5812

Eating Places and Restaurants

5814

Fast Food Restaurants

5962

Direct Marketing – Travel Related Arrangements Services (High Risk)

5966

Direct Marketing – Outbound Telemarketing Merchant (High Risk)

5967

Direct Marketing – Inbound Teleservices Merchant (High Risk)

7011

Lodging – Hotels, Motels, and Resorts

7512

Automobile Rental Agency

7513

Truck & Utility Trailer Rentals

...

American Express

Merchants processing American Express transactions are required to obtain pre-approval before initiating Level II data processing. Level II data parameters from Visa or MasterCard would apply here.

To receive approval, Merchants must submit a “Level 2 Merchant’s Validation Documentation” which includes summaries from Quarterly Network Scan and a completed PCI Self Assessment Questionaire. Once granted, American Express accepts both Level I and Level II data, offering Level II interchange rates.

Visit the American Express US Data Security site for more information.

Warning

Unavailable: American Express does not offer discounts or changes in interchanges rates for Level III data submissions

...

Discover

Warning

Unavailable: American Express does not offer any discounts or changes in interchanges rates for Level II or Level III data submissions.

...

Submit Interchange Data with Transactions

To take advantage of lower interchange rates, this Level II and Level III data must be submitted alongside your transaction. This ensures the customer’s card brand network is able to receive and assess the data to determine which interchange rate the transaction will receive.

Info

Before you begin, we recommend checking each card’s eligibility for Level II and Level III processing as American Express and Discover don’t offer direct data submission options for Level II or III to qualify for lower interchange rates. A simple query shown below will quickly identify the card type:

GET https://test-api.payrix.com/bins

The response will display the method (card brand), type (debit, credit or both), and card category (personal, corporate card, etc.), which will allow you to know before submitting the additional data, if the card brand network supports lower interchange rates or Level II or Level III data submissions.

There are multiple methods to submit Level II or Level III data, read through the basic methods below to find the best workflow for your business:

Portal

The Portal offers a very simple way to manually enter and submit Level II and Level III values with payment transactions. Read the steps below to learn more:

Expand
titleSubmit Level II data using the Portal.

To submit Level II transaction data using the Create Payments page:

  • Step 1: Navigate to the Create Payment page under Payments

  • Step 2: Enter all applicable data. Then, under Customer Details, check “Submit this transaction as LEVEL 2 PROCESSING” to reveal Level II fields.

  • Step 3: Enter the TAX and ORDER NUMBER values.

  • Step 4: (Optional) Follow the steps below to also include Level III data.

Click Process Payment to complete the submission.

Expand
titleSubmit Level III data using the Portal.

To submit Level III transaction data using the Create Payments page:

  • Step 1: Complete steps 1-3 above from the Level II submission step above.

  • Step 2: Check “Submit this transaction as LEVEL 3 PROCESSING (All fields must be completed)” to reveal Level III fields.

  • Step 3: Enter the SHIPPING AMOUNT, DUTY AMOUNT & ORDER DISCOUNT value.

  • Step 4: Under Order Items, enter the DESCRIPTION, COMMODITY CODE, PRODUCT CODE, ITEM PRICE, ITEM DISCOUNT, QUANTITY, UNIT OF MEASURE, and ITEM TOTAL for each item.

  • Step 5: (Optional) Add additional Order Items as needed by clicking Add Item at the bottom of each new item form.

Info

Note: Each additional item must have the all fields above for Level 3 Transaction Processing

Click Process Payment to complete the submission.

...

API

The Payrix API provides a straightforward method of submitting Level II and Level III data values alongside transactions. Read the information below to learn more.

Expand
titleSubmit Level II data using the Payrix API.

To submit Level II transaction data using the /txns Payrix API endpoint, send the following request:

Code Block
POST https://test-api.payrix.com/txns
Code Block
languagejson
{
   "merchant":"{yourMerchantID}",
   "payment":{
      "number":"{customerCardNumber}",
      "cvv":"{customerCardCVV}"
   }
   "expiration":"MMYY",
   "type":2,
   "order":"INVOICE#1",
   "total":7799,
   "tax":100,
}

Required Parameters

Type

Description

Valid Values / Format

merchant

string

The identifier of the Merchant associated with this Transaction.

payment

object

The payment method associated with this Transaction, including the card details.

number

number

For credit payment method, the card number of the credit card associated with this Transaction.
For eCheck payment method, the bank account number is associated with this Transaction.

cvv

integer

The Card Verification Value (CVV) number of the credit card associated with this Transaction.

This field is expressed as a 3-digit integer.

expiration

number

The expiration date of the credit card associated with this Transaction.

This field is stored as a text string in 'MMYY' format, where 'MM' is the number of a month and 'YY' is the last two digits of a year. For example, '0623' for June 2023.

type

integer

The type of Transaction.

1 - Credit Card Only: Sale Transaction. Processes a sale and charges the customer.

2 - Credit Card Only: Auth Transaction. Authorizes and holds the requested total on the credit card.

3 - Credit Card Only: Capture Transaction. Finalizes a prior Auth Transaction and charges the customer.

4 - Credit Card Only: Reverse Authorization. Reverses a prior Auth or Sale Transaction and releases the credit hold.

5 - Credit Card Only: Refund Transaction. Refunds a prior Capture or Sale Transaction (total may be specified for a partial refund).

7 - eCheck Only: eCheck Sale Transaction. Sale Transaction for eCheck payment.

8 - eCheck Only: eCheck Refund Transaction. Refund Transaction for prior eCheck Sale Transaction.

11 - eCheck Only: eCheck Redeposit Transaction. Attempt to redeposit a prior failed eCheck Sale Transaction.

12 - eCheck Only: eCheck Account Verification Transaction. Attempt to verify eCheck payment details.

total

number

The total amount of this Transaction.

This field is specified as an integer in cents.

tax

integer

The amount of the total sum of this Transaction that is made up of tax.

This field is specified as an integer in cents.

Expand
titleSubmit Level III data using the Payrix API.

To submit Level III transaction data using the /txns Payrix API endpoint, send the following request:

Code Block
languagejson
{
   "merchant":"{yourMerchantID}",
   "payment":{
      "number":"{customerCardNumber}",
      "cvv":"{customerCardCVV}"
   }
   "expiration":"MMYY",
   "type":2,
   "order":"INVOICE#1",
   "total":7799,
   "tax":100,
   "items":[
      {
         "item":"Line Item #1",
         "description":"Line Item Description"
         "quantity":1,
         "price":7799,
         "um":"EACH",
         "commodityCode":"1111999",
         "total":5799,
         "discount":-2000,
         "productCode":"UPC12345"
      },
   ]
}

Note: Descriptions for Level II data shown here are available in the Submit Level II data using the Payrix API section above.

Required Parameters

Type

Description

Valid Values / Format

items

array of objects

The item or list of items associated with the transaction/order.

item

string

The line item name.

description

string

The line item description.

Max length: 500 characters

quantity

integer

The total number of units for the line item.

price

number

The individual line item price.

um

string

The line item units of measure.

Exmaple: “pounds”, “days”, “hours”.

Max length: 100 characters

commodityCode

string

The commodity code for this Item.

Max length:12 characters

total

integer

The total price for the line item.

This field is specified as an integer in cents

discount

integer

The discount for the line item.

This field is specified as an integer in cents.

productCode

string

The product code for this Item such as: UPC, catalog number, or inventory number.

...

PayFields

PayFields is a unique offering that seamlessly integrates a payment gateway into your existing HTML website package and eliminates PCI Compliance risk. Submitting Level II

Expand
titleSubmit Level II data using PayFields.

Step 1: Under your <script> tag containing PayFields.fields enter the following to add new Tax and Order fields to the PayFields

Code Block
languagehtml
<body>
  <div>
        <label for="number">Number:</label>
        <div id="number"></div>
      </div>
  <script>
    PayFields.fields = [
      {type: "number", element: "#number"},
      {type: "cvv", element: "#cvv"},
      {type: "name", element: "#name"},
      {type: "address", element: "#address"},
      {type: "expiration", element: "#expiration"}
      {type: "tax", element: "#tax"}
      {type: "order", element: "#order"}
    ];
  </script>
</body>
Code Block
  <body>
    
  

Code Block
languagehtml



<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <script type="text/javascript" src="https://test-api.payrix.com/payFieldsScript"></script>
  <title>PayFields Test</title>
</head>
<body>
<div id="submit">
  <!-- Button needed for PayFrame -->
</div>
<script>
    PayFields.button = {element: "#submit", value: "Pay"};
</script>
<script>
  PayFields.fields = [
    {type: "number", element: "#number"},
    {type: "cvv", element: "#cvv"},
    {type: "name", element: "#name"},
    {type: "address", element: "#address"},
    {type: "expiration", element: "#expiration"}
    {type: "tax", element: "#tax"}
    {type: "order", element: "#order"}
  ];
</script>
<script>
  PayFields.config.apiKey = "ab123c4def5g6hijkl7890m12345no6p";
  PayFields.config.merchant = "t1_mer_123ab4c567defg8h90123i45";
  PayFields.config.amount = 500;
</script>
<script>
  PayFields.customizations = {
    style: {
      ".input": {
        color: "#555",
        font: "14px Arial, Helvetica, sans-serif",
        background: "white"
      }
    }
  }
</script>
</body>
</html>