Attributes

Attribute

Data type

Description

merchant
required

object

Merchant specific information. See details.

shipping
required

object

The shipping details.

billing
optional

object

The billing details.

items
required

Array

An array of item.

discounts
optional

object

A list of discount. Each discount must have their discount code.

metadata
optional

object

See details.

order_id
optional

string

The merchant order id. This is stored for your own future reference.

currency
required

string

Three-letter ISO currency code, in uppercase.

Possible values:

  • USD
  • CAD

financing_program
optional

string

A financing program applied on this checkout.

shipping_amount
required

integer

The 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

integer

The total tax amount in cents.

total
required

integer

The 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":{
         "street1": "4519 Rue Levy",
         "street2": "Apt 1",
         "city": "Saint-Laurent",
         "region1_code": "QC",
         "postal_code": "H4R2P9",
             "country": "CAN"
      },
      "phone_number":"4155555555",
      "email":"[email protected]"
   },
   "billing":{
      "name":{
         "full":"John Doe"
      },
      "address":{
         "street1": "4519 Rue Levy",
         "street2": "Apt 1",
         "city": "Saint-Laurent",
         "region1_code": "QC",
         "postal_code": "H4R2P9",
             "country": "CAN"
      },
      "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":"CAD",  
   "financing_program":"flyus_3z6r12r",
   "shipping_amount":1000,
   "tax_amount":500,
   "total":100000
}