{"_id":"5c6c23e4735b81006177d04b","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,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-02-22T19:32:03.376Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":19,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"While all `level3Data` 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\n###Request\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"h-3\": \"\",\n    \"0-0\": \"`customerReferenceNumber`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"Reference number used by shopper to track order\\nMax length: 17\",\n    \"0-3\": \"Reference number used by shopper to track order.\",\n    \"1-0\": \"`salesTaxAmount`\",\n    \"1-1\": \"*decimal*\",\n    \"1-2\": \"Total sales tax amount\\nMax length: 12\",\n    \"2-0\": \"`freightAmount`\",\n    \"3-0\": \"`dutyAmount`\",\n    \"4-0\": \"`destinationZipCode`\",\n    \"5-0\": \"`destinationCountryCode`\",\n    \"6-0\": \"`shipFromZipCode`\",\n    \"7-0\": \"`discountAmount`\",\n    \"8-0\": \"`taxAmount`\",\n    \"9-0\": \"`taxRate`\",\n    \"10-0\": \"`level3DataItems`\",\n    \"2-2\": \"Shipping amount\\nMax length:\\n* Mastercard: 9\\n* Visa: 12\",\n    \"3-2\": \"Total charges for import/export duties included in transaction\\nMax length:\\n* Mastercard: 9\\n* Visa: 12\",\n    \"4-2\": \"Destination zip code\\nMax length: 10\",\n    \"5-2\": \"Destination [country code](doc:country-codes)\\nMax length: 3\",\n    \"6-2\": \"The zip code of the location from where the items were shipped\\nMax length: 10\",\n    \"7-2\": \"Discount amount applied to transaction\\nMax length: 12\",\n    \"8-2\": \"Total tax/VAT amount for transaction\\nMax length: 12\",\n    \"9-2\": \"Tax/VAT rate applied to transaction\\nMax length: 4\",\n    \"10-2\": \"Container of [level3DataItems](doc:level3dataitems) properties. \\n\\n*May appear multiple times in request*\",\n    \"2-1\": \"*decimal*\",\n    \"3-1\": \"*decimal*\",\n    \"4-1\": \"*string*\",\n    \"5-1\": \"*string*\",\n    \"6-1\": \"*string*\",\n    \"7-1\": \"*decimal*\",\n    \"8-1\": \"*decimal*\",\n    \"9-1\": \"*decimal*\",\n    \"10-1\": \"*array*\",\n    \"1-3\": \"Total sales tax amount.\",\n    \"2-3\": \"Shipping amount.\",\n    \"3-3\": \"Total charges for import/export duties included in transaction.\",\n    \"4-3\": \"Destination zip code.\",\n    \"5-3\": \"Destination [country code](doc:country-codes).\",\n    \"6-3\": \"The zip code of the location from where the items were shipped.\",\n    \"7-3\": \"Discount amount applied to transaction.\",\n    \"8-3\": \"Total tax/VAT amount for transaction.\",\n    \"9-3\": \"Tax/VAT rate applied to transaction.\",\n    \"10-3\": \"Array containing one or more [level3DataItems](doc:level3dataitems) objects.\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`customerReferenceNumber`\",\n    \"1-0\": \"`salesTaxAmount`\",\n    \"2-0\": \"`freightAmount`\",\n    \"3-0\": \"`dutyAmount`\",\n    \"4-0\": \"`destinationZipCode`\",\n    \"5-0\": \"`destinationCountryCode`\",\n    \"6-0\": \"`shipFromZipCode`\",\n    \"7-0\": \"`discountAmount`\",\n    \"8-0\": \"`taxAmount`\",\n    \"9-0\": \"`taxRate`\",\n    \"11-0\": \"`level3DataItems`\",\n    \"0-1\": \"*string*\",\n    \"1-1\": \"*decimal*\",\n    \"2-1\": \"*decimal*\",\n    \"3-1\": \"*decimal*\",\n    \"4-1\": \"*string*\",\n    \"5-1\": \"*string*\",\n    \"6-1\": \"*string*\",\n    \"7-1\": \"*decimal*\",\n    \"8-1\": \"*decimal*\",\n    \"9-1\": \"*decimal*\",\n    \"11-1\": \"*array*\",\n    \"0-2\": \"Reference number used by shopper to track order.\",\n    \"1-2\": \"Total sales tax amount.\",\n    \"2-2\": \"Shipping amount.\",\n    \"3-2\": \"Total charges for import/export duties included in transaction.\",\n    \"4-2\": \"Destination zip code.\",\n    \"5-2\": \"Destination [country code](doc:country-codes).\",\n    \"6-2\": \"The zip code of the location from where the items were shipped.\",\n    \"7-2\": \"Discount amount applied to transaction.\",\n    \"8-2\": \"Total tax/VAT amount for transaction.\",\n    \"9-2\": \"Tax/VAT rate applied to transaction.\",\n    \"11-2\": \"Array containing one or more [level3DataItems](doc:level3dataitems) objects.\",\n    \"10-0\": \"`transactionProcessedWithL3dSupportedAcquirer`\",\n    \"10-1\": \"*boolean*\",\n    \"10-2\": \"Indicates whether transaction was processed with an acquirer that supports Level 2/3 data.\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]","excerpt":"Contains Level 2/3 data properties for the transaction","slug":"level3data","type":"basic","title":"level3Data"}

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

level3Data

Contains Level 2/3 data properties for the transaction

While all level3Data 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

customerReferenceNumber

string

Reference number used by shopper to track order
Max length: 17

salesTaxAmount

decimal

Total sales tax amount
Max length: 12

freightAmount

decimal

Shipping amount
Max length:

  • Mastercard: 9
  • Visa: 12

dutyAmount

decimal

Total charges for import/export duties included in transaction
Max length:

  • Mastercard: 9
  • Visa: 12

destinationZipCode

string

Destination zip code
Max length: 10

destinationCountryCode

string

Destination country code
Max length: 3

shipFromZipCode

string

The zip code of the location from where the items were shipped
Max length: 10

discountAmount

decimal

Discount amount applied to transaction
Max length: 12

taxAmount

decimal

Total tax/VAT amount for transaction
Max length: 12

taxRate

decimal

Tax/VAT rate applied to transaction
Max length: 4

level3DataItems

array

Container of level3DataItems properties.

May appear multiple times in request

Response

Property Name
Type
Description

customerReferenceNumber

string

Reference number used by shopper to track order.

salesTaxAmount

decimal

Total sales tax amount.

freightAmount

decimal

Shipping amount.

dutyAmount

decimal

Total charges for import/export duties included in transaction.

destinationZipCode

string

Destination zip code.

destinationCountryCode

string

Destination country code.

shipFromZipCode

string

The zip code of the location from where the items were shipped.

discountAmount

decimal

Discount amount applied to transaction.

taxAmount

decimal

Total tax/VAT amount for transaction.

taxRate

decimal

Tax/VAT rate applied to transaction.

transactionProcessedWithL3dSupportedAcquirer

boolean

Indicates whether transaction was processed with an acquirer that supports Level 2/3 data.

level3DataItems

array

Array containing one or more level3DataItems objects.