Patch express config

https://api.playground.kustom.co/elements/v1/clients/{clientId}/express

Partially updates the existing express config. Only fields present in the request body are applied; omitted fields keep their existing value. Fails with 409 if no express config exists yet — use PUT to create one.

Parameters

Request body

200

400

401

409

502

Example

Parameters2 fields

• clientIdstringrequiredin path

  Client identifier

• x-merchant-idstringrequiredin header

  Merchant identifier used to scope the client

Request body7 fields

• push_urlstringoptional

  Push notification URL. Omit to keep the current value.

• validation_urlstringoptional

  Merchant validation URL. Omit to keep the current value.

• confirmation_urlstringoptional

  Merchant confirmation URL. Omit to keep the current value.

• payment_methods[]array<object>optional

  Ordered list of payment methods. Omit to keep the current list; provide (even empty) to replace it.

  3 fields in payment_methods

  • methodstringoptional
    • AMAZON_PAY
    • APPLE_PAY
    • GOOGLE_PAY
    • KLARNA
    • PAYPAL
    • UNKNOWN
  • display_modestringoptional
    • always
    • auto
    • never
  • providerstringoptional
    • STRIPE
    • PAYPAL

200

Response22 fields

OK

• idstringoptional

  Unique identifier for the client.

• merchant_idstringoptional

  The ID of the merchant that owns the client.

• allowed_origins[]array<string>optional

  Browser origins permitted to use this client.

• namestringoptional

  Friendly name shown in the portal.

• placements[]array<object>optional

  Placements configured for this client.

  15 fields in placements

  • keystringoptional

    Placement key configured for the client.

  • custom_stylesstringoptional

    Optional CSS that will be injected into the placement container.

  • content[]array<object>optional

    Information required to render the placement.

    4 fields in content

    • typestringoptional

      Type of placement content.

      • PAYMENT_METHOD
      • EXTERNAL_PAYMENT_METHOD
      • DELIVERY_CARRIER
      • EXPRESS_CHECKOUT
    • namestringoptional

      The name of the content.

      • STRIPE_PUBLIC_API_KEY
      • STRIPE_ACCOUNT_ID
      • NONE
    • valuestringoptional

      The value of the content.

    • imageUrlstring · urioptional

      The URL for the image to be rendered.

  • express_configobjectoptional

    The configuration for the Express checkout flow.

    7 fields in express_config

    • push_urlstringrequired

      URL that will be used for push notification when an order is completed. Should be different than checkout and confirmation URLs. (max 2000 characters) Example: “https://merchant.com/push”

    • validation_urlstringoptional

      URL that will be requested for final merchant validation. (must be https, max 2000 characters) Example: “https://merchant.com/validation”

    • confirmation_urlstringrequired

      URL of the merchant confirmation page. The consumer will be redirected back to the confirmation page if the authorization is successful after the customer clicks on the ‘Place Order’ button inside checkout. The special characters of the confirmation URL should be encoded, e.g. the “space” character should be written as “%20”. Then, on top of that, the whole confirmation URL should be encoded. E.g. the “space” character should become “%2520”. (max 2000 characters) Example: “https://merchant.com/confirmation.html”

    • payment_methods[]array<object>optional

      An ordered list of payment methods and how they should be offered in the express checkout.

      3 fields in payment_methods

      • methodstringoptional
        • AMAZON_PAY
        • APPLE_PAY
        • GOOGLE_PAY
        • KLARNA
        • PAYPAL
        • UNKNOWN
      • display_modestringoptional
        • always
        • auto
        • never
      • providerstringoptional
        • STRIPE
        • PAYPAL
• created_atstring · date-timeoptional

  Time when the client was created.

• updated_atstring · date-timeoptional

  Time when the client was last updated.

400

Response4 fields

Bad Request

• messagestringoptional
• additional_contextobjectoptional
  1 field in additional_context

  • keystringoptional

    Any additional property. The key is free-form; the value has this shape.

• codestringoptional
  • CLIENT_NOT_FOUND
  • ORIGIN_NOT_ALLOWED
  • HTTP_CLIENT_ERROR
  • HTTP_SERVER_ERROR
  • DOMAIN_NOT_WHITELISTED
  • PLACEMENT_CONFIG_MISSING
  • ARGUMENT_NOT_VALID
  • CONSTRAINT_VIOLATION
  • PROFILE_DOESNT_BELONG_TO_MERCHANT
  • MERCHANT_NOT_FOUND

401

Response4 fields

