Contents
In this guide, we’ll cover the process of building a direct API integration, how it works, and how you can implement integration. We’ll also provide links to additional technical resources.
Overview
API stands for Application Programming Interface. It allows two software applications to interact with each other. When you create an API integration, the API shares data with a server, platform or application, enabling you to implement services such as Affirm Checkout or features like our Promotional Messaging.
Broadly speaking, an API is then an interaction between two parts: a client and a server. The client sends requests while the server returns responses based on that data. Keep in mind that the Affirm API interaction consists in creating a checkout form, tokenizing customer information securely, and using that checkout_token to initiate a transaction.
Direct API Integrations could require more time to develop because of their more complex and technical requirements. When a consumer chooses Affirm upon checkout, the basic transaction flow begins. The steps that follow will show what the customer sees on the front end and how the checkout is handled by Affirm's integration on the back end.
Note: Before an API integration can go live, Affirm will review prospective partners from a regulatory standpoint to determine the best partnership approach. This may require Affirm to apply to the UK regulator, the Financial Conduct Authority (FCA). The FCA must approve any application before the integration goes live. Contact your Affirm account executive or relationship manager to determine next steps.
Affirm uses REST APIs. If you want to know more about Affirm APIs references, check this page.
How it works
Before an API integration can go live, Affirm will review prospective partners from a regulatory standpoint to determine the best partnership approach. This may require Affirm to apply to the UK regulator, the Financial Conduct Authority (FCA). The FCA must approve any application before the integration goes live. Contact your Affirm account executive or relationship manager to determine next steps.
There are four steps to initiate the Affirm application:
Once the customer selects Affirm at checkout, the checkout initiation begins.
Implementation process
The steps below outline how to implement global integration powered by Affirm APIs. Following these steps enables you to automate your business services and improve your customers' experience.
Additional technical resources
Managing Transactions
Check Managing Global Transactions UK to learn how to manage transactions.
For more information:
- Check Authorize and Capture Transactions UK to learn about the authorization and capture flow.
- Check Actions UK to understand Affirm's Transactions API actions.
- Check Transaction States UK to learn about Affirm's transaction states.
Promotional Messaging
Bring awareness to Affirm's flexible payment options at every phase in the shopping journey—increasing conversion and average order value for your business. Our promotional messaging helps you dynamically display monthly payment pricing information and offer Pre-qualification.
Check this guide for more information on Affirm Promotional Messaging and how to add it to your site.