Developer Resources
The DeliveryInfo element contains detailed shipping information for the item being delivered.
Data Type: String
Required For: All
Description: The way the delivery will take place. Contact your Integration Specialist for assistance in determining the value to be used.
Possible Values:
WillCall
Delay
PhysicalShipping
Reload
DigitalDownload
MoneyTransfer
BillPay
Subscription
TelcoTopup
WalletReload
WalletAdd
SMS
Other
Data Type: String
Required For: Physical Goods
Required When: Physical Shipping
Description: The name of the shipping carrier, if it applies. Contact your Integration Specialist for assistance in determining the value to be used.
Possible Values:
UPS
FedEx
USPS
DHL
CanadaPost
Purolator
OnTrac
Estafeta
Data Type: Date
Required For: Physical Shipping
Description: The estimated shipping date for physical shipping goods or the planned delivery date for delayed digital fulfillment. Use Standard ISO 8601 date format: YYYY-MM-DD.
Data Type: String
Required For: Physical Shipping
Description: The class of shipping. Contact your Integration Specialist for assistance in determining the value to be used.
Possible Values:
Overnight
Priority
FirstClass
ParcelPost
Express
Data Type: Currency
Required For: Physical Shipping
Description: The cost of shipping the delivery.
Data Type: String
Required For: In Store Pickup
Description: The pickup location, if there will be a pickup at a known location, such as a store. In the case of a store pickup, this would be a store identifier, either an address or a store number.
Data Type: Datetime
Required For: In Store Pickup
Description: The estimated or requested date and time of the pickup. Use Standard ISO 8601 date and time format (including time zone offset): YYYY-MM-DDThh:mm:ssTZD.
Data Type: String
Required For: All
Description: The name of the company the delivery is intended for.
Data Type: String
Required For: All
Description: The first (given) name for the recipient of the delivery.
Data Type: String
Required For: All
Description: The last (surname) name for the recipient of the delivery.
Data Type: String
Required For: Physical Shipping
Description: The first line in the address for the delivery.
Data Type: String
Required For: Physical Shipping
Description: The second line in the address for the delivery.
Data Type: String
Required For: Physical Shipping
Description: For non-U.S. addresses, the unit number in the address for the delivery.
Data Type: String
Required For: Physical Shipping
Description: For non-U.S. addresses, the building number in the address for the delivery.
Data Type: String
Required For: Physical Shipping
Description: For non-U.S. addresses, the street or block in the address for the delivery.
Data Type: String
Required For: Physical Shipping
Description: For non-U.S. addresses, the neighborhood name in the address for the delivery.
Data Type: String
Required For: Physical Shipping
Description: The city in the address for the delivery.
Data Type: String
Required For: Physical Shipping
Description: For U.S. addresses, the two-state character code in the address for the delivery. For non-U.S. addresses, the name of the region.
Data Type: String
Required For: Physical Shipping
Description: The local postal (ZIP) code in the address for the delivery.
Data Type: String
Required For: Physical Shipping
Description: The country in the address for the delivery. Use two-character alpha ISO 3166-1 codes.
Data Type: String
Required For: All
Required When: Telco
Description: The phone number for the delivery recipient. Use zero-padded, 15-digit string without spaces or non-digit characters and include the country code (modified E.163 format).
Data Type: String
Required For: All
Required When: Email Delivery
Description: The email address for the delivery recipient.
Data Type: String
Required For: Telco
Description: The subscriber key for the delivery recipient. Used for merchants that have a sub-account that stores the value of the transaction.
Data Type: String
Required For: Telco
Description: The account identifier for the delivery recipient. Used when the delivery goes to an account either with the merchant or a third party.
Data Type: Boolean + NULL
Required For: Physical Shipping
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
Data Type: Boolean + NULL
Required For:All
Required When: Email Delivery
Description: Indicates if the merchant performs a validation of the email address associated with delivery. Validations include checking the address format to ensure it conforms to email standards or querying the domain (such as Google) to check if the email address is deliverable.
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