Skip to main content

API Overview

FCC Cart & Checkout exposes RESTful APIs over HTTPS. All endpoints follow consistent conventions for headers, authentication, and response structure.

Base URL​

https://virtserver.swaggerhub.com/fcc-fab/Transact/1.0.0

Standard request headers​

All API calls require these headers:

HeaderTypeDescription
X-Request-IdstringUnique request identifier for tracing. Use a UUID per request.
X-Tenant-IdstringYour tenant / client identifier. Provided during onboarding.
X-ChannelstringSales channel: WEB, MOBILE, POS, ANDROID, IOS
X-Timestampinteger (int64)Request timestamp in epoch milliseconds.
AuthorisationstringBearer token: Bearer <token>

Endpoint summary​

Cart endpoints​

MethodPathDescription
POST/v1/cartCreate Cart
PUT/v1/cart/{id}Update Cart Context
GET/v1/cart/{id}Get Cart
POST/v1/cart/{id}/itemsAdd Items
PATCH/v1/cart/{id}/itemsUpdate Items
DELETE/v1/cart/{id}/itemsDelete Items

Checkout endpoints​

MethodPathDescription
POST/v1/checkoutInitiate Checkout
PATCH/v1/checkout/{checkoutId}/itemsUpdate Items in Checkout
DELETE/v1/checkout/{checkoutId}/itemsDelete Items from Checkout
POST/v1/checkout/{checkoutId}/paymentsInitiate Payment
POST/v1/checkout/{checkoutId}/orderCreate Order
GET/v1/checkout/{checkoutId}Get Checkout

Response codes​

CodeMeaning
200OK — request succeeded
201Created — resource successfully created
400Bad Request — invalid input
401Unauthorised — invalid or missing auth token
403Forbidden — valid token, insufficient permissions
500Internal Server Error

OpenAPI spec​

The full OpenAPI 3.0 specification is available as a YAML file: 📄 sampleTransactOpenAPI.yaml