Purchaser Element

Developer Resources

All Files

Purchaser Element

The Purchaser element provides information about the purchaser placing the transaction.

Account Element

Expand/Collapse All

The Account element provides information about the purchaser’s account if an account exists with the merchant.

AccountID

Data Type: String

Required For: User Account With Merchant

Description: The merchant-defined account identifier for the purchaser.

CreatedDTM

Data Type: Datetime

Required For: User Account With Merchant

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

DOB

Data Type: Date

Required For: User Account With Merchant

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

isEmailVerified

Data Type: Boolean + NULL

Required For: User Account With Merchant

Description: Indicates if the email address for the purchaser 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

isPhoneVerified

Data Type: Boolean + NULL

Required For: User Account With Merchant

Description: Indicates if the phone number for the purchaser's account with the merchant has 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

Data Type: String

Required For: User Account With Merchant

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

CompanyName

Data Type: String

Required For: User Account With Merchant

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

FirstName

Data Type: String

Required For: User Account With Merchant

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

LastName

Data Type: String

Required For: User Account With Merchant

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

AddressLine1

Data Type: String

Required For: User Account With Merchant

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

AddressLine2

Data Type: String

Required For: User Account With Merchant

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

UnitNumber

Data Type: String

Required For: User Account With Merchant

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

BuildingNumber

Data Type: String

Required For: User Account With Merchant

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

StreetOrBlock

Data Type: String

Required For: User Account With Merchant

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

Neighborhood

Data Type: String

Required For: User Account With Merchant

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

City

Data Type: String

Required For: User Account With Merchant

Description: The city in the address for the purchaser's account with the merchant.

Region

Data Type: String

Required For: User Account With Merchant

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

PostalCode

Data Type: String

Required For: User Account With Merchant

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

CountryCode

Data Type: String

Required For: User Account With Merchant

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

CurrentBalance

Data Type: Currency

Required For: User Account With Merchant

Description: The current balance on the purchaser's account with the merchant, if the accounts store value.

PhoneNumber

Data Type: String

Required For: User Account With Merchant

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

SocialNetwork Element

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

Data Type: String

Required For: User Account With Merchant

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

AccountID

Data Type: String

Required For: User Account With Merchant

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

Platform

Data Type: String

Required For: User Account With Merchant

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

Other

isAddressValidated

Data Type: Boolean + NULL

Required For: User Account With Merchant

Description: Indicates if the merchant performed a validation of the purchaser'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

Gambling Element

The Gambling element provides betting information for the purchaser account on the merchant’s system.

MaxBetAmount

Data Type: Currency

Required For: Gambling

Description: The maximum amount used for betting.

MinBetAmount

Data Type: Currency