API de caisse express

❗️
Vous souhaitez offrir Affirm Express Checkout ?
Contactez votre gestionnaire de compte Affirm pour confirmer la disponibilité et connaître les prochaines étapes pour construire vos API.

Aperçu

Affirm Express Checkout s’appuie sur deux points de terminaison API hébergés par les commerçants pour compléter dynamiquement le processus de paiement dans l’expérience Affirm :

Ces points de terminaison permettent à Affirm de recueillir les détails d’expédition des clients, de présenter des méthodes d’expédition valides, de calculer les taxes et les totaux, et de retourner les détails de la commande finalisés au commerçant après la confirmation du prêt.

En transférant la collecte d’adresses et le calcul de la caisse dans le flux hébergé d’Affirm, les commerçants peuvent réduire la complexité de la caisse tout en conservant un contrôle total sur la logique d’expédition, les prix et les calculs fiscaux en arrière-plan.

Options d'expédition de l'API

L'API Options d'expédition renvoie toutes les méthodes d'expédition valides pour un panier et une adresse de livraison donnés.

corps

Champ	Type	Description
Articles requis	objet	Les articles dans le panier de l’utilisateur. Voir l’objet Objets pour plus de détails.
expédition requise	objet	Les détails de l'expédition. Voir l’objet ShippingBilling pour plus de détails.
order_id	string	Identifiant marchand permettant de référencer la session de paiement en cours. Veuillez noter que le commerçant est toujours tenu de fournir une confirmation `order_id` après le prêt.
Devise requise	string	Code de devise ISO à trois lettres en majuscules

Objet des articles

Champ	Type	Description
display_name obligatoire	string	Le nom d'affichage du produit/élément.
référence requise	string	Le produit/article SKU.
unit_price requis	integer	The item price amount in USD or CAD cents.
qty	integer	Quantité de l'article.
item_image_url	string	L'URL de l'image du produit de l'article.
item_url	string	L'URL de la page de description du produit.
categories	array	Les catégories qui s'appliquent au produit/article et la hiérarchie des définitions de ces catégories. Chaque liste du tableau contient une ou plusieurs chaînes séparées par des virgules, la première chaîne correspondant à la catégorie de plus haut niveau (la plus large).

ShippingBilling objet

Champ	Type	Description
name	objet	Le nom du client. Voir l’objet Nom pour plus de détails.
Adresse requise	objet	L'adresse de l'utilisateur. Voir le objet Adresse pour plus de détails.
Numéro de téléphone	string	Le numéro de téléphone du client.
Courriel	string	L’adresse courriel du client.

Name object

Champ	Type	Description
first	string	Le prénom du client. Peut contenir plusieurs mots (pour les prénoms).
last	string	Customer's last name.
full	string	Note : Ce champ est obligatoire si les prénoms et noms de famille manquent. La chaîne doit contenir au moins deux mots.

Address object

Champ	Type	Description
ligne 1 requise	string	Ligne d'adresse 1 (p. ex. rue, boîte postale ou nom de l'entreprise).
line2	string	Address line 2 (e.g., apartment, suite, unit, or building).
ville requise	string	City, district, suburb, town, or village.
État requis	string	State, county, province, or region.
Code postal requis	string	Code postal.
pays requis	string	Code de pays à deux lettres (ISO 3166-1 alpha-2).

API des totaux de la caisse

L'API des totaux de caisse calcule le total final du panier après que le client a sélectionné une option d'expédition.

corps

Champ	Type	Description
Articles requis	objet	Les articles dans le panier de l’utilisateur. Voir l’objet Objets pour plus de détails.
expédition requise	objet	Les détails de l'expédition. Voir l’objet ShippingBilling pour plus de détails.
selected_shipping_option requis	objet	L’option d’expédition choisie. Voir l’objet ShippingOption pour plus de détails.
order_id	string	Identifiant marchand permettant de référencer la session de paiement en cours. Veuillez noter que le commerçant est toujours tenu de fournir une confirmation `order_id` après le prêt.
Devise requise	string	Code de devise ISO à trois lettres en majuscules

Objet des articles

Champ	Type	Description
display_name obligatoire	string	Le nom d'affichage du produit/élément.
référence requise	string	Le produit/article SKU.
unit_price requis	integer	The item price amount in USD or CAD cents.
qty	integer	Quantité de l'article.
item_image_url	string	L'URL de l'image du produit de l'article.
item_url	string	L'URL de la page de description du produit.
categories	array	Les catégories qui s'appliquent au produit/article et la hiérarchie des définitions de ces catégories. Chaque liste du tableau contient une ou plusieurs chaînes séparées par des virgules, la première chaîne correspondant à la catégorie de plus haut niveau (la plus large).

ShippingBilling objet

Champ	Type	Description
name	objet	Le nom du client. Voir l’objet Nom pour plus de détails.
Adresse requise	objet	L'adresse de l'utilisateur. Voir le objet Adresse pour plus de détails.
Numéro de téléphone	string	Le numéro de téléphone du client.
Courriel	string	L’adresse courriel du client.

Objet ShippingOption

Champ	Type	Description
shipping_id requis	string	L'identifiant de l'option d'expédition.
shipping_type requis	string	Le type de méthode d’expédition.
shipping_amount requis	integer	The item price amount in USD or CAD cents.

Name object

Champ	Type	Description
first	string	Le prénom du client. Peut contenir plusieurs mots (pour les prénoms).
last	string	Customer's last name.
full	string	Note : Ce champ est obligatoire si les prénoms et noms de famille manquent. La chaîne doit contenir au moins deux mots.

Address object

Champ	Type	Description
ligne 1 requise	string	Ligne d'adresse 1 (p. ex. rue, boîte postale ou nom de l'entreprise).
line2	string	Address line 2 (e.g., apartment, suite, unit, or building).
ville requise	string	City, district, suburb, town, or village.
État requis	string	State, county, province, or region.
Code postal requis	string	Code postal.
pays requis	string	Code de pays à deux lettres (ISO 3166-1 alpha-2).

Mis à jour 3 days ago