Get non-enumerating public checkout status

POST/v2/public/checkouts/status

Header parameters

x-request-idstring

Optional caller-provided request correlation ID.

min length 1

Request body

requiredapplication/json

capabilitystringrequired

min length 32 · max length 512

providerPaymentIdstring<uuid>

Responses

200OK

statusobjectrequired

Show properties

statestringrequired

Allowed:ready_for_checkouthosted_checkout_opencompletedfailedexpiredrecoverable

hostedUrlstring<uri> | anyrequired

Show properties

Any of:

string<uri>

string<uri>

any

any

expiresAtstring<date-time>required

nextActionstringrequired

Allowed:open_hosted_checkoutwaitdoneretrycontact_merchant

checkoutDesignobject | anyrequired

Show properties

Any of:

object

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

any

any

orderIdstring<uuid>

productIdstring<uuid>

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 POST "https://api.cipay.net/v2/public/checkouts/status" \
  -H "Content-Type: application/json" \
  -d '{
  "capability": "string",
  "providerPaymentId": "<uuid>"
}'

const response = await fetch("https://api.cipay.net/v2/public/checkouts/status", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "capability": "string",
  "providerPaymentId": "<uuid>"
})
});

Response

{
  "status": {
    "state": "ready_for_checkout",
    "hostedUrl": "<uri>",
    "expiresAt": "2024-01-01T00:00:00Z",
    "nextAction": "open_hosted_checkout",
    "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"
        }
      }
    },
    "orderId": "<uuid>",
    "productId": "<uuid>"
  }
}