Get a published public checkout form

GET/v2/public/checkout-forms/{id}

Path parameters

idstring<uuid>required

Query parameters

locatorstringrequired

min length 1 · max length 160

langstring

Allowed:enar

expectedMerchantIdstring<uuid>

expectedHostRevisioninteger

min -9007199254740991 · max 9007199254740991

Header parameters

x-request-idstring

Optional caller-provided request correlation ID.

min length 1

Responses

200OK

checkoutFormobject | anyrequired

Show properties

Any of:

object

idstring<uuid>required

localestringrequired

Allowed:enar

modestringrequired

Allowed:fixed_planmulti_plan

requiredBuyerFieldsstring[]required

acceptsDiscountCodebooleanrequired

recurringConsentVersionstring | anyrequired

Show properties

Any of:

string

string

any

any

checkoutDesignobjectrequired

Show properties

logoAssetIdstring<uuid> | any

Show properties

Any of:

string<uuid>

string<uuid>

any

any

accentColorany

backgroundColorany

textColorany

fontstringrequired

Allowed:systemarabic_sansserif

layoutstring

Allowed:two_columnstacked

productOrderstring<uuid>[]

max items 100

acceptsDiscountCodeboolean

default: false

copyobjectrequired

Show properties

headingobjectrequired

Show properties

enstringrequired

min length 1 · max length 120

arstringrequired

min length 1 · max length 120

subheadingobjectrequired

Show properties

enstringrequired

min length 1 · max length 120

arstringrequired

min length 1 · max length 120

submitLabelobjectrequired

Show properties

enstringrequired

min length 1 · max length 120

arstringrequired

min length 1 · max length 120

offersobject[]required

min items 1 · max items 50

Show properties

Array of object

idstring<uuid>required

namestringrequired

min length 1 · max length 160

descriptionstring | anyrequired

Show properties

Any of:

string

string

any

any

offerTypestringrequired

Allowed:one_timerecurringfreecustom

positionintegerrequired

min 0 · max 9007199254740991

isDefaultbooleanrequired

currencyanyrequired

amountHalalasinteger | anyrequired

Show properties

Any of:

integer

integer

any

any

minimumAmountHalalasinteger | anyrequired

Show properties

Any of:

integer

integer

any

any

maximumAmountHalalasinteger | anyrequired

Show properties

Any of:

integer

integer

any

any

cadenceobject | anyrequired

Show properties

Any of:

object

intervalUnitstringrequired

Allowed:dayweekmonthyear

intervalCountintegerrequired

min -9007199254740991 · max 9007199254740991

any

any

trialDaysintegerrequired

min 0 · max 365

any

any

404Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

422Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

429Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

500Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

Request

curl -X GET "https://api.cipay.net/v2/public/checkout-forms/%3Cuuid%3E?locator=string"

const response = await fetch("https://api.cipay.net/v2/public/checkout-forms/%3Cuuid%3E?locator=string", {
  method: "GET"
});

Response

{
  "checkoutForm": {
    "id": "<uuid>",
    "locale": "en",
    "mode": "fixed_plan",
    "requiredBuyerFields": [
      "name"
    ],
    "acceptsDiscountCode": true,
    "recurringConsentVersion": "string",
    "checkoutDesign": {
      "logoAssetId": "<uuid>",
      "accentColor": "string",
      "backgroundColor": "string",
      "textColor": "string",
      "font": "system",
      "layout": "two_column",
      "productOrder": [
        "<uuid>"
      ],
      "acceptsDiscountCode": false,
      "copy": {
        "heading": {
          "en": "string",
          "ar": "string"
        },
        "subheading": {
          "en": "string",
          "ar": "string"
        },
        "submitLabel": {
          "en": "string",
          "ar": "string"
        }
      }
    },
    "offers": [
      {
        "id": "<uuid>",
        "name": "string",
        "description": "string",
        "offerType": "one_time",
        "position": 0,
        "isDefault": true,
        "currency": "SAR",
        "amountHalalas": 0,
        "minimumAmountHalalas": 0,
        "maximumAmountHalalas": 0,
        "cadence": {
          "intervalUnit": "day",
          "intervalCount": 0
        },
        "trialDays": 0
      }
    ]
  }
}