Menu

Developer Resources

  • All Files

LineItem Element

Expand/Collapse All

The LineItem element contains detailed product, promotion, and seller information for the item.

ClosedProductCode

Data Type: String

Required For: All

Description: The merchant-maintained product code for the product/service.

ClosedProductDescription

Data Type: String

Required For:All

Description: The merchant-defined product description. Description length not to exceed 120 characters including spaces and special characters.

ClosedQuantity

Data Type: Integer

Required For: All

Description: The line item quantity.

ClosedUnitPrice

Data Type: Currency

Required For: All

Description: The unit price for the line item.

ClosedDiverseCart Element

The DiverseCart element provides important details about the contents of the shopping cart. This element is used by the merchants who have diverse product or service offerings. Consult your Integration Specialist for details.

ClosedSKU

Data Type: String

Required For: All

Description: The merchant maintained SKU, if applicable.

ClosedProductType

Data Type: String

Required For: All

Description: The product type for the line item. Consult your Integration Specialist for details.

ClosedCategory

Data Type: String

Required For: All

Description: The product category for the line item. Consult your Integration Specialist for details.

ClosedSubCategory

Data Type: String

Required For: All

Description: The sub-category for the line item. Consult your Integration Specialist for details.

ClosedBrand

Data Type: String

Required For: All

Description: The brand name of the product, such as Calvin Klein.

ClosedPromotion Element

The Promotion element provides information about the discounts applied to the line item only – not the whole transaction. Discounts for individual line items are addressed in the Promotion Element section.

ClosedDiscount

Data Type: Currency

Required For: All

Description: The amount of the discount.

ClosedCode

Data Type: String

Required For: All

Description: The code that represents the discount.

ClosedDescription

Data Type: String

Required For: All

Description: A short description of the discount.

ClosedGiftCards Element

The GiftCards element provides details specific to gift card merchants.

ClosedFrom

Data Type: String

Required For: Gift Cards

Description: The value of the “From” field.

ClosedText

Data Type: String

Required For: Gift Cards

Description: Contents of the message in the gift card. Limited to 120 characters (includes spaces and special characters).

ClosedTo

Data Type: String

Required For: Gift Cards

Description: The value from the “To” field.

ClosedTravelRoute Element

The TravelRoute element provides details specific to travel ticket merchants.

ClosedCarrier

Data Type: String

Required For: Travel Ticket

Description: The name of the travel carrier.

Possible Values:

American Airlines

Greyhound

Southwest

ABO

ClosedDepartureDTM

Data Type: String

Required For: Travel Ticket

Description: The date and time of the departure. Use Standard ISO 8601 date and time format (including time zone offset): YYYY-MM-DDThh:mm:ssTZD.

ClosedArrivalDTM

Data Type: String

Required For: Travel Ticket

Description: The date and time of the arrival. Use Standard ISO 8601 date and time format (including time zone offset): YYYY-MM-DDThh:mm:ssTZD.

ClosedDestination

Data Type: String

Required For: Travel Ticket

Description: The airport where the travel route ended. Use industry standard abbreviations for standard locations, such as the airport code of LAX for Los Angeles International Airport. Contact your Integration Specialist for assistance in determining the value to be used.

ClosedFareClass

Data Type: String

Required For: Travel Ticket

Description: The fare class for the ticket(s).

ClosedOrigin

Data Type: String

Required For: Travel Ticket

Description: The airport where the travel route started. Use industry standard abbreviations for standard locations, such as the airport code of LAX for Los Angeles International Airport. Contact your Integration Specialist for assistance in determining the value to be used.

ClosedTraveler Element

The Traveler element provides information about all the travelers. The number of travelers matches the line item quantity.

ClosedFirstName

Data Type: String

Required For: Travel Ticket

Description: The first (given) name for the traveler.

ClosedLastName

Data Type: String

Required For: Travel Ticket

Description: The last (surname) name for the traveler.

ClosedSeller Element

The Seller element provides details for marketplace merchants or other merchants where the items being sold are hosted or fulfilled by individuals or organizations rather than by the merchant itself, such as eBay.

ClosedNumberPriorSales

Data Type: Integer

Required For: Marketplace

Description: The number of prior competed sales by the seller prior to this transaction.

ClosedItemCreatedDate

Data Type: Date

Required For: Marketplace

Description: The date the line item was created for sale on the merchant’s marketplace. Use Standard ISO 8601 date format: YYYY-MM-DD.