Unauthorized

• messagestringoptional
• additional_contextobjectoptional
  1 field in additional_context

  • keystringoptional

    Any additional property. The key is free-form; the value has this shape.

• codestringoptional
  • CLIENT_NOT_FOUND
  • ORIGIN_NOT_ALLOWED
  • HTTP_CLIENT_ERROR
  • HTTP_SERVER_ERROR
  • DOMAIN_NOT_WHITELISTED
  • PLACEMENT_CONFIG_MISSING
  • ARGUMENT_NOT_VALID
  • CONSTRAINT_VIOLATION
  • PROFILE_DOESNT_BELONG_TO_MERCHANT
  • MERCHANT_NOT_FOUND

409

Response4 fields

Conflict

• messagestringoptional
• additional_contextobjectoptional
  1 field in additional_context

  • keystringoptional

    Any additional property. The key is free-form; the value has this shape.

• codestringoptional
  • CLIENT_NOT_FOUND
  • ORIGIN_NOT_ALLOWED
  • HTTP_CLIENT_ERROR
  • HTTP_SERVER_ERROR
  • DOMAIN_NOT_WHITELISTED
  • PLACEMENT_CONFIG_MISSING
  • ARGUMENT_NOT_VALID
  • CONSTRAINT_VIOLATION
  • PROFILE_DOESNT_BELONG_TO_MERCHANT
  • MERCHANT_NOT_FOUND

502

Response4 fields

Bad Gateway

• messagestringoptional
• additional_contextobjectoptional
  1 field in additional_context

  • keystringoptional

    Any additional property. The key is free-form; the value has this shape.

• codestringoptional
  • CLIENT_NOT_FOUND
  • ORIGIN_NOT_ALLOWED
  • HTTP_CLIENT_ERROR
  • HTTP_SERVER_ERROR
  • DOMAIN_NOT_WHITELISTED
  • PLACEMENT_CONFIG_MISSING
  • ARGUMENT_NOT_VALID
  • CONSTRAINT_VIOLATION
  • PROFILE_DOESNT_BELONG_TO_MERCHANT
  • MERCHANT_NOT_FOUND

PATCH https://api.playground.kustom.co/elements/v1/clients/{clientId}/express

RequestBodyResponse200400401409502

Request body· application/json

{
  "push_url": "https://www.example.com/api/push",
  "validation_url": "https://www.example.com/api/validation",
  "confirmation_url": "https://www.example.com/confirmation.html",
  "payment_methods": [
    {
      "method": "AMAZON_PAY",
      "display_mode": "always",
      "provider": "STRIPE"
    }
  ]
}

12 linesCopy

Response 200· OK

{
  "id": "<string>",
  "merchant_id": "<string>",
  "allowed_origins": [
    "<uri>"
  ],
  "name": "<string>",
  "placements": [
    {
      "key": "AVAILABLE_PAYMENT_METHODS",
      "custom_styles": ".hero { background: #000; }",
      "content": [
        {
          "type": "PAYMENT_METHOD",
          "name": "STRIPE_PUBLIC_API_KEY",
          "value": "MASTERCARD_DEBIT",
          "imageUrl": "https://cdn.ingrid.com/static/shipping-logos/logo-postnord-round-30.svg"
        }
      ],
      "express_config": {
        "push_url": "https://www.example.com/api/push",
        "validation_url": "https://www.example.com/api/validation",
        "confirmation_url": "https://www.example.com/confirmation.html",
        "payment_methods": [
          {
            "method": "AMAZON_PAY",
            "display_mode": "always",
            "provider": "STRIPE"
          }
        ]
      }
    }
  ],
  "created_at": "<date-time>",
  "updated_at": "<date-time>"
}

36 linesCopy

Response 400· Bad Request

{
  "message": "<string>",
  "additional_context": {
    "key": "<string>"
  },
  "code": "CLIENT_NOT_FOUND"
}

7 linesCopy

Response 401· Unauthorized

{
  "message": "<string>",
  "additional_context": {
    "key": "<string>"
  },
  "code": "CLIENT_NOT_FOUND"
}

7 linesCopy

Response 409· Conflict

{
  "message": "<string>",
  "additional_context": {
    "key": "<string>"
  },
  "code": "CLIENT_NOT_FOUND"
}

7 linesCopy

Response 502· Bad Gateway

{
  "message": "<string>",
  "additional_context": {
    "key": "<string>"
  },
  "code": "CLIENT_NOT_FOUND"
}

7 linesCopy