Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
Layout

Layout:Info

Get all information regarding a specific layout. You need to have access to the merchant to retrieve the layout

get/v2/layouts/{layoutCode}/info

Path parameters

layoutCodestring required

The code of the layout you want to retrieve

Response

OK

codestring

The LY-code for a layout.

status'NOT_CHECKED' | 'APPROVED' | 'DECLINED' | 'RECHECK'

The status of the layout

declineReasonstring nullable

The reason why the layout has been declined

namestring

The name for the layout

cssUrlstring

The url to the css file

supportingColorstring nullable

The supporting color

headerTextColorstring nullable

The color of the text within the header

buttonColorstring nullable

The color of the button

buttonTextColorstring nullable

The color of the text within the button

brandTagobject nullable
createdAtstring date-time nullable

The date and time at which this entity was created in ISO-8601 (ATOM) notation

createdBystring nullable

The reference to an account or token whom created the entity

modifiedAtstring date-time nullable

The date and time at which this entity was modified in ISO-8601 (ATOM) notation.

modifiedBystring nullable

The reference to an account or token whom modified this entity

deletedAtstring date-time nullable

The date and time at which this entity was deleted in ISO-8601 (ATOM) notation.

deletedBystring nullable

The reference to an account or token whom deleted the entity

Example response

{
  "code": "LY-1234-4321",
  "status": "APPROVED",
  "name": "My branding",
  "cssUrl": "https://static.pay.nl/layout/LY-1234-4321/cssfile.css",
  "background": {
    "code": "F-1234-4321",
    "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA"
  },
  "logo": {
    "code": "F-1234-4321",
    "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA"
  },
  "icon": {
    "code": "F-1234-4321",
    "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA"
  },
  "supportingColor": "56EADD",
  "headerTextColor": "56EADD",
  "buttonColor": "56EADD",
  "buttonTextColor": "56EADD",
  "terminalLandscape": {
    "code": "F-1234-4321",
    "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA"
  },
  "terminalPortrait": {
    "code": "F-1234-4321",
    "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA"
  },
  "cashregisterLandscape": {
    "code": "F-1234-4321",
    "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA"
  },
  "cashregisterPortrait": {
    "code": "F-1234-4321",
    "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA"
  },
  "brandTag": {
    "text": "Selling Goods",
    "translations": {
      "nl_NL": "Goederen verkopen",
      "en_GB": "Selling Goods"
    }
  },
  "createdAt": "2024-06-04T08:15:00+01:00",
  "createdBy": "A-1234-4321",
  "modifiedAt": "2024-06-04T08:15:00+01:00",
  "modifiedBy": "A-1234-4321",
  "deletedAt": "A-1234-4321",
  "deletedBy": "A-1234-4321"
}