Affirm-developers

Dashboard

Learn about using the Merchant Dashboard to manage your Affirm account.

Overview

Affirm's Merchant Dashboard provides a robust user interface that allows you to manage and configure your Affirm account. Within the Merchant Dashboard, you can view your transaction analytics, manage charges, access your API keys, and more.

Click here for information on accessing the merchant dashboard. If you'd like to be added as a new user, contact your company's dashboard Administrator directly. If you're unsuccessful in reaching your Administrator or you're experiencing access issues, contact us using the support button in the bottom right.

Account setup

To access your merchant dashboard, you'll need to create an account and then sign in to it. The merchant dashboard is available in the sandbox environment and the live environment. The sandbox environment is for development and testing. Affirm activates the live environment after testing is complete.

Either Affirm (typically the Client Success Manager) or whoever is administering Affirm at your company, via the settings page, can grant you access to the merchant dashboard. After giving you access, you'll receive an email invitation.

In the email, click ACCESS DASHBOARD.

Create your account either using Google or using your work email and password. For both cases, you must use the email associated with Affirm access. If your organization requires two-factor authentication, you must create an account using Google. If you want to use Google, but your work email doesn't use it, then click here to connect your work email to Google.

Google Account

To create an account using Google:

1. Click Sign in with Google
2. Select your work Google account

To create an account with your email:

1. Enter your email address
2. Enter a password that is at least 8 characters long
3. Confirm your password
4. Click Create account

Signing into your account

Sign in to the merchant dashboard at

If you created your account using Google, then click Sign in with Google otherwise enter your email and password and click Sign In.

If you forget your password, click Forgot password? and complete the password recovery process.

Troubleshooting

The email address is not linked the Affirm Dashboard

This email address does not yet have access. Ensure you're using the correct address and contact either your company's admin or your Affirm Customer Success Manager.

ACCESS DENIED

Your Google account does not yet have access. Ensure you're using the correct account and that you're using the primary email address as you can't use an email alias to sign in. For example, if your primary account is [email protected] and your alias is [email protected], you must use [email protected]. If you're still having issues, contact either your company's admin or your Affirm Customer Success Manager.

Live environment dashboard not available

If you're having trouble accessing your live environment dashboard, it may because you're still in the integration phase and Affirm has not activated it yet. If you are using the sandbox environment connected to your production site for testing, please ensure that you don't process orders in your online order management system. 

Navigating the dashboard

The left navigation panel within the Dashboard allows you to view and manage different aspects of your Affirm account. For example, the Analytics section provides an at-a-glance understanding of key transaction metrics. Additionally, you can use the Dashboard to perform some actions, such as processing transactions, without using the API.

View transaction analytics

🚧

Transaction analytics update

We are working on an update to our Analytic feature and it is currently unavailable in the dashboard at this time. If you're looking for analytics data, please reach out to [email protected] or click the Developer Support widget at the bottom of the screen.

Manage charges

You can view and process your charges in the merchant dashboard.

View charges

When you sign in to the dashboard, you'll see the most recent charges.

You can search for charges entering the order ID, loan ID, status, amount, customer email, customer name, or customer phone number in the search bar. When you click on a charge row, you can view the following:

  • Date of charge confirmation
  • Affirm confirmation code
  • Customer name
  • Charge status
  • Total charge amount
  • Charge history
  • Shopping cart details
  • Billing and shipping addresses

Shopping cart details

Billing and shipping addresses

Process charges

If you're using an e-commerce platform that supports processing Affirm charges in its order management system, then we recommend using that platform to process those charges. This will keep Affirm synced with your platform. If your platform does not support processing Affirm charges or you integrated Affirm via our API, then click here for instructions on processing orders in the dashboard.

Schedule settlement reports

You can schedule emails with settlement reports to any email address.

1. Sign in to your merchant dashboard
2. On the left navigation bar, click Settlements
3. Click SET UP EMAIL REPORTS

1. Click the Scheduled Reports tab
2. Click the (+) icon next to EMAIL PREFERENCES
3. Enter the email address for the recipient
4. Select which report to send (daily, weekly, monthly)

📘

About settlement reports

Click here for more information about settlement reports.

Access API keys

1. On the left navigation bar of the main page, hover over the key icon on the lower left
2. Click the API KEYS link that appears
3. Copy the public and private keys and store that information to use for the integration

View API logs

On the left navigation bar of the main page, click API logs (the code icon </>) to view the most recent API logs. You can search API logs entering the status, endpoint, method, request ID checkout ID, or charge  ID in the search bar.

HTTP response

Description

200

Successful API call

302

Customer successfully redirected to Affirm checkout flow [only for Shopify]

40x

Error: Bad checkout information or incorrect API keys

500

Bad request: Incorrect syntax or wrong API URL

For reference, these are the endpoints.

Endpoint

Description

/checkout/

Initiate checkout

/charges/

Authorize charge

/charges/<charge_id>

Read charge details

/charges/<charge_id>/capture

Capture charge

/charges/<charge_id>/void

Void charge

/charges/<charge_id>/refund

Refund charge (full refund unless amount is specified in the reponse).

/charges/<charge_id>/update

Change shipping information or order ID.

Manage dashboard users

Merchant dashboard users are either administrators or non-administrators. Only administrators can add, edit, and remove users. A merchant account does not require any administrators, so it's possible that an account has 0 administrators. If you're the only administrator, you cannot remove yourself, but if there are others, you can remove them. To check your status, on the main page, go to Settings > Users and find your email address and the associated permissions.

Add a user

1. On the main page, go to Settings > Users
2. Click the blue (+) button
3. Enter the work email address for the user and choose the user's permission level
4. Click ADD USER

The user will receive an email notifying them that you've added them.

Edit a user's permission level

You can only edit a user's permission level, not the user's email address.

1. On the main page, go to Settings > Users
2. Click on the pencil icon in the Actions column for the user's email address
3. Click the other permission level
4. Click SAVE CHANGES

Remove a user

1. On the main page, go to Settings > Users
2. Click on the X in the Actions column for the user's email address
3. Click REMOVE USER

Updated 22 days ago


Dashboard


Learn about using the Merchant Dashboard to manage your Affirm account.

Suggested Edits are limited on API Reference Pages

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