Level III for API

 

All alpha characters should be in capital letters unless otherwise specified.

Property

Length

Format

Required?

Description

Level3

level3 (JSON format)

 

 

Required

Parent of the properties listed below.

TaxAmount

  • {Write} {minOccurs=”0” maxOccurs=”1”}

tax_amount (JSON format)

12

N

Required

Tax amount in dollars and cents. Child property of Level 3.

2 decimal/right justified/zero filled or space filled, (20.00)

Value should be >= $0.00

TaxRate

  • {Write} {minOccurs=”0” maxOccurs=”1”}

tax_rate (JSON format)

4

N

Optional

Tax rate applied to the item

2 decimal/right justified/zero filled or space filled, (1.00 = 1%)

AltTaxAmount

  • {Write} {minOccurs=”0” maxOccurs=”1”}

alt_tax_amount (JSON format)

9

N

Optional

Total amount of alternate tax associated with this transaction.

Note: If AltTaxAmount is populated, "AltTaxID” is required

 

AltTaxId

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

alt_tax_id (JSON format)

14

A

Optional

Tax ID number for the alternate tax associated with this transaction.

DiscountAmount

  • {Write} {minOccurs=”1” maxOccurs=”1”}

discount_amount (JSON format)

12

N

Required

Amount of discount applied to the total transaction.

2 decimal/right justified/zero filled or space filled, (20.00)

DutyAmount

  • {Write} {minOccurs=”0” maxOccurs=”1”}

duty_amount (JSON format)

12

N

Required

Total charges for any import and/or export duties included in this transaction.

2 decimal/right justified/zero filled or space filled, (20.00)

FreightAmount

  • {Write} {minOccurs=”0” maxOccurs=”1”}

freight_amount (JSON format)

12

N

Required

Total freight or shipping and handling charges.

2 decimal/right justified/zero filled or space filled, (20.00)

ShipFromZip

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

ship_from_zip (JSON format)

10

N

Optional

 

The zip/postal code of the location from which the goods were shipped.

ShipToAddress

ship_to_address (JSON format)

 

 

Optional

Parent of the properties listed below.

Address1

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

address_1 (JSON format)

28

A

Optional

The Street Address of the “ship to” location.

Required Character Format is UPPER.

City

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

city (JSON format)

20

A

Optional

The City of the “ship to” location.

Required Character Format is UPPER.

State

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

state (JSON format)

2

A

Optional

The State of the “ship to” location.

Required Character Format is UPPER.

Zip

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

zip (JSON format)

10

N

Optional

The Zip/postal code of the “ship to” location.

Country

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

country (JSON format)

2

A

Optional

The ISO-assigned code of the country to which the goods were shipped.

US – United States,CA – Canada,GB – Great Britain,UK – United Kingdom,“ “ – Blank for all other countries)

CustomerNumber

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

customer_number (JSON format)

20

A

Optional

Purchase order or other number used by merchant’s customer to track the order.

Email

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

email (JSON format)

50

A

Optional

The Accountholder’s email address associated with the transaction. 

Name

  • String [28]
  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

name (JSON format)

28

A

Optional

The Accountholder’s name associated with the transaction. 

asterisk should precede last name ex: *LAST

Phone

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

phone (JSON format)

14

A

Optional

The Accountholder’s phone number associated with the transaction. 

AAAEEENNNNXXXX where: AAA = Area Code, EEE = Exchange, NNNN = Number, XXXX = Extension

LineItem

line_items (JSON format)

 

 

Required

Parent of the properties listed below. There is a limit of 99 line items for a single transaction.

CommodityCode

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

commodity_code (JSON format)

12

N

Required

The commodity code used to classify the item purchased. For Complete List of Commodity Codes, click here.

 

Description

  • {Read/Write} {minOccurs=”1” maxOccurs=”1”}

description (JSON format)

26

N

Required

Item description. 

Required Character Format is ASCII.

 

DiscountAmount

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

discount_amount (JSON format)

12

N

Required

The discounted amount for the line item. 

2 decimal/right justified/zero filled or space filled, (100.00)

 

DiscountIndicator

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

discount_indicator (JSON format)

 

B

Required

Indicator for whether a discount is present on the item or not. 

1 – Discounted

0 – Not Discounted

 

GrossNetIndicator

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

gross_net_indicator (JSON format)

 

B

Required

Indicates whether tax is included in the total amount or not. 

1 – Tax included

0 – Tax Excluded

 

LineItemTotal

  • {Read/Write} {minOccurs=”1” maxOccurs=”1”}

line_item_total (JSON format)

12

N

Required

The amount of the item. Normally calculated as price multiplied by quantity.

2 decimal/right justified/zero filled, (200.00)

 

ProductCode

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

product_code (JSON format)

12

A

Required

The UPC product code for the line item. 

Required Character Format is ASCII. 

 

Quantity

  • {Read/Write} {minOccurs=”1” maxOccurs=”1”}

quantity (JSON format)

5

N

Required

 

Number of units of the item purchased 

 

 

