B2B API Specification

B2B Payment API

Level 3 Data

What is Level 3 data?

Level 3 data is additional information that may be applied to enrich a transaction’s reporting value to both the merchants and the customers. Generally, merchant service providers offer reduced or qualified pricing for transactions that are processed with Level 3 data.

Level 3 data can be added to any approved and unsettled Sale transaction with Visa or MasterCard. Some level 3 data, specifically enhanced data such as Invoice and Customer Reference ID, may overlap with data provided with the base transaction. Enhanced data, when applied, will always overwrite such data that may already be stored with the transaction.

Level 3 data consists of enhanced data and 1 or more line item records. This information is intended to describe the details of the transaction and the products or services rendered. However, defaults may be applied in the event when some data is missing or unknown. Skipped parameters will be replaced with PayTrace defaults.

Please make sure to set Level 3 defaults with your PayTrace Virtual Terminal Account before moving forward to add level 3 data methods.

Why do I need to enter Level 2 or Level 3 data?

Level 2 and 3 data is additional information that can be sent through with your transactions that can help qualify (keep processing rates low) certain types of credit cards. Level 2 and 3 data typically can help when accepting Business Cards, Purchasing Cards, Corporate Cards, or Government (GSA) Cards.

In most cases when you accept these types of cards, the dollar amount of the transaction is larger than if you were to accept a consumer/personal credit card. When the dollar amounts of the transactions go up, the risk associated with the card brands funding them goes up. This results in a higher processing rate due to the higher risk. However, level 2 and 3 data helps provide additional information about the merchant, customer, and transaction to help meet the card brand's criteria for reaching a lower processing rate. This additional information is not required to process or get funded for your transactions. However, providing this information helps reduce the risk associated with the funding of the transactions by the card brands, which results in lower processing rates.

For more information about specific level 2 and 3 information, click here

With MasterCard

post /v3/transaction/level3/mastercard/{transaction_id}

This method can be used to add Level 3 data to any approved and unsettled sale transaction with MasterCard.

You can add single or multiple line items as needed.

Parameters

transaction_id required

Type

string

X-Integrator-Id

Type

string

Maximum Length

X-Permalinks

Type

string

Maximum Length

Request Schema

invoice_number

Type

string

Example

customer_reference_id

Type

string

Maximum Length

Example

PO123456

tax_amount

Type

number

Example

2.16

national_tax_amount

Type

number

Example

0.41

freight_amount

Type

number

Example

duty_amount

Type

number

Example

source_address

Type

object

Example

[object Object]

shipping_address

Type

object

additional_tax_amount

Type

number

Example

0.39

merchant_id required

Type

integer

Example

246810

additional_tax_included

Type

boolean

Example

true

line_items

Type

array

Example Request

{
  "invoice_number": "17",
  "customer_reference_id": "PO123456",
  "tax_amount": 2.16,
  "national_tax_amount": 0.41,
  "source_address": {
    "postal_code": "99201"
  },
  "shipping_address": {
    "name": "Steve Smith",
    "street_address": "1 Main St.",
    "street_address2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "postal_code": "85284",
    "country": "US"
  },
  "additional_tax_amount": 0.39,
  "merchant_id": 246810,
  "additional_tax_included": true,
  "line_items": {
    "additional_tax_amount": 0.41,
    "additional_tax_rate": 0.08,
    "amount": 80.55,
    "description": "business services",
    "discount_amount": 3.27,
    "product_id": "sku1245",
    "quantity": 4,
    "unit_of_measure": "NMB",
    "unit_cost": 5.24,
    "additional_tax_included": true,
    "debit_or_credit": "C",
    "discount_rate": 0.01,
    "discount_included": true,
    "merchant_tax_id": "12-123456",
    "tax_included": true
  }
}

Example Response

200 Successful Response

422 Validation Error

With Visa

post /v3/transaction/level3/visa/{transaction_id}

This method can be used to add Level 3 data to an approved and unsettled sale transaction with a Visa card.

You can add none or multiple line items as needed.

Parameters

transaction_id required

Type

string

X-Integrator-Id

Type

string

Maximum Length

X-Permalinks

Type

string

Maximum Length

Request Schema

invoice_number

Type

string

Example

customer_reference_id

Type

string

Maximum Length

Example

PO123456

tax_amount

Type

number

Example

2.16

national_tax_amount

Type

number

Example

0.41

freight_amount

Type

number

Example

duty_amount

Type

number

Example

source_address

Type

object

Example

[object Object]

shipping_address

Type

object

additional_tax_amount

Type

number

Example

0.39

merchant_id required

Type

integer

Example

246810

additional_tax_rate

Type

number

Example

0.08

merchant_tax_id

Type

string

Example

3456test

customer_tax_id

Type

string

Example

3456defg

commodity_code

Type

string

Example

4321

discount_amount

Type

number

Example

0.01

line_items

Type

array

Example Request

{
  "invoice_number": "17",
  "customer_reference_id": "PO123456",
  "tax_amount": 2.16,
  "national_tax_amount": 0.41,
  "source_address": {
    "postal_code": "99201"
  },
  "shipping_address": {
    "name": "Steve Smith",
    "street_address": "1 Main St.",
    "street_address2": "Suite 12",
    "city": "Spokane",
    "state": "WA",
    "postal_code": "85284",
    "country": "US"
  },
  "additional_tax_amount": 0.39,
  "merchant_id": 246810,
  "additional_tax_rate": 0.08,
  "merchant_tax_id": "3456test",
  "customer_tax_id": "3456defg",
  "commodity_code": "4321",
  "discount_amount": 0.01,
  "line_items": {
    "additional_tax_amount": 0.41,
    "additional_tax_rate": 0.08,
    "amount": 80.55,
    "description": "business services",
    "discount_amount": 3.27,
    "product_id": "sku1245",
    "quantity": 4,
    "unit_of_measure": "NMB",
    "unit_cost": 5.24,
    "commodity_code": "4321"
  }
}

Example Response

200 Successful Response

422 Validation Error

Level 3 Data

With MasterCard

With Visa

Contact Us