Object Model

Object Model

Customer

Properties	Type	Optional/Required	Description
firstName	string	Optional	Customer's first name
lastName	string	Optional	Customer's last name
email	string	Optional	Customer's email address
phoneNumber	string	Optional	Customer's phone number
address1	string	Optional	Customer's primary address information
address2	string	Optional	Customer's secondary address information. May contain - Apartment number, Care of, Attention
city	string	Optional	Customer's address city
state	string	Optional	Customer's address state, in ISO 3166-2:US format (two letter state code)
postalCode	string	Optional	5 digit state postal/zip code
country	string	Optional	Customer's address country, in ISO_3166-2 (two letter country code)

Order

Properties	Type	Optional/Required	Description
amount	number	Required	The maximum amount that can be authorized on the issued virtual card. It should include all fees, taxes, shipping, and discount codes calculated in its value.
shippingAmount	number	Required	The cost of shipping.
taxAmount	number	Optional	The cost of taxes.
currency	string	Required	The currency in which the customer is transacting.
merchantReference	string	Required	The merchant's identifier for the order. This is used to reconcile merchant orders in Zip's system.
customer	Customer object	Optional	Customer object is used to prefill data in the Zip checkout to improve the user experience and conversion. This is typically based on the customer's supplied billing or shipping details entered earlier in the checkout process.
merchantFeeForPaymentPlan	number	Optional	The per-order fee amount, set as part of the customer contribution model.
lineItems	LineItem object Array	Optional	The items in the order.

Line Item

Properties	Type	Optional/Required	Description
name	string	Optional	The name of the item
description	string	Optional	The description of the item. (n.b. the description should have max 100 characters, if it exceeds this limit it will be truncated)
quantity	number	Optional	The quantity of the item in the order.
price	number	Optional	The price of 1 item.
sku	string	Optional	The Stock Keeping Unit number.
isPreOrder	boolean	Optional	Whether the item is a pre-order item.
releaseDate	date	Optional	The anticipated shipment date of the item.

Card

Properties	Type	Optional/Required	Description
number	string	Required	The virtual Visa card number.
cvc	string	Required	The card's CVC security code.
expirationMonth	number	Required	The month expiry of the card.
expirationYear	number	Required	The year expiry of the card.
brand	string	Optional	The brand of the credit card.

Cardholder

Properties	Type	Optional/Required	Description
name	string	Required	The cardholder's full name. To be used if you collect a single name field for the cardholder information.
firstName	string	Required	The cardholder's first name. To be used if you collect separate fields for first and last name.
lastName	string	Required	The cardholder's last name. To be used if you collect separate fields for first and last name.
address1	string	Required	Primary billing address information
address2	string	Optional	Secondary billing address information. May contain - Apartment number, Care of, Attention.
city	string	Required	Customer's billing address city.
state	string	Required	The state of the customer's billing address, in ISO 3166-2:US format.
postalCode	string	Required	5 digit state postal/zip code.
country	string	Required	The country of the customer's billing address in ISO_3166-2 (two letter country code).

Address

Properties	Type	Optional/Required	Description
line1	string	Required	Primary shipping address information.
line2	string	Optional	Secondary shipping address information. May contain - Apartment number, Care of, Attention.
city	string	Required	The city of the customer's shipping address.
state	string	Required	The state of the customer's shipping address, in ISO 3166-2:US format.
country	string	Required	The country of the customer's shipping address in ISO_3166-2 (two letter country code).
postalCode	string	Required	5 digit state postal/zip code.

Checkout Flow

Properties	type	Description
standard	string
express	string

Updated over 1 year ago