TaxAmount

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

tax_amount (JSON format)

12

N

Optional

The amount of tax charged on the line item. 

2 decimal/right justified/zero filled or space filled (50.00)

 

TaxRate

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

tax_rate (JSON format)

4

N

Optional

The rate of tax charged on the line item.

2 decimal/right justified/zero filled or space filled, (1.00 = 1%)

TaxType

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

tax_type (JSON format)

4

A

Optional

Type of tax being applied.

UnitCost

  • {Read/Write} {minOccurs=”1” maxOccurs=”1”}

unit_cost (JSON format)

12

N

Required

The per unit cost of the line item. 

4 decimal/right justified/zero filled or space filled, (100.0000)

UnitOfMeasure

  • {Read/Write} {minOccurs=”0” maxOccurs=”1”}

unit_of_measure (JSON format)

12

A

Required

The unit of measure, or unit of measure code used for this item

Note: Please note that Level III data is not supported for American Express card types.

 

The following is an example of a transaction that makes use of the Level 3 fields, using the REST format.

<?xml version="1.0" encoding="utf-8" ?>
<Transaction>
  <ExactID>A1234-01</ExactID>
  <Password>12345pwd</Password>
  <Card_Number>5454545454545454</Card_Number>
  <CardHoldersName>LARRY SELLERS</CardHoldersName>
  <Transaction_Type>00</Transaction_Type>
  <Expiry_Date>0915</Expiry_Date>
  <DollarAmount>168.67</DollarAmount>
    <Level3>
     <TaxAmount>8.84</TaxAmount>
     <TaxRate>7.25</TaxRate>
     <AltTaxAmount>0.0</AltTaxAmount>
     <AltTaxId></AltTaxId>
     <DiscountAmount>30.00</DiscountAmount>
     <DutyAmount>12.90</DutyAmount>
     <FreightAmount>24.99</FreightAmount>
     <ShipFromZip>90265</ShipFromZip>
    <ShipToAddress>
       <Address1>1234 QUINTANA RD</Address1>
       <City>VENICE</City>
       <Country>US</Country>
       <CustomerNumber>90125</CustomerNumber>
       <Email>JACKIE@JACKCUSTOMER.COM</Email>
       <Name>LARRY *SELLERS</Name>
       <Phone>8185551212</Phone>
       <State>CA</State>
       <Zip>90291</Zip>
    </ShipToAddress>
    <LineItem>
        <CommodityCode>014048675309</CommodityCode>
        <Description>CARPET CLEANER</Description>
        <DiscountAmount>30.00</DiscountAmount>
        <DiscountIndicator>1</DiscountIndicator>
        <GrossNetIndicator>1</GrossNetIndicator>
        <LineItemTotal>107.20</LineItemTotal>
        <ProductCode>PN0339763321</ProductCode>
        <Quantity>PN0339763321</Quantity>
        <TaxAmount>7.25</TaxAmount>
        <TaxRate>7.25</TaxRate>
        <TaxType>4</TaxType>
        <UnitCost>2.33</UnitCost>
        <UnitOfMeasure>QTL</UnitOfMeasure>
    </LineItem>
    <LineItem>
        <CommodityCode>133042775322</CommodityCode>
        <Description>NON DAIRY CREAMER</Description>
        <DiscountAmount>00.00</DiscountAmount>
        <DiscountIndicator>0</DiscountIndicator>
        <GrossNetIndicator>1</GrossNetIndicator>
        <LineItemTotal>23.58</LineItemTotal>
        <ProductCode>PN0000090125</ProductCode>
        <Quantity>1</Quantity>
        <TaxAmount>1.59</TaxAmount>
        <TaxRate>7.25</TaxRate>
        <TaxType>4</TaxType>
        <UnitCost>00.22</UnitCost>
        <UnitOfMeasure>CS</UnitOfMeasure>
    </LineItem>
  </Level3>
</Transaction>

 

 
JSON Level 3 Example:

curl -H 'Content-Type: application/json; charset=UTF-8' \
     -H 'Accept: application/json' \
     -d '{ 
"gateway_id": "A1234-01", 
"password": "12345pwd", 
"transaction_type": "00", 
"amount": 11, 
"cardholder_name": "LARRY SELLERS", 
"cc_number": "5454545454545454", 
"cc_expiry": "0315",
"level3": {
	"ship_from_zip": "90265",
	"duty_amount": 12.90,
	"discount_amount": 30.00,
	"freight_amount": 24.99,
	"line_items": [{
		"description": "CARPET CLEANER",
		"product_code": "PN0339763321",
		"quantity": 5,
		"unit_of_measure": "QTL",
		"line_item_total": 107.20,
		"commodity_code": "014048675309",
		"unit_cost": 2.33}],
	"ship_to_address": {
		"name": "LARRY *SELLERS",
		"address_1": "1234 QUINTANA RD",
		"city": "VENICE"}}
}' \
https://api.globalgatewaye4.firstdata.com/transaction/v11

 

Powered by Zendesk