BrainerceList payment status
Reports whether the payment of a checkout is pending, succeeded, failed or canceled. Poll it after a redirect payment: for redirect providers (for example PayPal) this poll also verifies and captures the approved payment. A checkout paid in full by gift card, and a sandbox checkout, report succeeded once completed.
For /api/vc/{connectionId}/* routes the connectionId (vc_*) is in the URL path — not a header. Live-mode requests must also send a matching Origin header.
In: header
Path Parameters
Sales channel ID (vc_*), the canonical salesChannelId. connectionId is the deprecated name of the same value and is still the literal path segment.
Checkout id, returned by checkout (create checkout).
Header Parameters
Origin of the storefront page making the call, for example https://shop.example.com. Required: a request with no Origin header is refused with 403. On a LIVE channel its host must equal the channel's registered domain (or one of its subdomains) or match an allowed origin. A TEST channel with no domain accepts any origin; once a domain is set it is matched as on LIVE.
Version of the calling SDK (the Brainerce SDK sends it automatically). Informational: it is recorded on the channel and never changes the response.
curl -X GET "https://api.brainerce.com/api/vc/string/checkout/string/payment-status" \ -H "origin: string" \ -H "X-SDK-Version: string"{
"checkoutId": "clchk_abc123",
"status": "succeeded",
"orderId": "clord_abc123",
"orderNumber": "ORD-20260907-0012",
"paymentIntentId": "clpaymentintent_abc123"
}{
"statusCode": 403,
"code": "INSUFFICIENT_SCOPE",
"message": "API key does not have the required scope: products:write",
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/vc/{connectionId}/checkout/{checkoutId}/payment-status"
}{
"statusCode": 404,
"code": "RESOURCE_NOT_FOUND",
"message": "Resource not found",
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/vc/{connectionId}/checkout/{checkoutId}/payment-status"
}{
"statusCode": 429,
"code": "RATE_LIMITED",
"message": "Too many requests",
"details": {
"retryAfterSeconds": 12
},
"timestamp": "2026-08-23T10:15:00.000Z",
"path": "/api/vc/{connectionId}/checkout/{checkoutId}/payment-status"
}Confirm SDK-based payment (Storefront, grow-confirm)
Tells the server that a client-side payment SDK finished successfully, with the callback data the SDK returned.
Get order details by checkout
Returns the buyer-safe order of a completed checkout (items, address, totals, the shopper note) for the confirmation page.