Attributes

AttributeData typeDescription
merchant
required
objectMerchant specific information. See details.
shipping
required
objectThe shipping details.
billing
optional
objectThe billing details.
items
required
ArrayAn array of item.
discounts
optional
objectA list of discount. Each discount must have their discount code.
metadata
optional
objectSee details.
order_id
optional
stringThe merchant order id. This is stored for your own future reference.
currency
required
stringThree-letter ISO currency code, in uppercase.

Possible values:
- USD
- CAD
financing_program
optional
stringA financing program applied on this checkout.
shipping_amount
required
integerThe total shipping amount in cents. A positive integer representing how much, in USD or CAD cents (e.g., 100 cents to charge $1.00).
tax_amount
required
integerThe total tax amount in cents.
total
required
integerThe total amount of the checkout in USD or CAD cents (e.g., 100 cents to charge $1.00).
{
   "merchant":{
      "user_confirmation_url":"https://merchantsite.com/confirm",
      "user_cancel_url":"https://merchantsite.com/cancel",
      "user_confirmation_url_action":"POST",
      "use_vcn": false,
      "name":"Your Customer-Facing Merchant Name"
   },
   "shipping":{
      "name":{
         "full":"John Doe"
      },
      "address":{
         "line1":"test",
         "city":"ADA",
         "state":"WV",
         "zipcode":"24701",
         "country":"US"
      },
      "phone_number":"4155555555",
      "email":"[email protected]"
   },
   "billing":{
      "name":{
         "full":"John Doe"
      },
      "address":{
         "line1":"test",
         "city":"ADA",
         "state":"WV",
         "zipcode":"24701",
         "country":"US"
      },
      "phone_number":"4155555555",
      "email":"[email protected]"
   },
   "items":[
      {
         "display_name":"Awesome Pants",
         "sku":"ABC-123",
         "unit_price":1999,
         "qty":3,
         "item_image_url":"http://merchantsite.com/images/awesome-pants.jpg",
         "item_url":"http://merchantsite.com/products/awesome-pants.html"
      }
   ],
   "discounts":{
      "RETURN5":{
         "discount_amount":500,
         "discount_display_name":"Returning customer 5% discount"
      },
      "PRESDAY10":{
         "discount_amount":1000,
         "discount_display_name":"President's Day 10% off"
      }
   },
   "metadata":{
      "shipping_type":"UPS Ground",
      "mode":"modal"
   },
   "order_id":"JKLMO4321",
   "currency":"USD",  
   "financing_program":"flyus_3z6r12r",
   "shipping_amount":1000,
   "tax_amount":500,
   "total":100000
}