Skip to main content

Building a direct API integration - Overview

  • Updated

Contents

  1. Overview
  2. Transaction flow
  3. Implementation process

 

In this guide, you’ll learn about the process of building a direct API integration. There’s an overview explaining what our API is and how it works, as well as definitions of different concepts and links to additional technical information.

 

By following each of the steps below, you will be able to automate your business services and improve your customers' experience!

 

 

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 of 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: Affirm uses REST APIs. If you want to know more about Affirm APIs references, please visit this site.

 

You can watch the video or check the steps below for building an API integration.

 

Back To Top

 

Transaction flow

This is the complete checkout flow. It is divided into four phases as described below.

 

1.__Overview__-_Transaction_flow.png

1. Customer initiates a checkout

The Affirm checkout process begins when the customer selects Affirm as their payment method and submits a checkout.

2.__Overview__-_Customer_checkout.png

2. Create, configure, and send the checkout object

Then, on the merchant’s side, a process starts as shown below.

3.__Overview__-_Create_checkout_object.png

 

3. Collect customer information

4.__Overview__-_Collect_customer_details.png

 

4. Authorize the transaction and complete the order

5.__Overview__-_Authorize_and_complete_order.png

 

Back To Top

 

Implementation process

Direct API integrations require some coding. There are a few things you must do before you can deploy it to your production account and go live:

  1. Retrieving your API keys
  2. Development
  3. Testing your integration
  4. Deploying your integration

 

We'll cover each of these steps in separate articles.

 

Back To Top

>> Step 1: Retrieving your API keys

 

Related articles