ClosedAccount Element

The Account element provides information about the seller’s account hosted by the merchant. Most of this information mirrors the purchaser’s information.

ClosedAccountID

Data Type: String

Required For: Marketplace

Description: The merchant account identifier of the seller.

ClosedCreatedDTM

Data Type: Datetime

Required For: Marketplace

Description: The date and time the seller account was created by the merchant. Use Standard ISO 8601 date and time format (including time zone offset): YYYY-MM-DDThh:mm:ssTZD.

ClosedDOB

Data Type: Date

Required For: Marketplace

Description: The date of birth of the seller. Use Standard ISO 8601 date format: YYYY-MM-DD.

ClosedisEmailVerified

Data Type: Boolean + NULL

Required For: Marketplace

Description: Indicates if the email address for the seller has been verified, such as sending a confirmation code to the email.

Possible Values:

FALSE - a verification was attempted and failed

TRUE - a verification was attempted and successful

NULL or empty value - a verification was not attempted

ClosedEmail

Data Type: String

Required For: Marketplace

Description: The email address attached to the seller’s account.

ClosedCompanyName

Data Type: String

Required For: Marketplace

Description: The name of the company on the seller’s account with the merchant.

ClosedFirstName

Data Type: String

Required For: Marketplace

Description: The first (given) name for the seller.

ClosedLastName

Data Type: String

Required For: Marketplace

Description: The last (surname) name for the seller.

ClosedAddressLine1

Data Type: String

Required For: Marketplace

Description: The first line in the address for the seller.

ClosedAddressLine2

Data Type: String

Required For: Marketplace

Description: The second line in the address for the seller.

ClosedUnitNumber

Data Type: String

Required For: Marketplace

Description: For non-U.S. addresses, the unit number in the address for the seller.

ClosedBuildingNumber

Data Type: String

Required For: Marketplace

Description: For non-U.S. addresses, the building number in the address for the seller.

ClosedStreetOrBlock

Data Type: String

Required For: Marketplace

Description: For non-U.S. addresses, the street or block in the address for the seller.

ClosedNeighborhood

Data Type: String

Required For: Marketplace

Description: For non-U.S. addresses, the neighborhood name in the address for the seller.

ClosedCity

Data Type: String

Required For: Marketplace

Description: The city in the address for the seller.

ClosedRegion

Data Type: String

Required For: Marketplace

Description: For U.S. addresses, the two-state character code in the address for the seller. For non-U.S. addresses, the name of the region.

ClosedPostalCode

Data Type: String

Required For: Marketplace

Description: The local postal (ZIP) code in the address for the seller.

ClosedCountryCode

Data Type: String

Required For: Marketplace

Description: The country in the address for the seller. Use two-character alpha ISO 3166-1 codes.

ClosedisAddressValidated

Data Type: Boolean + NULL

Required For: Marketplace

Description: Indicates if the merchant performed a validation of the seller's physical address. Validations include checking the address format to ensure it conforms to local requirements or querying a third-party service for address deliverability, such as the United States Post Office.

Possible Values:

FALSE - a validation was attempted and failed

TRUE - a validation was attempted and successful

NULL or empty value - a validation was not attempted

ClosedCurrentBalance

Data Type: Currency

Required For: Marketplace

Description: The current balance on the seller's account with the merchant, if the account is storing funds.

ClosedPhoneNumber

Data Type: String

Required For: Marketplace

Description: The phone number attached to the seller’s account. Use zero-padded, 15-digit string without spaces or non-digit characters and include the country code (modified E.163 format).

ClosedisPhoneVerified

Data Type: Boolean + NULL

Required For: Marketplace

Description: Indicates if the phone number for the seller been verified, such as sending a confirmation code to the number.

Possible Values:

FALSE - a verification was attempted and failed

TRUE - a verification was attempted and successful

NULL or empty value - a verification was not attempted

ClosedSocialNetwork Element

The SocialNetwork element provides information about any social networks that have been linked to the seller account on the merchant’s system.

ClosedEmail

Data Type: String

Required For: Marketplace

Description: The email address on the social network of reference.

ClosedAccountID

Data Type: String

Required For: Marketplace

Description: The account identifier on the social network of reference.

ClosedPlatform

Data Type: String

Required For: Marketplace

Description: The name of the social network of reference. Contact your Integration Specialist for other social networks that may be used.

Possible Values:

Facebook

GooglePlus

Twitter

Instagram

YouTube

Qzone

