v1

latestOpenAPI 3.0.1Apache 2.02026-07-2647148658.0 KB
Theming

List Themes

get/v2/theme

Query parameters

searchstring

RSQL is a REST query language that allows you to filter resources based on their attributes. The RSQL query is a string that represents a query in a human-readable format. The RSQL query is passed as a query parameter in the URL and is used to filter the resources based on the attributes of the resource. See RSQL queries for Checkout API for example filters to use with the Checkout API. See ![RSQL](RSQl https://aboullaite.me/rsql/) for more information on RSQL queries.

order_criteria'name' | 'created_at' | 'updated_at'
order_by'ASC' | 'DESC'

The ordering sequence of the selected customers If not selected then Descending order is the default order.

page_numbernumber

A filter query in RSQL format to retrieve customers based on page number. If not selected then a default pageNumber is 1.

page_sizenumber

A filter query in RSQL format to retrieve customers based on page size. If not selected then a default pageSize is 50

populate_customer_detailsboolean

A query param to allow customer details to be populated for the customer id attached to checkout.

Response

Successful

namestring required
logostring

Uploaded image Id

entity_idstring

Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)

base_font_family'Roboto' | 'Open Sans' | 'Lato' | 'Slabo' | 'Oswald' | 'Source Sans Pro' | 'Montserrat' | 'Raleway' | 'PT Sans' | 'Lora' | 'Noto Sans' | 'Noto Serif' | 'Nunito Sans' | 'Concert One' | 'Prompt' | 'Work Sans'

base fonts available for theme

text_colorstring

6 digit hex code, e.g. <code>ffe0e0</code>

heading_colorstring

6 digit hex code, e.g. <code>ffe0e0</code>

background_colorstring

6 digit hex code, e.g. <code>ffe0e0</code>

panel_background_colorstring

6 digit hex code, e.g. <code>ffe0e0</code>

primary_colorstring

6 digit hex code, e.g. <code>ffe0e0</code>

primary_color_inversestring

6 digit hex code, e.g. <code>ffe0e0</code>

primary_color_disabledstring

6 digit hex code, e.g. <code>ffe0e0</code>

primary_color_inverse_disabledstring

6 digit hex code, e.g. <code>ffe0e0</code>

error_colorstring

6 digit hex code, e.g. <code>ffe0e0</code>

error_color_inversestring

6 digit hex code, e.g. <code>ffe0e0</code>

input_border_radiusnumber
input_border_widthnumber
hide_verifone_sealboolean

Show/Hide verifone seal on the checkout page

idstring
created_atstring date
updated_atstring date