Affirm-developers

Documentation
API reference
Changelog

{{user.name}}Log In

Documentation

Welcome to the Affirm! You'll find comprehensive guides and documentation to help you start working with Affirm to give your customers the best buying experience possible. Let's jump right in!

HomeDocumentationAPI referenceReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API LogsTutorials

Home

Introduction

Affirm Direct API

Overview
Render the hosted-checkout
Charges
In-Store
Direct
Telesales

Platforms

Platforms quickstart
Shopify
Magento
Magento 2
WooCommerce overview
Salesforce Commerce Cloud (SFCC)
BigCommerce
All Platforms
Tag management
- Google Tag Manager

Affirm promotional messaging

About promotional messaging
Placement
Customize your promotional messaging
Upgrading educational modals
Upgrade your promotional messaging
- Upgrade legacy promotional messsaging
- Update promotional messaging attributes
Branding assets
HTML reference
Prequalification

Development

Quickstart
API keys
Security
Error codes
Supported browsers
Webhooks
- Checking webhook signatures
- Best practices
Recipes
VCN testing
Tools
Performance

Affirm.js reference

Overview
Create a checkout object
Open Affirm Direct Checkout
Open Affirm Virtual Card Checkout
Create a component
Update a component
Render a component
Confirmation page analytics
Enhanced analytics
Promo library

Merchant operations

Getting started with Affirm
Dispute resolutions
Getting paid
- Updating bank information
Dashboard
- Processing transactions
- Processing refunds
Settlement reports
- SFTP settlement file access
- Schedule settlement reports
Customer-facing teams FAQ
Checkout flows
Limits
Best practices

Marketing

Getting started
Marketing toolkit
Email marketing
- Bronto
- Datacrushers
Compliance & guidelines
Zero-percent financing

Partners

Affirm partners
Monthly Payment Messaging API
Technical certification requirements
Test and go-live
Platform metadata

Home

Introduction

Affirm Direct API

Overview
Render the hosted-checkout
Charges
In-Store
Direct
Telesales

Platforms

Platforms quickstart
Shopify
Magento
Magento 2
WooCommerce overview
Salesforce Commerce Cloud (SFCC)
BigCommerce
All Platforms
Tag management
- Google Tag Manager

Affirm promotional messaging

About promotional messaging
Placement
Customize your promotional messaging
Upgrading educational modals
Upgrade your promotional messaging
- Upgrade legacy promotional messsaging
- Update promotional messaging attributes
Branding assets
HTML reference
Prequalification

Development

Quickstart
API keys
Security
Error codes
Supported browsers
Webhooks
- Checking webhook signatures
- Best practices
Recipes
VCN testing
Tools
Performance

Affirm.js reference

Overview
Create a checkout object
Open Affirm Direct Checkout
Open Affirm Virtual Card Checkout
Create a component
Update a component
Render a component
Confirmation page analytics
Enhanced analytics
Promo library

Merchant operations

Getting started with Affirm
Dispute resolutions
Getting paid
- Updating bank information
Dashboard
- Processing transactions
- Processing refunds
Settlement reports
- SFTP settlement file access
- Schedule settlement reports
Customer-facing teams FAQ
Checkout flows
Limits
Best practices

Marketing

Getting started
Marketing toolkit
Email marketing
- Bronto
- Datacrushers
Compliance & guidelines
Zero-percent financing

Partners

Affirm partners
Monthly Payment Messaging API
Technical certification requirements
Test and go-live
Platform metadata

Affirm API

Introduction
Authentication
Errors
Metadata
Data types

Charges

The charge object
- The event object
post
Authorize
get
Read charge
post
Capture
- The capture object
post
Refund
- The refund object
post
Update
post
Void
- The void object

Checkout

The checkout response object
The checkout object
The metadata object
- The customer object
- The itinerary object
get
Read
post
Store
post
Update
post
Direct
post
Resend

Cards

The card object
The response object
post
Cancel
post
Finalize
get
Read

Shared objects

Update object
Shipping & billing objects
- Address object
- Name object

Events

The checkout event object
The prequal event object

Transactions

Transactions API
Transaction Object
Event Object
post
Authorize
post
Capture
get
Read transaction
post
Update
post
Void
post
Refund

Preview

Getting Started With Your API

All Platforms

Affirm offers integrations with some of the most popular e-commerce platforms.

Please choose your platform below to see the relevant documentation:

3dcart

Americommerce

ASPDotNetStorefront

ASPDotNetStorefront

BigCommerce

Celery

Cardinal Commerce

Cardinal Commerce

CyberSource

Drupal Commerce

Drupal Commerce

Hybris

Inntopia

Kibo

Kibo (Mozu)

KWI

Lightspeed Ecommerce

Lightspeed Ecommerce

Miva

Magento

Magento 2

Netsuite

Netsuite SuiteCommerce

NitroSell

OpenCart

Oracle Commerce (ATG)

osCommerce

DemandWare

Salesforce Commerce Cloud

Shopgate

Shopify

Shopping Cart Elite

Shopping Cart Elite

Spree

Solidus

SunShop

Thinkspace

Volusion

Web Shop Manager

Web Shop Manager

WooCommerce

Zen Cart

Zoey

Updated 9 days ago

All Platforms

Affirm offers integrations with some of the most popular e-commerce platforms.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.

Footer goes here

We're currently having some issues with our infrastructure. Please check back soon to see if this has been resolved. Learn more