B2B API Specification

B2B Payment API

Design

To establish a cohesive user journey, developers utilize the Checkout Design endpoint to define the visual and structural identity of the hosted payment interface presented to customers upon redirection. This configuration acts as a brand-layer for merchant invoices, allowing for a seamless transition from the merchant's site to the payment gateway. By specifying branding elements and design preferences, integrators can ensure that the secure checkout environment remains consistent with their primary application's aesthetic.

Create checkout design

post /v3/checkout/design

Parameters

X-Integrator-Id

Type

string

Maximum Length

X-Permalinks

Type

string

Maximum Length

Request Schema

merchant_id required

Type

integer

Example

12345

checkout_style

Type

string

Enum

CHECKOUT_PAGE

company_logo

Type

string

Example

data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAADElEQVQImWNgYGAAAAAEAAGjChXjAAAAAElFTkSuQmCC;filename=filename.png

selected_color_theme required

Type

string

Example

#3498db

font

Type

string

Enum

system-uiArialArial BlackBaskervilleComorant GaramondFuturaGeorgiaGill SansHelvetica NeueLucida GrandePalatinoTrebuchetVerdana

Example

Arial

font_color required

Type

string

Example

#2c3e50

button_text_color required

Type

string

Example

#ffffff

input_field_style

Type

string

Enum

ROUNDED_CORNERSSHARP_CORNERS

Example

ROUNDED_CORNERS

Example Request

{
  "merchant_id": 12345,
  "checkout_style": "CHECKOUT_PAGE",
  "company_logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAADElEQVQImWNgYGAAAAAEAAGjChXjAAAAAElFTkSuQmCC;filename=filename.png",
  "selected_color_theme": "#3498db",
  "font": "Arial",
  "font_color": "#2c3e50",
  "button_text_color": "#ffffff",
  "input_field_style": "ROUNDED_CORNERS"
}

Example Response

201 Successful Response

422 Validation Error

Get checkout design

get /v3/checkout/design/{design_id}

Parameters

design_id required

Type

integer

merchant_id required

Type

integer

Example

246810

X-Integrator-Id

Type

string

Maximum Length

X-Permalinks

Type

string

Maximum Length

Example Response

200 Successful Response

422 Validation Error

Update checkout design

put /v3/checkout/design/{design_id}

Parameters

design_id required

Type

integer

X-Integrator-Id

Type

string

Maximum Length

X-Permalinks

Type

string

Maximum Length

Request Schema

merchant_id required

Type

integer

Example

12345

checkout_style

Type

string

Enum

CHECKOUT_PAGE

company_logo

Type

string

Example

data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAADElEQVQImWNgYGAAAAAEAAGjChXjAAAAAElFTkSuQmCC;filename=filename.png

selected_color_theme

Type

string

Example

#3498db

font

Type

string

Enum

system-uiArialArial BlackBaskervilleComorant GaramondFuturaGeorgiaGill SansHelvetica NeueLucida GrandePalatinoTrebuchetVerdana

Example

Arial

font_color

Type

string

Example

#2c3e50

button_text_color

Type

string

Example

#ffffff

input_field_style

Type

string

Enum

ROUNDED_CORNERSSHARP_CORNERS

Example

ROUNDED_CORNERS

Example Request

{
  "merchant_id": 12345,
  "checkout_style": "CHECKOUT_PAGE",
  "company_logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAADElEQVQImWNgYGAAAAAEAAGjChXjAAAAAElFTkSuQmCC;filename=filename.png",
  "selected_color_theme": "#3498db",
  "font": "Arial",
  "font_color": "#2c3e50",
  "button_text_color": "#ffffff",
  "input_field_style": "ROUNDED_CORNERS"
}

Example Response

200 Successful Response

422 Validation Error

Delete checkout design

delete /v3/checkout/design/{design_id}

Parameters

design_id required

Type

integer

merchant_id required

Type

integer

Example

246810

X-Integrator-Id

Type

string

Maximum Length

X-Permalinks

Type

string

Maximum Length

Example Response

200 Successful Response

422 Validation Error

Design

Create checkout design

Get checkout design

Update checkout design

Delete checkout design

Contact Us