Skip to main content

Merchant Help

 

Affirm Merchant Help

Merchant Dashboard

Overview

The Affirm merchant dashboard provides the following capabilities:

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 for assistance.

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 integration

Screen Shot 2018-09-11 at 12.38.25 PM.png

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

Screen Shot 2018-09-11 at 12.52.43 PM.png

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

Screen Shot 2018-09-11 at 12.55.59 PM.png

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

Screen Shot 2018-09-11 at 1.00.15 PM.png

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.

Screen Shot 2018-09-11 at 1.06.56 PM.png

You can search 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

Screen Shot 2018-09-11 at 1.09.52 PM.png

Billing and shipping addresses

Screen Shot 2018-09-11 at 1.11.00 PM.png

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.

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.

View transaction analytics

On the left navigation bar on the main page, click Analytics to see your transaction analytics. You can select a time frame by clicking SHOWING and selecting:

  • Past 7 days
  • Past 30 days
  • All time
  • Custom date range

You can view the number of charges, total amount capture, total amount authorized, and average order value for that time frame. In the chart, you can select what you want to see see by clicking VIEW and selecting:

  • Authorized charges
  • Authorized amount
  • Captured amount
  • Settled amount

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

Screen Shot 2018-08-29 at 3.28.54 PM.png

  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)

Screen Shot 2018-08-29 at 3.31.18 PM.png