Store

post

https://api.global.affirm.com/api/v2/checkout/store

Initiate an Affirm checkout directly with your customers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
Store Checkout vs. Direct Checkout
The Store endpoint automatically sends an email and SMS with checkout links to customers, whereas the Direct endpoint simply redirects customers to a checkout URL without sending any notifications.

Body Params

Returns the checkout object.

merchant

object

required

A list of items specific to the merchant.

billing

object

The customer billing information.

total

integer

The total amount in cents of the purchase.

currency

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.

order_id

string

length between 1 and 128

The merchant id for this order.

tax_amount

integer

The shipping tax amount.

shipping_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.

financing_program

string

The applicable Affirm financing program

checkout_expiration

string

A date-timestamp of when the checkout_id will expire.

Headers

country-code

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.

affirm-locale

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

Store Checkout vs. Direct Checkout

200HTTP 200 OK

400HTTP 400 Bad Request

401HTTP 401 Unauthorized

404HTTP 404 Not Found