Attributes

Attribute

Data type

Description

user_confirmation_url
required

string

The URL the customer is redirected to if they successfully complete the Affirm checkout flow. A checkout_id will be sent to this URL in the POST request.

user_cancel_url
required

string

The URL the customer is redirected to if they exit 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.

public_api_key
required

string

The public_api_key can be retrieved from the Merchant Portal and must be included in the merchant object. The public key is specific to the sales channel the transaction starts. e.g. e-commerce, telesales, in-store, etc.

user_confirmation_url_action
optional

string

Supported values:

  • GET
  • POST (Default)

use_vcn
optional

boolean

A flag to enable virtual card integration (default is false).

name
optional

string

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.

{ 
   "user_confirmation_url":"https://merchantsite.com/confirm",
   "user_cancel_url":"https://merchantsite.com/cancel",
   "public_api_key": "{YOUR PUBLIC_API_KEY}",
   "user_confirmation_url_action":"POST",
   "use_vcn": false,
   "name":"External Company Name"
}