Read hosted buyer checkout status

GET/api/v1/buyer-checkouts/{id}/status

Authorization

AuthorizationBearer token (opaque checkout status capability) · headerrequired

Path parameters

idstringrequired

Responses

200Current hosted checkout status and terminal order identifier

One of:

object

statusstringrequired

Allowed:pending

object

orderIdstringrequired

min length 1

statusstringrequired

Allowed:completed

object

statusstringrequired

Allowed:canceled

object

statusstringrequired

Allowed:expired

Request

curl -X GET "https://dev.api.orderboost.org/api/v1/buyer-checkouts/string/status" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://dev.api.orderboost.org/api/v1/buyer-checkouts/string/status", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://dev.api.orderboost.org/api/v1/buyer-checkouts/string/status",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "status": "pending"
}