RANTANDocs
Open RANTAN
Resources

API Reference

Checkout and webhook endpoints, authentication, responses, and status codes.

Hosted Checkout uses the production base URL below. Send and receive JSON unless an endpoint says otherwise.

#Base URL

Production
https://app.rantan.xyz/api/v2

#Authentication

Session creation, detail, cancellation, and all webhook management APIs require the product owner’s seller JWT. Public Checkout data is session-scoped. Verification requires either the owner JWT or the session verification key.

CredentialHeaderUse
Seller JWTAuthorization: Bearer {token}Create, detail, cancel, webhook management, or owner verification
Verification keyX-Rantan-Checkout-Verification-Key: {key}Merchant backend fulfillment verification

#Checkout and webhook endpoints

POST/api/v2/checkout-sessions/

Create a server-bound Checkout Session.

GET/api/v2/checkout-sessions/{sessionId}/checkout/

Read public product and session data used by hosted Checkout.

GET/api/v2/checkout-sessions/{sessionId}/

Read a session as the authenticated product owner.

DELETE/api/v2/checkout-sessions/{sessionId}/

Cancel an open session as the product owner.

GET/api/v2/checkout-sessions/{sessionId}/verify/

Verify fulfillment with the seller JWT or verification key.

POST/api/v2/webhooks/endpoints/

Create a webhook endpoint and receive the signing secret once.

GET/api/v2/webhooks/endpoints/

List webhook endpoints owned by the seller.

GET/api/v2/webhooks/endpoints/{endpointId}/

Read one webhook endpoint configuration.

PATCH/api/v2/webhooks/endpoints/{endpointId}/

Update a webhook endpoint configuration.

DELETE/api/v2/webhooks/endpoints/{endpointId}/

Disable a webhook endpoint.

POST/api/v2/webhooks/endpoints/{endpointId}/rotate-secret/

Rotate the signing secret and receive the replacement once.

GET/api/v2/webhooks/deliveries/

List up to 100 recent webhook deliveries.

POST/api/v2/webhooks/deliveries/{deliveryId}/retry/

Replay a delivery with the same event id.

#HTTP status codes

StatusMeaning
200Existing idempotent session, successful read, verification, or cancellation.
201A new Checkout Session was created.
400Request fields or product-specific options are invalid.
401Seller authentication is missing or invalid.
403The verification key or authenticated owner does not match the session.
404The product or Checkout Session does not exist for this caller.
409Order reference conflict, unsupported product state, or processing already started.
410The Checkout Session was canceled or expired before a purchase started.

#Responses are not cacheable