Store

Initiate an Affirm checkout directly with your customers.

Body Params

Returns the checkout object.

merchant
object
required

A list of items specific to the merchant.

billing
object

The customer billing information.

integer

The total amount in cents of the purchase.

string

Three-letter ISO currency code, in upper-case. Possible values are USD, CAD, and GBP. If no value is entered, currency will default to USD.

string
length between 1 and 128

The merchant id for this order.

integer

The shipping tax amount.

integer

The amount to ship the item.

shipping
object
items
object

An array of items based on the cart.

discounts
object

An array of discount codes based on the merchant.

string

The applicable Affirm financing program

string

A date-timestamp of when the checkout_id will expire.

Headers
string

Param used to identify the country in which Affirm is used and uses an "alpha-3" three-letter country code. Supported countries are the United States (USA), Canada (CAN), and the United Kingdom (GBR). If no value is entered, country-code will default to USA.

string

Optional param used to identify the language used in the browser expressed as the following- en_US if the country-code is set to USA, en_CA if the country-code is set to CAN, fr_CA for French Canadian, and if the country-code is set to GBR the affirm-locale will be en_GB for British English. If an affirm-locale is not defined, it will automatically default to English.

Responses

Language
Credentials
Basic
base64
:
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*