Description:
Credit card processing methods fit into three levels: Level 1, Level 2 and Level 3. Each level is defined by the amount of information that is required or passed to complete a payment with Level 1 having the lowest requirements and potentially the highest costs.
Level 2 and Level 3 card data (also known as Level II and Level III) is a set of additional information that can be passed during a credit card transaction. Level 2 and Level 3 card data provides more information for business, commercial, corporate, purchasing, and government cardholders.
Credit card transactions submitted with Level 2 and Level 3 card data can obtain lower interchange rates and provide merchants with a lower processing cost. Therefore, it is in the best interest of merchants to submit Level 2 and Level 3 card data whenever possible.
Each card type that supports Level 2 maintains its own standards for the additional field information that is accepted. Potential fields include:
-
Purchase Order number
-
Destination Zip
-
Tax Indicator
-
Tax Amount
-
Requestor Name
-
Destination Address
-
Destination City
-
Destination State
Level 3 payments require all of the information required for Level 2 and will need to include additional information to complete the payment to reduce transaction costs. These additional fields may include:
-
Item ID or SKU
-
Item description
-
Unit price
-
Extended price
-
Unit of measure (each)
-
Commodity code
-
Line discount
Element Name |
Onepay API parameter |
Data Type length |
Required |
Auto Enriched Value |
Description |
PURCHASE CARD L2 Group |
|||||
Purchase Identifier |
invoice_number |
25 |
M – V,M,A |
1623919455 |
The field is for identifying the purchase card transactions |
Tax Indicator |
level2_information.taxable |
1 |
M – V,M |
0 |
The tax indicator is used in the automatic determination of the tax code in Purchasing |
Tax Amount |
level2_information.tax_amount |
12 |
C |
156.45 |
Amount to be paid as tax |
Order Number / Customer Reference Number |
invoice_number |
17 |
C |
2.10617E+11 |
A number identifying a purchase or order placed by a customer. |
VAT/ Alternate TAX Amount |
level2_information.vat_tax_amount |
12 |
O |
none |
A value-added tax (VAT), known in some countries as a goods and services tax (GST), is a type of tax that is assessed incrementally. |
VAT/ Alternate TAX Rate |
level2_information.vat_tax_rate |
4 |
O |
none |
A alternate tax rate is the percentage at which an individual or corporation is taxed. |
Discount Amount |
level2_information.invoice_discount_amount |
12 |
M – V,M,A |
none |
The term discount refers to the amount or percentage deducted from the normal selling price of something. |
Freight Amount |
none |
12 |
M – V,M,A |
none |
A freight rate (historically and in ship chartering simply freight) is a price at which a certain cargo is delivered from one point to another. |
Duty Amount |
none |
12 |
none |
Duty is the amount of money paid by the importer or exporter of goods and services according to a tariff. |
|
Destination Postal Code |
shipping_information.zip |
9 |
M – A |
340003 |
A postal code to which the shipping will go to. |
Ship From Postal Code |
shipping_information.zip |
9 |
O |
340003 |
A postal code from where the product is sent |
Destination Country Code |
shipping_information.country |
3 |
O |
840 |
A country code to which the shipping will go to. |
Merchant Tax ID |
none |
15 |
M-M |
455665655 |
Merchant tax identification numbers are nine-digit tracking numbers used by the IRS following tax laws. |
Product Description |
hardcoded (“ProdDesc”) |
40 |
M-A |
Description of the product |
|
PC3 Addenda |
level3_information.count |
3 |
M |
none |
|
Merchant Reference Number |
null |
17 |
M-V |
Merchant ID |
|
Merchant Type |
null |
4 |
O |
none |
Type of merchant |
Commercial Card Type |
null |
2 |
O |
none |
Type of business card |
Order Date |
null |
6 (YYMMDD) |
O |
Date of the order |
|
Order Time |
null |
6 (HHMMAA) |
O |
Time of order |
|
Biller Reference Number |
null |
25 |
O |
Reference number of the biller |
|
SKU |
nonce |
15 |
O |
none |
SKU (pronounced “skew”), short for stock keeping unit, is used by retailers to identify and track its inventory, or stock. |
PURCHASE CARD L3 Group |
|||||
Item Sequence Number |
auto generated |
3 |
0 |
Sequence number of Item |
|
Item Code |
level3_information.item_code |
12 |
M-V |
none |
Code of the Item |
Item Description |
nonce |
35 |
M-V |
1567165710 |
Description of Item |
Level 3 Item Quantity |
hardcoded (1.00) |
12 |
M-V.M |
1 |
Quantity of the item |
Level 3 Item Quantity Exponent |
null |
1 |
M-V |
1 |
|
Level 3 Unit of Measure |
harcoded(ACR) |
12 |
M-V,M |
ACR |
Measuring unit |
Level 3 Unit Cost |
level3_information.item_unitprice |
12 |
M-V |
Unit cost of the product |
|
Level 3 Unit Cost Exponent |
null |
1 |
0-M |
1 |
|
Level 3 Line Item Total |
unit cost*item quantity |
12 |
M-M |
The total from unit cost and quantity of the item. |
|
Level 3 Discount Amount |
level3_information.item_discount_amount |
12 |
0-V,M |
Discount amount on the item |
|
Level 3 VAT/ Alternate TAX Amount |
level3_information.item_vat_rate*Level 3 Line Item Total |
12 |
0 |
VAT amount on the item |
|
Level 3 VAT/ Alternate TAX Rate |
level3_information.item_vat_rate |
5 |
2 |
VAT rate on the item |
|
Level 3 Product Code |
level3_information.item_commodity_code |
12 |
M-V |
12 |
Product code of the item |
Level 3 Extended Item Amount |
Level 3 Unit Cost*Level 3 Item Quantity |
12 |
M-M |
0 |
Unit cost of the item |
Level 3 Tax Indicator |
level3_information.item_taxable |
1 |
M-M |
1 |
Tax indicator of the item |
Level 3 Tax Rate |
level3_information.item_tax_rate |
5 |
M-M |
2 |
Tax rate of the item |
Level 3 Tax Rate Exponent |
null |
1 |
M-M |
1 |
|
Level 3 National TAX Amount |
null |
12 |
M-V |
National tax amount |
|
Level 3 National TAX Rate |
null |
12 |
O-V |
National tax rate |
|
Level 3 Merchant VAT Registration |
null |
20 |
O-V |
Merchant VAT registration |
|
Level 3 Other Tax Amount |
null |
12 |
O-V |
Other tax amount |
|
Level 3 TAX Type Applied |
null |
4 |
C-V,M |
Applicable tax type |
|
Level 3 Tax Amount |
level3_information.item_tax_amount |
9 |
M-M |
Tax amount on the item |
|
Level 3 Debit/Credit Indicator |
null |
1 |
M-M |
||
Level 3 Line Item Detail Indicator |
null |
1 |
M-V |
||
Level 3 Summary Commodity Code |
null |
4 |
M-V |
Commodity code |
|
Level 3 Product Descriptor |
null |
200 |
O-V,M |
ProdDesc |
Product description |
Level 3 Tax Type Identifier |
hardcode(00-unknown) |
2 |
M-M |
0 |
Tax identifier |
Detailed Description:
Level 2 Information:
Purchase Identifier: This field must be present for Visa, MasterCard and American Express Purchase Card transactions.
Tax Indicator: For Visa and MasterCard Purchase Card transactions only. Boolean indicator if tax is included.
Tax Amount: Must be present if TaxInd = 1
Order Number / Customer Reference Number: If purchase card L2 Group. Tax Amount is provided, this field must also be provided
Destination Postal Code: This field must be present for American Express Purchase Card transactions.
Merchant Tax ID: This field must be present for MasterCard Purchase Card transactions.
Product Description: Applicable to American Express Purchase Card transactions only. If multiple products are being purchased then this field should repeat for each product grouping up to a maximum of four occurrences. Up to four occurrences of the Product Description field may be contained within a single authorization request message.
Level 3 Information:
Item Sequence Number: Incremental. Should not exceed 99
Item Description: For Visa the maximum length is 26 characters.
Level 3 Item Quantity: This field is mandatory for Visa and MasterCard purchase card level 3 transactions. MC Max length 5 digits. Decimals
Level 3 Product Code: This field is mandatory for MasterCard BatchSettleL3 transactions. This field is optional for Visa BatchSettleL3 transactions.
Level 3 Extended Item Amount: This field is applicable only in a BatchSettleL3 Transaction. This field is mandatory for MasterCard BatchSettleL3 transactions. This field is optional for Visa BatchSettleL3 transactions.
Level 3 Tax Indicator: 0 – Tax Amount is provided 1 – Purchase item is tax exempt or non-taxable 2 – No tax information provided. This field is only applicable to MasterCard BatchSettleL3 transaction. This field is mandatory for MasterCard BatchSettleL3 transactions.
Level 3 Tax Rate: This field is only applicable to MasterCard Level 3 transactions. This field is mandatory for MasterCard transactions that include Level 3 data.
Level 3 Product Descriptor: This optional field is only applicable to Visa and MasterCard BatchSettleL3 transactions.
Request with L2 data:
{ "amount": "1017.33", "method": "CC", "type": 2, "nonce": {{$timestamp}}, "test": "0", "client_ip": "106.51.27.43", "market_code": "M", "notes": "", "invoice_number": {{$timestamp}}, "card": { "number": "4005562231212149", "expiration_date": "1225", "code": "123" }, "customer": { "first_name": "John", "last_name": "Doe", "street_1": "1307 Broad Hollow Road", "street_2": "", "city": "Melville", "state": "NY", "zip": "11747", "country": "", "phone_number": "", "company": "", "customer_id": "", "email": "john.doe@gmail.com", "email_receipt": "", "notes": "", "sms_receipt": 0 }, "additional_data": [ { "id": "USERID", "value": "1" }, { "id": "USER", "value": "John" }, { "id": "SOURCE", "value": "PS" } ], "level2_information": { "Invoice_discount_amount": "10.25", "purchaser_vat_registration_number": "1425", "merchant_vat_registration_number": "1568", "merchant_vat_invoice_reference_number": "1454", "summary_commodity_code": "455", "tax_amount": "10.35", "tax_after_discount_indicator": "1", "vat_tax_rate": "2.5", "vat_tax_amount": "1.25", "taxable": "0" }, "shipping_information": { "first_name": "John", "last_name": "Doe", "company": "XYZ", "address": "1307 Broad Hollow Road", "city": "Melville", "state": "NY", "zip": "11747", "country": "US" } }
Response:
"{ \"transaction_response\": { \"result_code\": 1, \"result_sub_code\": \"000\", \"result_text\": \"APPROVED\", \"transaction_id\": \"1125497\", \"transaction_uid\": \"d89d6fd0-057c-460e-939c-030120c3ecec\", \"transaction_datetime\": \"20220505T105002Z\", \"account_type\": \"VI\", \"account_last_4\": \"2149\", \"amount\": \"1,017.33\", \"approved_amount\": \"1,017.33\", \"method\": \"CC\", \"auth_code\": \"OK4045\", \"avs_result_code\": \"Y\", \"code_result\": \"M\", \"type\": \"2\", \"expiration_date\": \"1225\", \"token\": \"1d3e64a6d2eb474e8d72edddccc22347\", \"emv\": \"\", \"emv_tag_data\": \"\", \"entry_mode\": \"01\" }, \"nonce\": \"1651747801\", \"test\": \"0\", \"customer\": { \"first_name\": \"John\", \"last_name\": \"Doe\", \"street_1\": \"1307 Broad Hollow Road\", \"street_2\": \"\", \"city\": \"Melville\", \"state\": \"NY\", \"zip\": \"11747\", \"country\": \"\", \"phone_number\": \"\", \"company\": \"\", \"customer_id\": \"\", \"email\": \"john.doe@gmail.com\", \"email_receipt\": \"NO\", \"notes\": \"\", \"action_code\": \"\" }, \"card_info\": { \"card_class\": \"P\", \"product_id\": \"S\", \"prepaid_indicator\": \"\", \"detailcard_indicator\": \"X\", \"debitnetwork_indicator\": \"\" }}"
Request with L3 data:
{ "amount": "156.47", "method": "CC", "type": 2, "nonce": {{$timestamp}}, "test": "0", "client_ip": "106.51.27.43", "market_code": "M", "notes": "100027150010", "invoice_number": {{$timestamp}}, "card": { "number": "5405001111111165", "expiration_date": "1225", "code": "123" }, "customer": { "first_name": "John", "last_name": "Doe", "street_1": "1307 Broad Hollow Road", "street_2": "", "city": "Melville", "state": "NY", "zip": "11747", "country": "", "phone_number": "", "company": "", "customer_id": "", "email": "john.doe@gmail.com", "email_receipt": "", "notes": "", "sms_receipt": 0 }, "additional_data": [ { "id": "USERID", "value": "1" }, { "id": "USER", "value": "John" }, { "id": "SOURCE", "value": "PS" } ], "shipping_information": { "first_name": "John", "last_name": "Doe", "company": "XYZ", "address": "1307 Broad Hollow Road", "city": "Melville", "state": "NY", "zip": "11747", "country": "US" }, "level3_information": [ { "item_code": "211", "item_description": "", "item_quantity": "2", "item_unitprice": "1", "item_taxable": "1", "item_tax_rate": "2", "item_tax_amount": "50", "item_total_amount": "250", "item_commodity_code": "12", "item_product_code": "12", "item_discount_amount": "120", "item_vat_rate": "2.5" }, { "item_code": "212", "item_description": "", "item_quantity": "2", "item_unitprice": "1", "item_taxable": "1", "item_tax_rate": "2.5", "item_tax_amount": "50", "item_total_amount": "250", "item_commodity_code": "12", "item_product_code": "12", "item_discount_amount": "120", "item_vat_rate": "2.5" }, { "item_code": "213", "item_description": "", "item_quantity": "2", "item_unitprice": "1", "item_taxable": "1", "item_tax_rate": "2.5", "item_tax_amount": "50", "item_total_amount": "250", "item_commodity_code": "12", "item_product_code": "12", "item_discount_amount": "120", "item_vat_rate": "2.5" } ] }
Response:
"{ \"transaction_response\": { \"result_code\": 1, \"result_sub_code\": \"000\", \"result_text\": \"APPROVED\", \"transaction_id\": \"1125498\", \"transaction_uid\": \"a480ad5b-cb9d-4b72-9b80-e8aaff3056dd\", \"transaction_datetime\": \"20220505T105430Z\", \"account_type\": \"MC\", \"account_last_4\": \"1165\", \"amount\": \"156.47\", \"approved_amount\": \"156.47\", \"method\": \"CC\", \"auth_code\": \"OK5475\", \"avs_result_code\": \"Y\", \"code_result\": \"M\", \"type\": \"2\", \"expiration_date\": \"1225\", \"token\": \"27980193f5a14fe283f0d447340fc9fb\", \"emv\": \"\", \"emv_tag_data\": \"\", \"entry_mode\": \"01\" }, \"nonce\": \"1651748069\", \"test\": \"0\", \"customer\": { \"first_name\": \"John\", \"last_name\": \"Doe\", \"street_1\": \"1307 Broad Hollow Road\", \"street_2\": \"\", \"city\": \"Melville\", \"state\": \"NY\", \"zip\": \"11747\", \"country\": \"\", \"phone_number\": \"\", \"company\": \"\", \"customer_id\": \"\", \"email\": \"john.doe@gmail.com\", \"email_receipt\": \"NO\", \"notes\": \"\", \"action_code\": \"\" }, \"card_info\": { \"card_class\": \"P\", \"product_id\": \"MC\", \"prepaid_indicator\": \"\", \"detailcard_indicator\": \"C\", \"debitnetwork_indicator\": \"25P30P00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00\" }}"
Request with L2L3 data:
{ "amount": "156.45", "method": "CC", "type": 1, "nonce": {{$timestamp}}, "test": "0", "client_ip": "106.51.27.43", "market_code": "M", "notes": "100027140010", "invoice_number": {{$timestamp}}, "card": { "number": "5405001111111165", "expiration_date": "1225", "code": "123" }, "customer": { "first_name": "John", "last_name": "Doe", "street_1": "1307 Broad Hollow Road", "street_2": "", "city": "Melville", "state": "NY", "zip": "11747", "country": "john.doe@gmail.com", "phone_number": "", "company": "", "customer_id": "", "email": "a", "email_receipt": "", "notes": "", "sms_receipt": 0 }, "additional_data": [ { "id": "USERID", "value": "1" }, { "id": "USER", "value": "John" }, { "id": "SOURCE", "value": "PS" } ], "level2_information": { "Invoice_discount_amount": "10.25", "purchaser_vat_registration_number": "1425", "merchant_vat_registration_number": "1568", "merchant_vat_invoice_reference_number": "1454", "summary_commodity_code": "455", "tax_amount": "10.35", "tax_after_discount_indicator": "1", "vat_tax_rate": "2.5", "vat_tax_amount": "1.25", "taxable": "1" }, "shipping_information": { "first_name": "rancho", "last_name": "Chahal", "company": "XYZ", "address": "1212", "city": "jdp", "state": "rajasthan", "zip": "340003", "country": "india" }, "level3_information": [ { "item_code": "211", "item_description": "", "item_quantity": "2", "item_unitprice": "1", "item_taxable": "1", "item_tax_rate": "2", "item_tax_amount": "50", "item_total_amount": "250", "item_commodity_code": "12", "item_product_code": "12", "item_discount_amount": "120", "item_vat_rate": "2.5" }, { "item_code": "212", "item_description": "", "item_quantity": "2", "item_unitprice": "1", "item_taxable": "1", "item_tax_rate": "2.5", "item_tax_amount": "50", "item_total_amount": "250", "item_commodity_code": "12", "item_product_code": "12", "item_discount_amount": "120", "item_vat_rate": "2.5" }, { "item_code": "213", "item_description": "", "item_quantity": "2", "item_unitprice": "1", "item_taxable": "1", "item_tax_rate": "2.5", "item_tax_amount": "50", "item_total_amount": "250", "item_commodity_code": "12", "item_product_code": "12", "item_discount_amount": "120", "item_vat_rate": "2.5" }, { "item_code": "214", "item_description": "", "item_quantity": "2", "item_unitprice": "1", "item_taxable": "1", "item_tax_rate": "2.5", "item_tax_amount": "50", "item_total_amount": "250", "item_commodity_code": "12", "item_product_code": "12", "item_discount_amount": "120", "item_vat_rate": "2.5" } ] }
Response:
"{ \"transaction_response\": { \"result_code\": 1, \"result_sub_code\": \"000\", \"result_text\": \"APPROVED\", \"transaction_id\": \"1125496\", \"transaction_uid\": \"bc5284b4-2cda-4ccc-9df5-67092a35cca3\", \"transaction_datetime\": \"20220505T104602Z\", \"account_type\": \"MC\", \"account_last_4\": \"1165\", \"amount\": \"156.45\", \"approved_amount\": \"156.45\", \"method\": \"CC\", \"auth_code\": \"OK2785\", \"avs_result_code\": \"Y\", \"code_result\": \"M\", \"type\": \"1\", \"expiration_date\": \"1225\", \"token\": \"27980193f5a14fe283f0d447340fc9fb\", \"emv\": \"\", \"emv_tag_data\": \"\", \"entry_mode\": \"01\" }, \"nonce\": \"1651747560\", \"test\": \"0\", \"customer\": { \"first_name\": \"John\", \"last_name\": \"Doe\", \"street_1\": \"1307 Broad Hollow Road\", \"street_2\": \"\", \"city\": \"Melville\", \"state\": \"NY\", \"zip\": \"11747\", \"country\": \"\", \"phone_number\": \"\", \"company\": \"\", \"customer_id\": \"\", \"email\": \"john.doe@gmail.com\", \"email_receipt\": \"NO\", \"notes\": \"\", \"action_code\": \"\" }, \"card_info\": { \"card_class\": \"P\", \"product_id\": \"MC\", \"prepaid_indicator\": \"\", \"detailcard_indicator\": \"C\", \"debitnetwork_indicator\": \"25P30P00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00\" }}"