Unified Checkout Field Reference

This section includes the fields that you use for Unified Checkout.

Main Configuration Fields

The following table describes the main configuration fields for Unified Checkout:

Main Configuration Fields
Field Name	Data Type	Required?	Example	Details
allowedCardNetworks	Array	No	["VISA","MASTERCARD","AMEX"]
allowedPaymentTypes	Array	Yes	["PANENTRY","CLICKTOPAY","APPLEPAY","GOOGLEPAY"]	The field value can be an array of strings or an object with options.
buttonType	Enum	No		Possible values: ADD_CARD SAVE_CARD CARD_PAYMENT CHECKOUT CHECKOUT_AND_CONTINUE DEBIT_CREDIT DONATE PAY PAY_WITH_CARD SUBSCRIBE_WITH_CARD
clientReferenceInformation.code	String	No	TAGX001
clientVersion	String	Yes	0.31
country	String	Yes	US
locale	String	Yes	en_US
targetOrigins	Array	Yes	["https://merchant.com","https://reseller.com:8443"]	Each origin must contain HTTPS and include the scheme, host, and optional port.

Order Information Fields

This table contains information about the

data.orderInformation

field object:

Order Information Fields
Field	Type	Required?	Example
data.orderInformation.amountDetails.currency	String	Yes	USD
data.orderInformation.amountDetails.discountAmount	String	No	2.00
data.orderInformation.amountDetails.servieFeeAmount	String	No	5.00
data.orderInformation.amountDetails.surcharge.amount	String	No	4.50
data.orderInformation.amountDetails.taxAmount	String	No	10.00
data.orderInformation.amountDetails.taxDetails[].taxId	String	No	1234
data.orderInformation.amountDetails.taxDetails[].type	String	No	N
data.orderInformation.amountDetails.totalAmount	String	Yes	102.21
data.orderInformation.billTo.address1	String	No	1 Market St
data.orderInformation.billTo.address2	String	No	Apt B
data.orderInformation.billTo.address3	String	No	Building C
data.orderInformation.billTo.address4	String	No	Floor 2
data.orderInformation.billTo.administrativeArea	String	No	CA
data.orderInformation.billTo.buildingNumber	String	No	123
data.orderInformation.billTo.company.address1	String	No	123 Street Road
data.orderInformation.billTo.company.address2	String	No	Suite 100
data.orderInformation.billTo.company.address3	String	No	Building A
data.orderInformation.billTo.company.address4	String	No	Floor 5
data.orderInformation.billTo.company.administrativeArea	String	No	CA
data.orderInformation.billTo.company.buildingNumber	String	No	900
data.orderInformation.billTo.company.country	String	No	US
data.orderInformation.billTo.company.district	String	No	Metro
data.orderInformation.billTo.company.locality	String	No	Foster City
data.orderInformation.billTo.company.name	String	No	Company Name
data.orderInformation.billTo.company.postalCode	String	No	12345
data.orderInformation.billTo.country	String	Conditional	US
data.orderInformation.billTo.district	String	No	Downtown
data.orderInformation.billTo.email	String	No	[email protected]
data.orderInformation.billTo.firstName	String	No	Jane
data.orderInformation.billTo.lastName	String	No	Doe
data.orderInformation.billTo.locality	String	No	San Francisco
data.orderInformation.billTo.middleName	String	No	Michael
data.orderInformation.billTo.nameSuffix	String	No	Jr.
data.orderInformation.billTo.phoneNumber	String	No	111-111-1111
data.orderInformation.billTo.phoneType	String	No	day
data.orderInformation.billTo.postalCode	String	No	94105
data.orderInformation.billTo.title	String	No	Mr.
data.orderInformation.lineItems[].amountIncludesTax	Boolean	No	true
data.orderInformation.lineItems[].commodityCode	String	No	8471
data.orderInformation.lineItems[].discountAmount	String	No	3.00
data.orderInformation.lineItems[].discountApplied	Boolean	No	true
data.orderInformation.lineItems[].discountRate	String	No	0.0500
data.orderInformation.lineItems[].fulfillmentType	String	No	physical
data.orderInformation.lineItems[].gift	Boolean	No	false
data.orderInformation.lineItems[].giftCardCurrency	String	No	2
data.orderInformation.lineItems[].invoiceDetails.productDescription	String	No	Description
data.orderInformation.lineItems[].invoiceNumber	String	No	INV-1001
data.orderInformation.lineItems[].passenger.email	String	No	[email protected]
data.orderInformation.lineItems[].passenger.firstName	String	No	Jane
data.orderInformation.lineItems[].passenger.id	String	No	1234567890
data.orderInformation.lineItems[].passenger.lastName	String	No	Doe
data.orderInformation.lineItems[].passenger.nationality	String	No	US
data.orderInformation.lineItems[].passenger.phone	String	No	111-111-1111
data.orderInformation.lineItems[].passenger.status	String	No	standard
data.orderInformation.lineItems[].passenger.type	String	No	ADT
data.orderInformation.lineItems[].productCode	String	Conditional	electronic_good
data.orderInformation.lineItems[].productDescription	String	No	HD Receiver
data.orderInformation.lineItems[].productName	String	No	Receiver
data.orderInformation.lineItems[].productSku	String	No	SKU-12345
data.orderInformation.lineItems[].quantity	String	Conditional	2
data.orderInformation.lineItems[].referenceDataCode	String	No	REF1
data.orderInformation.lineItems[].referenceDataNumber	String	No	123
data.orderInformation.lineItems[].shippingDestinationTypes	String	No	residential
data.orderInformation.lineItems[].taxAmount	String	No	5.40
data.orderInformation.lineItems[].taxAppliedAfterDiscount	String	No	Y
data.orderInformation.lineItems[].taxDetails[].amount	String	No	4.50
data.orderInformation.lineItems[].taxDetails[].applied	Boolean	No	true
data.orderInformation.lineItems[].taxDetails[].code	String	No	1234
data.orderInformation.lineItems[].taxDetails[].exemptionCode	String	No	1
data.orderInformation.lineItems[].taxDetails[].rate	String	No	0.0750
data.orderInformation.lineItems[].taxDetails[].taxId	String	No	TX-123456
data.orderInformation.lineItems[].taxDetails[].type	String	No	STATE_SALES_TAX
data.orderInformation.lineItems[].taxRate	String	No	0.0900
data.orderInformation.lineItems[].taxStatusIndicator	String	No	N
data.orderInformation.lineItems[].taxTypeCode	String	No	1234
data.orderInformation.lineItems[].totalAmount	String	Conditional	59.98
data.orderInformation.lineItems[].typeOfSupply	String	No	12
data.orderInformation.lineItems[].unitOfMeasure	String	No	EA
data.orderInformation.lineItems[].unitPrice	String	Required for line-item authorizations.	29.99
data.orderInformation.lineItems[].unitTaxAmount	String	No	1.00
data.orderInformation.lineItems[].weight	String	No	500
data.orderInformation.lineItems[].weightIdentifier	String	No	"N"
data.orderInformation.lineItems[].weightUnit	String	No	mg
data.orderInformation.shipTo.address1	String	No	456 Nice Avenue
data.orderInformation.shipTo.address2	String	No	Unit 7
data.orderInformation.shipTo.address3	String	No	Warehouse B
data.orderInformation.shipTo.address4	String	No	Dock 3
data.orderInformation.shipTo.administrativeArea	String	No	CA
data.orderInformation.shipTo.buildingNumber	String	No
data.orderInformation.shipTo.country	String	No	US
data.orderInformation.shipTo.district	String	No	Midtown
data.orderInformation.shipTo.firstName	String	Conditional	John
data.orderInformation.shipTo.lastName	String	No	Buyer
data.orderInformation.shipTo.locality	String	No	Los Angeles
data.orderInformation.shipTo.postalCode	String	No	90010

