affirm · Schema

MerchantObject

Merchant-specific configuration for the checkout, including callback URLs and the public API key.

Properties

Name Type Description
public_api_key string The merchant's public API key. Required for checkout and store endpoints when submitting from a server context.
user_confirmation_url string The URL the customer is redirected to after successfully completing the Affirm checkout flow. A checkout_token is delivered to this URL via POST or GET depending on user_confirmation_url_action.
user_cancel_url string The URL the customer is redirected to if they cancel or abandon the Affirm checkout flow.
user_confirmation_url_action string Determines how the checkout_token is delivered to the user_confirmation_url. "POST" sends it as a form body field; "GET" appends it as a query parameter.
name string The merchant's display name, shown to customers during checkout.
View JSON Schema on GitHub