Save Business Configuration

Saves the defaults for all your Hosted Checkout sessions: appearance, logo, checkout design, button type and language. They apply unless the session overrides them.

POST
/checkout/v1/business/config

Authorization

Authorization
Authorization<token>

Your public API key, with the word Token and a space in front of it. Example: Token 6534bc0a7e1f4d2b9c8e3a5f7b1d2c4e6f8a9b0c — that whole value is the header. Sending the key alone returns 401 'Authentication credentials were not provided'. In this playground you may paste just the key; the prefix is added for you.

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/checkout/v1/business/config" \  -F status="active" \  -F ui_config="{\"template\":\"ecommerce\",\"branding\":{\"brand_color\":\"#025E73\"},\"theme\":{\"font_family\":\"inter\",\"shapes\":\"rounded\"}}"
{
  "status": "active",
  "ui_config": {
    "template": "ecommerce",
    "branding": {
      "brand_color": "#025E73"
    },
    "theme": {
      "font_family": "inter",
      "shapes": "rounded"
    }
  },
  "logo_url": "https://your-store.com/assets/logo.png",
  "checkout_ui_version": "v2",
  "submit_type": "pay",
  "locale": "es"
}
{
  "code": "E004",
  "message": "The request was invalid. Please check your input and try again.",
  "metadata": {},
  "name": "TNDR004",
  "statusCode": 400
}
Was this page helpful?