Capture Mandate Fields

The following table describes the

captureMandate

object fields. The values in these fields determine which fields Unified Checkout displays in the UI:

Capture Mandate Fields
Field	Data Type	Required?	Example
captureMandate.billingType	Enum	No	FULL
captureMandate.comboCard	Boolean	No	true
captureMandate.CPF.required	Boolean	Conditional	true
captureMandate.requestEmail	Boolean	No	true
captureMandate.requestPhone	Boolean	No	true
captureMandate.requestSaveCard	Boolean	No	true
captureMandate.requestShipping	Boolean	No	true
captureMandate.shipToCountries	Array	No	["US","GB"]
captureMandate.showAcceptedNetworkIcons	Boolean	No	true
captureMandate.showConfirmationStep	Boolean	No	true

Complete Mandate Fields

This table contains information about the

completeMandate

field object:

Complete Mandate Fields
Field	Type	Required?	Example	Details
completeMandate.consumerAuthentication	Boolean	Conditional	true	Enable `3-D Secure` authentication for supported card types.
completeMandate.decisionManager	Boolean	Conditional	true	Enable `Decision Manager` fraud screening with device fingerprinting.
completeMandate.tms.tokenCreate	Boolean	Conditional	true	Create tokens through the `Token Management Service`.
completeMandate.tms.tokenTypes	Array	Conditional	["customer", "paymentInstrument", "instrumentIdentifier", "shippingAddress" ]	Types of tokens to create: Customer Instrument identifier Payment instrument Shipping address When you do not set this field value to a token type, the default value is based on the vault configuration.
completeMandate.type	Enum	Conditional	CAPTURE	Type of transaction required.

