{"_id":"5c6c23e4735b81006177d04c","category":{"_id":"5c6c23e4735b81006177d011","version":"5c6c23e4735b81006177d0a4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-15T16:20:51.519Z","from_sync":false,"order":11,"slug":"resources","title":"JSON Objects"},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"_id":"5c6c23e4735b81006177d0a4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5bedd214812951004a2ad9df","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z","categories":["5c6c23e4735b81006177d006","5c6c23e4735b81006177d007","5c6c23e4735b81006177d008","5c6c23e4735b81006177d009","5c6c23e4735b81006177d00a","5c6c23e4735b81006177d00b","5c6c23e4735b81006177d00c","5c6c23e4735b81006177d00d","5c6c23e4735b81006177d00e","5c6c23e4735b81006177d00f","5c6c23e4735b81006177d010","5c6c23e4735b81006177d011","5c6c23e4735b81006177d012","5c6c23e4735b81006177d013","5c6c23e4735b81006177d014"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"Main","version_clean":"8976.0.0-JSON","version":"8976-JSON"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-02-22T20:04:29.595Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":22,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"While all `level3DataItems` properties are optional in the request, each data level (such as Level 2 and Level 3) has specific requirements. See the [Level 2/3 Data guide](/docs/level-23-data) for complete details.\"\n}\n[/block]\n###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"`lineItemTotal`\",\n    \"0-1\": \"*decimal*\",\n    \"0-2\": \"Total item amount\\nMax length:\\n* Mastercard:  9\\n* Visa: 12\",\n    \"0-3\": \"Total item amount.\",\n    \"1-0\": \"`commodityCode`\",\n    \"2-0\": \"`description`\",\n    \"3-0\": \"`discountAmount`\",\n    \"4-0\": \"`discountIndicator`\",\n    \"5-0\": \"`grossNetIndicator`\",\n    \"6-0\": \"`productCode`\",\n    \"7-0\": \"`itemQuantity`\",\n    \"8-0\": \"`taxAmount`\",\n    \"9-0\": \"`taxRate`\",\n    \"10-0\": \"`taxType`\",\n    \"11-0\": \"`unitCost`\",\n    \"12-0\": \"`unitOfMeasure`\",\n    \"1-1\": \"*string*\",\n    \"2-1\": \"*string*\",\n    \"3-1\": \"*decimal*\",\n    \"7-1\": \"*decimal*\",\n    \"8-1\": \"*decimal*\",\n    \"9-1\": \"*decimal*\",\n    \"11-1\": \"*decimal*\",\n    \"4-1\": \"*string*\",\n    \"5-1\": \"*string*\",\n    \"6-1\": \"*string*\",\n    \"10-1\": \"*string*\",\n    \"12-1\": \"*string*\",\n    \"1-2\": \"Commodity code used to classify item\\nMax length:  12\\n>**Important**\\n>For Visa, the commodity code must be numeric and cannot be all zeros or the transaction will fail.\",\n    \"2-2\": \"Item description\\nMax length: \\n* Amex: 40\\n* Mastercard: 35\\n* Visa: 26\",\n    \"3-2\": \"Discount amount applied to item\\nMax length: \\n* Mastercard: 9\\n* Visa: 12\",\n    \"4-2\": \"Indicates whether item amount is discounted\\nMax length: 1\\n\\nPossible values: \\n* **Y** — Item amount is discounted. \\n* **N** — Item amount is not discounted.\",\n    \"5-2\": \"Indicates whether tax is included in item amount\\nMax length: 1\\n\\nPossible values: \\n* **Y** — Tax is included in item amount \\n* **N** — Tax is not included in item amount.\",\n    \"6-2\": \"Product code for item\\nMax length: 12\",\n    \"7-2\": \"Item quantity purchased\\nMax length: 12\",\n    \"8-2\": \"Tax amount for item\\nMax length:\\n* Mastercard: 9\\n* Visa: 12\",\n    \"9-2\": \"Tax rate applied to item\\nMax length:\\n* Mastercard: 5\\n* Visa: 4\",\n    \"10-2\": \"Type of tax being applied\\nMax length: 4\",\n    \"11-2\": \"Unit cost\\nMax length: 12\",\n    \"12-2\": \"Unit of measure\\nMax length:\\n* Mastercard: 3\\n* Visa: 12\",\n    \"1-3\": \"Commodity code used to classify item.\\n>**Important**\\n>For Visa, the commodity code must be numeric and cannot be all zeros or the transaction will fail.\",\n    \"2-3\": \"Item description.\",\n    \"3-3\": \"Discount amount applied to item.\",\n    \"4-3\": \"Indicates whether item amount is discounted. \\n\\nPossible values: \\n* **Y** - Item amount is discounted. \\n* **N** - Item amount is not discounted.\",\n    \"5-3\": \"Indicates whether tax is included in item amount \\n\\nPossible values: \\n* **Y** - Tax is included in item amount \\n* **N** - Tax is not included in item amount.\",\n    \"6-3\": \"Product code for item.\",\n    \"7-3\": \"Item quantity purchased.\",\n    \"8-3\": \"Tax amount for item.\",\n    \"9-3\": \"Tax rate applied to item.\",\n    \"10-3\": \"Type of tax being applied.\",\n    \"11-3\": \"Unit cost.\",\n    \"12-3\": \"Unit of measure.\"\n  },\n  \"cols\": 3,\n  \"rows\": 13\n}\n[/block]\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-3\": \"Description\",\n    \"0-0\": \"`lineItemTotal`\",\n    \"0-1\": \"*decimal*\",\n    \"0-2\": \"Total item amount.\",\n    \"0-3\": \"Total item amount.\",\n    \"1-0\": \"`commodityCode`\",\n    \"2-0\": \"`description`\",\n    \"3-0\": \"`discountAmount`\",\n    \"4-0\": \"`discountIndicator`\",\n    \"5-0\": \"`grossNetIndicator`\",\n    \"6-0\": \"`productCode`\",\n    \"7-0\": \"`itemQuantity`\",\n    \"8-0\": \"`taxAmount`\",\n    \"9-0\": \"`taxRate`\",\n    \"10-0\": \"`taxType`\",\n    \"11-0\": \"`unitCost`\",\n    \"12-0\": \"`unitOfMeasure`\",\n    \"1-1\": \"*string*\",\n    \"2-1\": \"*string*\",\n    \"3-1\": \"*decimal*\",\n    \"7-1\": \"*decimal*\",\n    \"8-1\": \"*decimal*\",\n    \"9-1\": \"*decimal*\",\n    \"11-1\": \"*decimal*\",\n    \"4-1\": \"*string*\",\n    \"5-1\": \"*string*\",\n    \"6-1\": \"*string*\",\n    \"10-1\": \"*string*\",\n    \"12-1\": \"*string*\",\n    \"1-2\": \"Commodity code used to classify item.\",\n    \"2-2\": \"Item description.\",\n    \"3-2\": \"Discount amount applied to item.\",\n    \"4-2\": \"Indicates whether item amount is discounted. \\n\\nPossible values: \\n* **Y** - Item amount is discounted. \\n* **N** - Item amount is not discounted.\",\n    \"5-2\": \"Indicates whether tax is included in item amount \\n\\nPossible values: \\n* **Y** - Tax is included in item amount \\n* **N** - Tax is not included in item amount.\",\n    \"6-2\": \"Product code for item.\",\n    \"7-2\": \"Item quantity purchased.\",\n    \"8-2\": \"Tax amount for item.\",\n    \"9-2\": \"Tax rate applied to item.\",\n    \"10-2\": \"Type of tax being applied.\",\n    \"11-2\": \"Unit cost.\",\n    \"12-2\": \"Unit of measure.\",\n    \"h-2\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 13\n}\n[/block]","excerpt":"Contains Level 2/3 data properties for each item purchased","slug":"level3dataitems","type":"basic","title":"level3DataItems"}

Payment API (JSON)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

SEPA Direct Debit Transactions

Refunds

Vaulted Shoppers

Subscriptions

Marketplace

Wallets

Errors

JSON Objects

Test Data & Codes

Guides & Tools

Mobile SDK

level3DataItems

Contains Level 2/3 data properties for each item purchased

While all level3DataItems properties are optional in the request, each data level (such as Level 2 and Level 3) has specific requirements. See the Level 2/3 Data guide for complete details.

Request

Property Name
Type
Description

lineItemTotal

decimal

Total item amount
Max length:

  • Mastercard: 9
  • Visa: 12

commodityCode

string

Commodity code used to classify item
Max length: 12

Important
For Visa, the commodity code must be numeric and cannot be all zeros or the transaction will fail.

description

string

Item description
Max length:

  • Amex: 40
  • Mastercard: 35
  • Visa: 26

discountAmount

decimal

Discount amount applied to item
Max length:

  • Mastercard: 9
  • Visa: 12

discountIndicator

string

Indicates whether item amount is discounted
Max length: 1

Possible values:

  • Y — Item amount is discounted.
  • N — Item amount is not discounted.

grossNetIndicator

string

Indicates whether tax is included in item amount
Max length: 1

Possible values:

  • Y — Tax is included in item amount
  • N — Tax is not included in item amount.

productCode

string

Product code for item
Max length: 12

itemQuantity

decimal

Item quantity purchased
Max length: 12

taxAmount

decimal

Tax amount for item
Max length:

  • Mastercard: 9
  • Visa: 12

taxRate

decimal

Tax rate applied to item
Max length:

  • Mastercard: 5
  • Visa: 4

taxType

string

Type of tax being applied
Max length: 4

unitCost

decimal

Unit cost
Max length: 12

unitOfMeasure

string

Unit of measure
Max length:

  • Mastercard: 3
  • Visa: 12

Response

Property Name
Type
Description

lineItemTotal

decimal

Total item amount.

commodityCode

string

Commodity code used to classify item.

description

string

Item description.

discountAmount

decimal

Discount amount applied to item.

discountIndicator

string

Indicates whether item amount is discounted.

Possible values:

  • Y - Item amount is discounted.
  • N - Item amount is not discounted.

grossNetIndicator

string

Indicates whether tax is included in item amount

Possible values:

  • Y - Tax is included in item amount
  • N - Tax is not included in item amount.

productCode

string

Product code for item.

itemQuantity

decimal

Item quantity purchased.

taxAmount

decimal

Tax amount for item.

taxRate

decimal

Tax rate applied to item.

taxType

string

Type of tax being applied.

unitCost

decimal

Unit cost.

unitOfMeasure

string

Unit of measure.