SupportLog in
DocsAPI ReferenceSDK ReferenceResourcesPayments ManagementChangelog

Set Business Configuration

Sets the default UI configuration (logo and styles) for all your Hosted Checkout sessions. It applies to every session unless overridden at the session level.

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

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/checkout/v1/business/config" \  -H "Content-Type: application/json" \  -d '{    "logo_url": "https://cdn.my-store.com/logo.png",    "ui_config": {      "branding": {        "brand_color": "#1A2B3C"      },      "theme": {        "shapes": "rounded"      }    }  }'
{
  "logo_url": "https://cdn.my-store.com/logo.png",
  "ui_config": {
    "branding": {
      "brand_color": "#1A2B3C"
    },
    "theme": {
      "shapes": "rounded"
    }
  }
}
Was this page helpful?