Buyer Information Fields

This table contains information about the

buyerInformation

field object:

Buyer Information Fields
Field	Type	Required?	Example
buyerInformation.companyTaxId	String	Regional	12.345.678/0001-90
buyerInformation.dateOfBirth	String	No	19900101
buyerInformation.language	String	No	en-US
buyerInformation.merchantCustomerId	String	No	cust_12345
buyerInformation.personalIdentification.cpf	String	Required in Brazil	12345678900

Client Reference Information Fields

This table contains information about the

clientReferenceInformation

field object:

Client Reference Information Fields
Field	Type	Required	Example
clientReferenceInformation.code	String	No	TAGX001
clientReferenceInformation.partner.developerId	String	No	1234
clientReferenceInformation.partner.solutionId	String	No	4567

Consumer Authentication Information Fields

This table contains information about the

consumerAuthenticationInformation

field object. These fields are used only for 3-D Secure:

Consumer Authentication Information Fields
Field	Type	Required	Example
consumerAuthenticationInformation.challengeCode	String	Yes	01
consumerAuthenticationInformation.messageCategory	String	Yes	01
consumerAuthenticationInformation.acsWindowSize	String	No	10

Merchant Information Fields

The following table describes the

merchantInformation.merchantDescriptor

object fields:

Merchant Information Fields
Field	Type	Required?	Example
merchantInformation.merchantDescriptor.address1	String	No	123 Street Road
merchantInformation.merchantDescriptor.administrativeArea	String	No	CA
merchantInformation.merchantDescriptor.alternateName	String	No	Susan
merchantInformation.merchantDescriptor.country	String	No	US
merchantInformation.merchantDescriptor.locality	String	No	Foster City
merchantInformation.merchantDescriptor.name	String	No	Jane Sales
merchantInformation.merchantDescriptor.phone	String	No	111-111-1111
merchantInformation.merchantDescriptor.postalCode	String	No	12345

Processing Information Fields

This table contains information about the

processingInformation

field object.

Processing Information Fields
Field	Type	Required?	Example
processingInformation.authorizationOptions.aftIndicator	Boolean	Conditional	true
processingInformation.authorizationOptions.authIndicator	Enum	No	0
processingInformation.authorizationOptions.ignoreAvsResult	Boolean	No	true
processingInformation.authorizationOptions.ignoreCvResult	Boolean	No	true
processingInformation.authorizationOptions.initiator.credentialStoredOnFile	Boolean	Required for stored credentials	true
processingInformation.authorizationOptions.initiator.merchantInitiatedTransaction.reason	String	Required for stored credentials	1
processingInformation.businessApplicationId	String	Required for Payouts	AA
processingInformation.commerceIndicator	String	No	retail
processingInformation.processingInstruction	String	No	NO_INSTRUCTION
processingInformation.reconciliationId	String	No	123456789012345

Recipient Information Fields

This table contains information about the

recipientInformation

field object. These fields are used only for payouts:

Recipient Information Fields
Field	Type	Required?	Example
recipientInformation.accountId	String	Conditional	acc0123567
recipientInformation.accountType	String	Conditional	01
recipientInformation.administrativeArea	String	No	GB
recipientInformation.country	String	Conditional	GB
recipientInformation.dateOfBirth	String	No	19900101
recipientInformation.firstName	String	Conditional	John
recipientInformation.lastName	String	Conditional	Buyer
recipientInformation.middleName	String	No	A
recipientInformation.postalCode	String	No	12345

Merchant Defined Information Fields

This table contains information about the

merchantDefinedInformation[]

field array:

Merchant Defined Information Fields
Field	Type	Required?	Example
merchantDefinedInformation[].key	String	Required when merchantDefinedInformation[].value is included in the request.	customer_id
merchantDefinedInformation[].value	String	Required when merchantDefinedInformation[].key is included in the request.	12345

Device Information Fields

This table contains information about the

deviceInformation

field object:

Merchant Defined Information Fields
Field	Type	Required?
deviceInformation.ipAddress	String	No

Payment Information Fields

This table contains information about the

paymentInformation

field object:

Merchant Defined Information Fields
Field	Type	Required?	Example
paymentInformation.card.typeSelectionIndicator	Enum	No	0

Allowed Payment Types Variations

This table describes the possible values for the

allowedPaymentTypes

field object:

Payment Types Variations
Payment Type	Value	Additional Requirements in Capture Context	Details
Manual card entry	PANENTRY		Basic card entry.
Click to Pay	CLICKTOPAY or object { "type":"CLICKTOPAY","options":{...} }	Include email in for autolookup.	Auto‑check enrollment available is available through options.autoCheckEnrollment .
Apple Pay	APPLEPAY
Google Pay	GOOGLEPAY
Paze	PAZE