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
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.
clientVersion	String	Yes	0.31
allowedPaymentTypes	array	Yes	["PANENTRY","CLICKTOPAY","APPLEPAY","GOOGLEPAY"]	The field value can be an array of strings or an object with options.
allowedCardNetworks	array	No	["VISA","MASTERCARD","AMEX"]
clientReferenceInformation.code	String	No	TAGX001

Order Information Fields

This table contains information about the

orderInformation

field object:

Order Information Fields
Field	Type	Required	Example
orderInformation.amountDetails.totalAmount	String	Yes	102.21
orderInformation.amountDetails.currency	String	Yes	USD
orderInformation.billTo.firstName	String	No	Jane
orderInformation.billTo.lastName	String	No	Doe
orderInformation.billTo.email	String	No	[email protected]
orderInformation.billTo.address1	String	No	1 Market St
orderInformation.billTo.locality	String	No	San Francisco
orderInformation.billTo.postalCode	String	No	94105
orderInformation.billTo.administrativeArea	String	No	CA
orderInformation.billTo.country	String	Conditional	US
orderInformation.shipTo.firstName	String	Conditional	John
orderInformation.shipTo.lastName	String	No	Buyer
orderInformation.shipTo.address1	String	No	456 Nice Avenue
orderInformation.shipTo.locality	String	No	Los Angeles
orderInformation.shipTo.administrativeArea	String	No	CA
orderInformation.shipTo.postalCode	String	No	90010
orderInformation.shipTo.country	String	No	US
orderInformation.lineItems[].unitPrice	String	Required for line-item authorizations.	29.99
orderInformation.lineItems[].quantity	String	Conditional	2
orderInformation.lineItems[].productCode	String	Conditional	electronic_good
orderInformation.lineItems[].productName	String	No	Receiver
orderInformation.lineItems[].productSku	String	No	SKU-12345
orderInformation.lineItems[].totalAmount	String	Conditional	59.98
orderInformation.lineItems[].taxAmount	String	No	5.40
orderInformation.lineItems[].taxRate	String	No	0.0900
orderInformation.lineItems[].taxAppliedAfterDiscount	String	No	Y
orderInformation.lineItems[].taxStatusIndicator	String	No	N
orderInformation.lineItems[].taxTypeCode	String	No	1234
orderInformation.lineItems[].amountIncludesTax	Boolean	No	true
orderInformation.lineItems[].typeOfSupply	String	No	12
orderInformation.lineItems[].commodityCode	String	No	8471
orderInformation.lineItems[].discountAmount	String	No	3.00
orderInformation.lineItems[].discountApplied	Boolean	No	true
orderInformation.lineItems[].discountRate	String	No	0.0500
orderInformation.lineItems[].invoicEnumber	String	No	INV-1001
orderInformation.lineItems[].unitOfMeasure	String	No	EA
orderInformation.lineItems[].weight	String	No	500
orderInformation.lineItems[].weightUnit	String	No	mg
orderInformation.lineItems[].weightIdentifier	String	No	"N"
orderInformation.lineItems[].referenceDataCode	String	No	REF1
orderInformation.lineItems[].referenceDataNumber	String	No	123
orderInformation.lineItems[].productDescription	String	No	HD Receiver
orderInformation.lineItems[].gift	Boolean	No	false
orderInformation.lineItems[].giftCardCurrency	String	No	2
orderInformation.lineItems[].shippingDestinationTypes	String	No	residential
orderInformation.lineItems[].fulfillmentType	String	No	physical
orderInformation.lineItems[].taxDetails[].type	String	No	STATE_SALES_TAX
orderInformation.lineItems[].taxDetails[].amount	String	No	4.50
orderInformation.lineItems[].taxDetails[].rate	String	No	0.0750
orderInformation.lineItems[].taxDetails[].code	String	No	1234
orderInformation.lineItems[].taxDetails[].taxId	String	No	TX-123456
orderInformation.lineItems[].taxDetails[].applied	Boolean	No	true
orderInformation.lineItems[].taxDetails[].exemptionCode	String	No	1

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	Type	Required	Example
captureMandate.billingType	Enum	No	FULL
captureMandate.requestEmail	Boolean	No	true
captureMandate.requestPhone	Boolean	No	true
captureMandate.requestShipping	Boolean	No	true
captureMandate.shipToCountries	Array	No	["US","GB"]
captureMandate.showAcceptedNetworkIcons	Boolean	No	true
captureMandate.showConfirmationStep	Boolean	No	true
captureMandate.comboCard	Boolean	No	true
captureMandate.requestSaveCard	Boolean	No	true
captureMandate.CPF.required	Boolean	Conditional	true

Complete Mandate Fields

This table contains information about the

completeMandate

field object:

Complete Mandate Fields
Field	Type	Required	Example
completeMandate.type	Enum	Conditional	CAPTURE
completeMandate.decisionManager	Boolean	Conditional	true
completeMandate.consumerAuthentication	Boolean	Conditional	true

Buyer Information Fields

This table contains information about the

buyerInformation

field object:

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

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

Merchant Information Fields

The following table describes the merchantInformation.merchantDescriptor object fields:

Merchant Information Fields
Field	Type	Required	Example
merchantInformation.merchantDescriptor.name	String	No	Jane Sales

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.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

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.firstName	String	Conditional	John
recipientInformation.middleName	String	No	A
recipientInformation.lastName	String	Conditional	Buyer
recipientInformation.country	String	Conditional	GB
recipientInformation.administrativeArea	String	No	GB
recipientInformation.accountId	String	Conditional	acc0123567
recipientInformation.accountType	String	Conditional	01

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

Allowed Payment Types Variations

This table describes the possible values for the

allowedPaymentTypes

field:

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