Skip to main content

Merchant Help Center

 

Affirm Merchant Help Center

Checkout Object v2

Checkout Object

This is the data payload that gets POSTed to the Affirm API to initialize checkout. All numerical (Integer) values must be passed as integer USD cents (i.e., $25.00 is passed as 2500).

Field Name R/O/C Type Description
financing_program O String A unique financing program name that is provided to you by Affirm. If you have a custom financing program available, you can enter the name of it in this field. If the program is not available or the name is not valid, your default financing program will be used.
merchant R Object (Merchant) Merchant configuration for the checkout session.
shipping C Object (Consumer Details) Consumer's shipping details. Required if the item is being shipped.
billing O Object (Consumer Details) Consumer's billing details.
items R List (Item) A list of items being purchased.
discounts O List (Discount) A list of discounts being applied. The key of each discount is a unique identifier to the discount. The value of each discount is a Discount object.
metadata O Object (Metadata) A hash of keys to values for any metadata to be passed into checkout and stored. 'entity_name' is a protected key, and will show up in your settlement reporting.
order_id O String Your internal order id. This is stored for your own reference.
shipping_amount C Integer The total shipping amount. Required if the item is being shipped. All numerical (Integer) values must be passed as integer USD cents (i.e., $25.00 is passed as 2500).
tax_amount O Integer The total tax amount computed after all discounts have been applied. Defaults to 0. All numerical (Integer) values must be passed as integer USD cents (i.e., $25.00 is passed as 2500).
total R Integer The total amount of the checkout, less any discounts applied. This determines the total amount charged to the user. All numerical (Integer) values must be passed as integer USD cents (i.e., $25.00 is passed as 2500).