Affirm · Schema

MerchantObject

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

FintechBNPLLendingPaymentsConsumer

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

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/affirm/refs/heads/main/json-schema/checkout-merchant-object-schema.json",
  "title": "MerchantObject",
  "description": "Merchant-specific configuration for the checkout, including callback URLs and the public API key.",
  "type": "object",
  "properties": {
    "public_api_key": {
      "type": "string",
      "description": "The merchant's public API key. Required for checkout and store endpoints when submitting from a server context.",
      "example": "abc123def456abc123def456abc123de"
    },
    "user_confirmation_url": {
      "type": "string",
      "format": "uri",
      "description": "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.",
      "example": "https://example.com/path"
    },
    "user_cancel_url": {
      "type": "string",
      "format": "uri",
      "description": "The URL the customer is redirected to if they cancel or abandon the Affirm checkout flow.",
      "example": "https://example.com/path"
    },
    "user_confirmation_url_action": {
      "type": "string",
      "description": "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.",
      "enum": [
        "POST",
        "GET"
      ],
      "default": "POST",
      "example": "POST"
    },
    "name": {
      "type": "string",
      "description": "The merchant's display name, shown to customers during checkout.",
      "example": "Example Merchant"
    }
  },
  "required": [
    "user_confirmation_url",
    "user_cancel_url"
  ]
}