Skip to content

Get checkout theme

/checkout/theme

Target audience: Developers

Get checkout theme

Introduction

This endpoint returns the configured checkout theme for an organisation, including HTML receipt templates and CSS styling.

This theme configuration is separate, and should not be confused with the Theme ID available when fetching a marketplace.

URI

Environment URI
Stage https://payway-api.stage.adeprimo.se/external/api/v6/marketing/checkout/theme
Production https://backend.worldoftulo.com/external/api/v6/marketing/checkout/theme

Requirements

Identity Scope
No /external/marketing/r

Parameters

This endpoint does not require any parameters.

Curl Example

curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v6/marketing/checkout/theme \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <access_token>'

Response

HTTP 200 OK
{
  "item": {
    "checkout_receipt": "<!DOCTYPE html>\n<html>\n<head>\n  <title>Receipt</title>\n</head>\n<body>\n  <h1>Thank you for your purchase!</h1>\n</body>\n</html>",
    "css_template": "body {\n  background-color: #ffffff;\n  font-family: Arial, sans-serif;\n}"
  }
}
HTTP 204 No Content
[]

Errors

This API uses the common error conventions of the Payway API

See common error responses