Weibo

Reddit

Pinterest

LinkedIn

Other

ClosedCrossBorderFulfillment Element

The CrossBorderFulfillment element provides details communicating when fulfillment occurs across a border and the currency transitions that are of that.

ClosedExchangeRate

Data Type: Float

Required For: Cross Border Fulfillment

Required When: Money Transmission

Description: The exchange rate at transaction time between the sending and receiving currencies.

ClosedReceiveAmount

Data Type: Currency

Required For: Cross Border Fulfillment

Required When: Money Transmission

Description: The amount received from the transfer.

ClosedReceiveCurrency

Data Type: String

Required For: Cross Border Fulfillment

Required When: Money Transmission

Description: The type of currency being received. Use ISO 4217 alpha codes format.

ClosedSendAmount

Data Type: Currency

Required For: Cross Border Fulfillment

Required When: Money Transmission

Description: The amount sent in the transfer.

ClosedSendCurrency

Data Type: String

Required For: Cross Border Fulfillment

Required When: Money Transmission

Description: The type of currency being sent. Use ISO 4217 alpha codes format.

ClosedPayout Element

The Payout element provides information about where the cross-border fulfillment occurs, either through money transmission or some type of stored value, such as a Telco top-up.

ClosedCity

Data Type: String

Required For: Cross Border Fulfillment

Required When: Money Transmission

Description: The city in the address for the payout.

ClosedCountryCode

Data Type: String

Required For: Cross Border Fulfillment

Required When: Money Transmission

Description: The country in the address where the payout occurs. Use two-character alpha ISO 3166-1 codes.

ClosedPostalCode

Data Type: String

Required For: Cross Border Fulfillment

Required When: Money Transmission

Description: The local postal (ZIP) code in the address where the payout occurs.

ClosedRegion

Data Type: String

Required For: Cross Border Fulfillment

Required When: Money Transmission

Description: For U.S. addresses, the two-state character code where the payout occurs. For non-U.S. addresses, the name of the region.

ClosedNetwork

Data Type: String

Required For: Cross Border Fulfillment

Required When: Money Transmission

Description: The payout network used for a money transmission.

ClosedInsurance Element

The Insurance element provides information about the insurance policy.

ClosedType

Data Type: String

Required For: Insurance

Description: The type of insurance policy.

Possible Values:

Home

Auto

ClosedPolicyNumber

Data Type: String

Required For: Insurance

Description: The identification number for the insurance policy.

ClosedPolicyHolderFirstName

Data Type: String

Required For: Insurance

Description: The first (given) name for the insurance policy holder.

ClosedPolicyHolderLastName

Data Type: String

Required For: Insurance

Description: The last (surname) name for the insurance policy holder.

ClosedPolicyHolderAddress

Data Type: String

Required For: Insurance

Description: The address for the insurance policy holder.

ClosedCarrier

Data Type: String

Required For: Insurance

Description: The name of the insurance carrier.

ClosedInvoiceID

Data Type: String

Required For: Insurance

Description: The identification number of the invoice for the insurance policy.

ClosedTerm

Data Type: String

Required For: Insurance

Description: The term length for the insurance policy.

ClosedPremium

Data Type: Decimal

Required For: Insurance

Description: The amount the policy holder pays for the insurance policy.

ClosedEvent Element

The Event element provides information for event ticketing.

ClosedLocation

Data Type: String

Required For: Event Ticket

Description: The location (address) for the event.

ClosedEventType

Data Type: String

Required For: Event Ticket

Description: The event type. Consult your Integration Specialist for details.

Possible Values:

Recurring

OneTime

MultiDay

ClosedEventCategory

Data Type: String

Required For: Event Ticket

Description: The event category. Consult your Integration Specialist for details.

Possible Values:

MusicPerformance

Festival

Theatre

ArtExhibit

ClosedEventDescription

Data Type: String

Required For: Event Ticket

Description: A description of the event. Limited to 120 characters (includes spaces and special characters).

ClosedStartDate

Data Type: Date

Required For: Event Ticket

Description: The start date for the specific event being purchased. Use Standard ISO 8601 date format: YYYY-MM-DD.

ClosedNumberOfOccurences

Data Type: String

Required For: Event Ticket

Description: The number of occurrences for the event as configured.

ClosedCreatedDate

Data Type: Date

Required For: Event Ticket

Description: The date the event was created in the merchant’s system. Use Standard ISO 8601 date format: YYYY-MM-DD.