Skip to main content


Affirm Merchant Help

Merchant Object v2 (Direct Checkout API Version)

Merchant object

The merchant object contains the user_confirmation_url and user_cancel_url, which represent the two possible outcomes of the checkout attempt. The user goes to the confirmation_url if the user is approved and confirms their loan. The user goes to the cancel_url in all other cases (voluntary cancel, credit decline, identity verification issue, etc.). 

Field Name R/O/C Type Description
public_api_key R String API Key of the merchant creating the checkout request
user_confirmation_url R URL

URL that the customer is sent to if they successfully complete the Affirm checkout flow. 

A checkout_token will be sent to this URL in the POST request, and that checkout_token should be used to authorize the charge before the user is redirected to the order confirmation page.

user_cancel_url R URL

URL that the customer is sent to if the customer exits the Affirm checkout flow.

This is the same if the user voluntarily cancels or closes the window before completion, or if the user is denied. You should setup the cancel_url to be the checkout payment page, and you can also append analytics tags to the URL to help you identify who you may want to reach out to about alternative payment methods or reapplying.

user_confirmation_url_action O String Accepted values are: 'GET', 'POST'. Defaults to 'POST'. Preference is to use 'GET'. Read more here.
name O String

For phone sales implementation, you will always want to specify a merchant facing name. Otherwise, customers will see the 'Telesales' suffix on the end of your company name.

If you have multiple sites operating under a single Affirm account, you can override the external company/brand name that the customer sees. This affects all references to your company name in the Affirm UI.

use_vcn O Boolean

If you are using the Affirm Virtual Card Number (VCN) integration method set this to true.

  • Was this article helpful?