v1

latestOpenAPI 3.0.02026-07-26167441.9 MB

Publish Checkout Configuration

Writes configuration and/or styling for the checkout in a single call. The body may contain a config object, a styling object, or both — at least one is required. Each part is validated independently before being applied; if any rule fails, the request is rejected with a single aggregated 400 and nothing is applied. Configuration is a sparse upsert (omitted payment methods keep their previous state; new methods cannot be created). Styling is a partial merge (omitted or null fields are preserved).

put/checkouts/{checkout_code}

Path parameters

checkout_codestring required

The unique identifier of the checkout to update (UUID, 36 chars). Non-UUID values are rejected with 400 before processing.

Headers

X-Idempotency-Keystring

Client-generated UUID. Re-sending the same request with the same key is safe and will not double-publish.

Request body

Example request

{
  "config": {
    "payment_methods": [
      {
        "payment_method_type": "CARD",
        "is_active": true
      }
    ],
    "general_settings": {
      "country_documents": [
        {
          "country_code": "BR",
          "documents": [
            "CPF",
            "CNPJ"
          ]
        }
      ]
    }
  }
}

Response

The updated checkout (configuration + styling composed). Its identifier is exposed as the top-level id.

object required