AccueilCommencerSolutionsPlateformesIntégrations globales
Référence API

The checkout object

The checkout object is the data payload that contains information about the customer's order. It is POSTed to the Affirm API to initialize Affirm checkout.

Attributs

AttributType de donnéesDescription
commerçant
Obligatoire		objetMerchant specific information. See merchant details.
Expédition
required*		objetThe shipping details. Note: Shipping is not required if the merchant is not shipping goods for the given transaction.
facturation
optionnel		objetThe billing details.
Articles
Obligatoire		tableauUn tableau d'élément.
discounts
optionnel		objetUne liste de réductions. Chaque réduction doit avoir son code de réduction.
métadonnées
optionnel		objetSee metadata details.
order_id
optionnel		stringID de commande du commerçant. Ceci est stocké à des fins de référence ultérieure.
currency
Obligatoire		stringThree-letter ISO currency code, in uppercase.

Possible values:

- USD
- CAD
financing_program
optionnel		stringUn programme de financement appliqué à ce paiement.
montant_expédition
Obligatoire		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
Obligatoire		integerThe total tax amount in cents. A positive integer representing how much, in USD or CAD cents (e.g., 100 cents to charge $1.00).
Total
Obligatoire		integerThe total amount of the checkout in USD or CAD cents (e.g., 100 cents to charge $1.00).
checkout_expirationHorodatageA date-timestamp of when the checkout_id will expire. - ISO timestamp format - No milliseconds

🚧

Clé API publique

Please note that the public_api_key is required for checkout and store endpoints and must be included in the checkout object.

📚
Configurer l'objet Checkout
Ouvrir la recette
{
   "merchant":{
      "user_confirmation_url":"https://merchantsite.com/confirm",
      "user_cancel_url":"https://merchantsite.com/cancel",
      "public_api_key": "{YOUR PUBLIC_API_KEY}",
      "user_confirmation_url_action":"POST",
      "use_vcn": false,
      "name":"Your Customer-Facing Merchant Name"
   },
   "shipping":{
      "name":{
         "full":"John Doe"
      },
      "address":{
         "line1":"633 Folsom St",
         "city":"San Francisco",
         "state":"CA",
         "zipcode":"94107",
         "country":"US"
      },
      "phone_number":"4155555555",
      "email":"[email protected]"
   },
   "billing":{
      "name":{
         "full":"John Doe"
      },
      "address":{
         "line1":"633 Folsom St",
         "city":"San Francisco",
         "state":"CA",
         "zipcode":"94107",
         "country":"US"
      },
      "phone_number":"4155555555",
      "email":"[email protected]"
   },
   "items":[
      {
         "display_name":"Awesome Pants",
         "sku":"ABC-123",
         "unit_price":10000,
         "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":"fp_3z6r12r",
   "shipping_amount":10000,
   "tax_amount":600,
   "total":30100
}