In-Store Integration Guide

Integrate Affirm into your point-of-sale system to offer flexible payment options in-store. This guide covers initiating checkouts, sending payment links, authorizing transactions, and managing orders for a seamless customer experience.

Aperçu

Affirm’s In-Store Integration enables merchants to offer Affirm as a payment option within their point-of-sale (POS) systems. This guide walks you through the process of integrating Affirm, from initiating in-store checkouts to confirming and managing transactions.

When a customer chooses Affirm at checkout, a payment link is sent to them via email or text, allowing them to complete their purchase on their own device. Once approved, Affirm notifies your system, enabling seamless order authorization and confirmation.

By integrating Affirm’s in-store solution, merchants can provide customers with flexible payment options while ensuring a smooth transaction experience at the point of sale.


How It Works

Ce diagramme démontre la manière dont vos clients, votre système de vente, votre serveur (par ex., OMS) et Affirm interagissent :

A diagram of how Affirm interacts with point of sale and order management systems.


1. In-store Checkout

Les associés des ventes sélectionneront Affirm comme option de paiement dans votre système de point de vente. Cette action déclenchera une demande à Affirm d'envoyer directement un lien de paiement (par courriel/texte) aux clients.

POST /api/v2/checkout/store HTTP/1.1
Host: sandbox.affirm.com
Content-Type: application/json

{
      "merchant": {
        "public_api_key":               "PUBLIC_API_KEY",
        "user_cancel_url":				"https://www.google.com",
        "user_confirmation_url":        "https://www.affirm.com",
        "user_confirmation_url_action": "POST",
       "name":                         "In-store Affirm demo"
      },
      "billing":{
        "name":{
          "full":                        "John Doe"
        },
        "address":{
          "line1":                       "325 Pacific Ave",
          "city":                        "San Francisco",
          "state":                       "CA",
          "zipcode":                     "94112",
          "country":                     "USA"
        },
        "phone_number":                  "4155552222",
        "email":                         "[email protected]"
      },
  "metadata": {
    "entity_name": "Vignan 1234",
    "store_location": "Denver"
  },
      "order_id":                        "00de5cee-7226-4aec-b729-a571f773a58c",
      "total":                           5000         
  }

🚧

Receiving the Checkout URL

L'API Store n'enverra des SMS que dans l'environnement Affirm Live. Pendant les tests de l'environnement Sandbox, veuillez vous fier aux messages électroniques pour recevoir l'URL de paiement, afin de finaliser votre achat Affirm.


2. Webhook Confirm Event

Lorsqu'un utilisateur reçoit et confirme son prêt, le serveur d'Affirm sera informé de cet événement. Un checkout_id sera renvoyé sur votre serveur à l'URL du webhook que vous avez fourni


3. Create Order

Sur confirmation, le serveur d'Affirm POST renverra à votre serveur un événement de paiement contenant le checkout_id. Ce checkout_id aussi appelé transaction_id doit être autorisé de manière sécurisée avant d'enregistrer la commande ou de mettre à jour le statut de la commande sur le terminal du magasin.


4. In-store Confirmation

Après une autorisation réussie via Affirm, le terminal en magasin doit pouvoir recevoir la confirmation de commande et refléter le statut payé en temps quasi réel.


5. Manage Order

Vous pouvez lancer différentes actions de transaction en fonction de vos processus internes.