<th>
Type
</th>
<th>
Optional/Required
</th>
<th>
Description
</th>
</tr>
<td>
number
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
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.
</td>
</tr>
<tr>
<td>
shippingAmount
</td>
<td>
number
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
The cost of shipping.
</td>
</tr>
<tr>
<td>
taxAmount
</td>
<td>
number
</td>
<td>
Optional
</td>
<td>
The cost of taxes.
</td>
</tr>
<tr>
<td>
currency
</td>
<td>
string
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
The currency in which the customer is transacting.
</td>
</tr>
<tr>
<td>
merchantReference
</td>
<td>
string
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
The merchant's identifier for the order. This is used to reconcile merchant orders in Zip's system.
</td>
</tr>
<tr>
<td>
customer
</td>
<td>
Customer object
</td>
<td>
Optional
</td>
<td>
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.
</td>
</tr>
<tr>
<td>
merchantFeeForPaymentPlan
</td>
<td>
number
</td>
<td>
Optional
</td>
<td>
The per-order fee amount, set as part of the customer contribution model.
</td>
</tr>
<tr>
<td>
lineItems
</td>
<td>
LineItem object Array
</td>
<td>
Optional
</td>
<td>
The items in the order.
</td>
</tr>
Properties
amount
Line Item
<th>
Type
</th>
<th>
Optional/Required
</th>
<th>
Description
</th>
</tr>
<td>
string
</td>
<td>
Optional
</td>
<td>
The name of the item
</td>
</tr>
<tr>
<td>
description
</td>
<td>
string
</td>
<td>
Optional
</td>
<td>
The description of the item.\
(n.b. the description should have max 100 characters, if it exceeds this limit it will be truncated)
</td>
</tr>
<tr>
<td>
quantity
</td>
<td>
number
</td>
<td>
Optional
</td>
<td>
The quantity of the item in the order.
</td>
</tr>
<tr>
<td>
price
</td>
<td>
number
</td>
<td>
Optional
</td>
<td>
The price of 1 item.
</td>
</tr>
<tr>
<td>
sku
</td>
<td>
string
</td>
<td>
Optional
</td>
<td>
The Stock Keeping Unit number.
</td>
</tr>
<tr>
<td>
isPreOrder
</td>
<td>
boolean
</td>
<td>
Optional
</td>
<td>
Whether the item is a pre-order item.
</td>
</tr>
<tr>
<td>
releaseDate
</td>
<td>
date
</td>
<td>
Optional
</td>
<td>
The anticipated shipment date of the item.
</td>
</tr>
Properties
name
Card
<th>
Type
</th>
<th>
Optional/Required
</th>
<th>
Description
</th>
</tr>
<td>
string
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
The virtual Visa card number.
</td>
</tr>
<tr>
<td>
cvc
</td>
<td>
string
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
The card's CVC security code.
</td>
</tr>
<tr>
<td>
expirationMonth
</td>
<td>
number
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
The month expiry of the card.
</td>
</tr>
<tr>
<td>
expirationYear
</td>
<td>
number
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
The year expiry of the card.
</td>
</tr>
<tr>
<td>
brand
</td>
<td>
string
</td>
<td>
Optional
</td>
<td>
The brand of the credit card.
</td>
</tr>
Properties
number
Cardholder
<th>
Type
</th>
<th>
Optional/Required
</th>
<th>
Description
</th>
</tr>
<td>
string
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
The cardholder's full name. To be used if you collect a single name field for the cardholder information.
</td>
</tr>
<tr>
<td>
firstName
</td>
<td>
string
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
The cardholder's first name. To be used if you collect separate fields for first and last name.
</td>
</tr>
<tr>
<td>
lastName
</td>
<td>
string
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
The cardholder's last name. To be used if you collect separate fields for first and last name.
</td>
</tr>
<tr>
<td>
address1
</td>
<td>
string
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
Primary billing address information
</td>
</tr>
<tr>
<td>
address2
</td>
<td>
string
</td>
<td>
Optional
</td>
<td>
Secondary billing address information. May contain - Apartment number, Care of, Attention.
</td>
</tr>
<tr>
<td>
city
</td>
<td>
string
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
Customer's billing address city.
</td>
</tr>
<tr>
<td>
state
</td>
<td>
string
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
The state of the customer's billing address, in ISO 3166-2:US format.
</td>
</tr>
<tr>
<td>
postalCode
</td>
<td>
string
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
5 digit state postal/zip code.
</td>
</tr>
<tr>
<td>
country
</td>
<td>
string
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
The country of the customer's billing address in ISO\_3166-2 (two letter country code).
</td>
</tr>
Properties
name
Address
<th>
Type
</th>
<th>
Optional/Required
</th>
<th>
Description
</th>
</tr>
<td>
string
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
Primary shipping address information.
</td>
</tr>
<tr>
<td>
line2
</td>
<td>
string
</td>
<td>
Optional
</td>
<td>
Secondary shipping address information. May contain - Apartment number, Care of, Attention.
</td>
</tr>
<tr>
<td>
city
</td>
<td>
string
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
The city of the customer's shipping address.
</td>
</tr>
<tr>
<td>
state
</td>
<td>
string
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
The state of the customer's shipping address, in ISO 3166-2:US format.
</td>
</tr>
<tr>
<td>
country
</td>
<td>
string
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
The country of the customer's shipping address in ISO\_3166-2 (two letter country code).
</td>
</tr>
<tr>
<td>
postalCode
</td>
<td>
string
</td>
<td>
<span style="color: red">Required</span>
</td>
<td>
5 digit state postal/zip code.
</td>
</tr>
