BUILD WITH BEXO / API REFERENCE

API data models

Read the selected schema fields, nullability and constraints used by the downloadable OpenAPI contract.

Reference edition 2026-10-19 • Selected public contract

schemasdata modelsJSONOpenAPI

Conventions across models

Identifiers are opaque strings; most entity references use UUIDs. Validate the operation-specific field instead of inferring authority from the ID.
Money in *Paise fields is integer INR minor units. Never convert a formatted currency string back into an authoritative amount.
Date-time fields use ISO strings when present. Some fields can be null or absent.
The reference describes a selected set of response fields. Clients should tolerate additional fields and avoid exposing whole private objects.
Synthetic examples and placeholders are not production customer data or usable credentials.

Problem

Field	Type	Details
`type`	string	Problem type; normally about:blank.
`title`	string	Human-readable summary.
`detail`	string	Client-safe recovery detail.
`status`Required	integer	HTTP status.
`code`Required	string	Machine-readable error code.
`requestId`	string	Correlation ID, when available.
`error`	string	Legacy error message.

Vendor

Field	Type	Details
`id`Required	string	Vendor identifier.
`displayName`	string	Customer-facing name.
`legalName`	string	Private registered name.
`status`Required	string	Review state. `sandbox_only · entity_verified · control_verified · risk_reviewed · production_active · suspended`
`publicUrl`	string · nullable	Public storefront URL, if configured.

Application

Field	Type	Details
`legalName`Required	string	Registered legal name.
`displayName`Required	string	Customer-facing name.
`contactEmail`Required	string	Business email.
`supportEmail`Required	string	Customer support email.
`contactPhone`	string	Business phone; optional.
`businessCategory`	string	Business category. `fitness · gym · coworking · education · retail · entertainment · healthcare · laundry · other`
`registeredAddress`Required	string	Business address.
`authorizedRepresentative`Required	string	Authorized representative name.
`serviceDescription`	string	Description of the service.
`pan`Required	string	Valid Indian PAN. Supply actual business details privately.
`gstExempt`	boolean	Whether the business declares a GST exemption.
`gstin`	string	Required when gstExempt is false.
`pincode`	string	Six-digit PIN code, when supplied.
`city`	string	City.
`state`	string	State.
`websiteUrl`	string	Website URL.
`refundPolicyUrl`	string	Public refund policy URL.
`termsAccepted`	boolean	Acceptance of the application terms.

PlanInput

Field	Type	Details
`name`Required	string	Plan name.
`durationDays`	integer	Positive duration. Checkout snapshots support 1–366 days.
`pricePaise`Required	integer	Amount in integer INR paise; 100 paise equals INR 1.
`billingPeriod`	string	Plan billing mode. A monthly value does not by itself prove recurring payments are enabled. `one_time · monthly`
`gstPercent`	number	Tax percentage recorded for the plan; default in this reference is 18.
`taxInclusive`	boolean	Whether the stated amount includes tax; defaults true.
`externalRef`	string	Optional reference in your ERP.

Plan

Field	Type	Details
`id`	string	Plan ID.
`tenantId`	string	Owning vendor ID.
`name`	string	Plan name.
`durationDays`	integer	Membership duration.
`pricePaise`	integer	Amount in integer INR paise; 100 paise equals INR 1.
`currency`	string	Currency; INR in the documented checkout.
`billingPeriod`	string	one_time or monthly.
`isActive`	boolean	Whether this plan is currently published.
`checkoutUrl`	string	Hosted checkout link, subject to vendor and plan availability.

PlanUpdate

Field	Type	Details
`name`	string	Replacement name.
`durationDays`	integer	Positive duration.
`pricePaise`	integer	Amount in integer INR paise; 100 paise equals INR 1.
`gstPercent`	number	See the downloadable schema for nested fields.
`taxInclusive`	boolean	Whether tax is included.
`isActive`	boolean	Publishing requires production_active vendor approval.

Membership

Field	Type	Details
`id`	string	Membership ID.
`planId`	string	Plan ID.
`planName`	string	Plan display name.
`status`	string	Membership state.
`validFrom`	string · nullable	Validity start.
`validUntil`	string · nullable	Validity end.
`amountPaise`	integer · nullable	Purchase amount in paise.
`createdAt`	string · nullable	Creation time.

TerminalInput

Field	Type	Details
`label`	string	Device label, e.g. Reception.
`serialNumber`	string	Optional custom serial. If omitted, the service generates one.
`hardwareModel`	string	Hardware model.
`firmwareVersion`	string	Firmware version.

Terminal

Field	Type	Details
`id`	string	Terminal ID.
`label`	string	Device name.
`serialNumber`	string	Registered terminal serial; an identifier, not a secret.
`status`	string	Device state.
`isRevoked`	boolean	Revocation flag.
`hardwareModel`	string	Model.
`lastSeen`	string · nullable	Last check-in.
`totalRequests`	integer	Recorded requests.

TerminalUpdate

Field	Type	Details
`label`	string	Device label.
`status`	string	Requested state. `active · offline · suspended · revoked`
`hardwareModel`	string	Device model.

CheckoutLinkInput

Field	Type	Details
`tenantPlanId`Required	string	An active plan belonging to the vendor.

CheckoutLink

Field	Type	Details
`linkId`	string	Link reference. The owner route may return the plan ID in this field; treat it as opaque.
`token`	string	Hosted checkout token. Do not log it.
`url`	string	Hosted checkout URL.
`expiresAt`	string	Server-returned availability hint. Plan and vendor checks still apply.

CheckoutInput

Field	Type	Details
`checkoutToken`Required	string	Token from a supported hosted checkout link.
`acceptedTerms`Required	boolean	Must be true for a new purchase. `true`
`acceptedTermsVersion`Required	string	Use the version returned by checkout-link retrieval.
`couponCode`	string	Optional coupon code.

Purchase

Field	Type	Details
`membershipId`	string	Original membership/purchase reference.
`orderId`	string · nullable	Provider order reference.
`subscriptionId`	string · nullable	Provider subscription reference, where enabled.
`keyId`	string	Public provider checkout key, not the provider secret.
`amountPaise`	integer	Amount in integer INR paise; 100 paise equals INR 1.
`currency`	string	INR.
`durationDays`	integer	Snapshotted duration.
`planName`	string	Snapshotted name.
`billingPeriod`	string	Server-returned billing mode.
`status`	string	Current purchase state.
`pendingExpiresAt`	string · nullable	Pending-purchase expiry, returned by resume.

PaymentProof

Field	Type	Details
`razorpay_payment_id`Required	string	Provider payment ID.
`razorpay_order_id`	string	Original provider order, for an order payment.
`razorpay_subscription_id`	string	Original subscription, for a subscription payment.
`razorpay_signature`Required	string	Provider signature from the supported checkout callback.

TapInput

Field	Type	Details
`cardUid`	string	Raw card read, if using a registered NFC reader. Keep private.
`qrPayload`	string	Alternative QR payload. At least one of cardUid or qrPayload is required.
`timestamp`	string	Optional ISO time reported by the terminal. Server time controls entitlement.

Subscriber

Field	Type	Details
`memberId`	string	Member reference.
`name`	string · nullable	Display name, when supplied.
`photoUrl`	string · nullable	Photo URL, when supplied.
`membershipStatus`	string	Membership state.
`planName`	string	Plan name.
`tenantPlanId`	string · nullable	Plan reference.
`expiryDate`	string · nullable	Expiry when supplied.
`validUntil`	string · nullable	Validity when supplied.

TapResult

Field	Type	Details
`verified`Required	boolean	Access outcome; use alongside decision.
`decision`Required	string	Operational outcome. `allow · deny`
`decisionReason`Required	string	Reason such as active, expired, no_membership_for_vendor or member_not_found.
`status`	string	Membership/lookup status.
`subscriber`	object · nullable	See the downloadable schema for nested fields.
`terminal`	object · nullable	See the downloadable schema for nested fields.
`billing`	object	See the downloadable schema for nested fields.
`latencyMs`	integer	Server evaluation time.
`timestamp`	string	Server evaluation time.
`logId`	string · nullable	Log reference.

ConsentInput

Field	Type	Details
`granted`Required	boolean	true grants the listed fields; false revokes access.
`purpose`Required	string	Supported consent purpose. `membership_verification`
`fields`Required	array	Request only the fields needed for the stated purpose.

KeyMetadata

Field	Type	Details
`id`	string	Credential metadata ID.
`keyPrefix`	string	Display-safe prefix; never the full credential.
`label`	string	Credential label.
`scopes`	array	See the downloadable schema for nested fields.
`environment`	string	live or sandbox.
`revokedAt`	string · nullable	Revocation timestamp.
`lastUsedAt`	string · nullable	Last recorded use.

SandboxTenantInput

Field	Type	Details
`legalName`Required	string	Synthetic organization name for an isolated sandbox.
`displayName`Required	string	Sandbox display name.
`contactEmail`Required	string	Controlled test email.

SandboxPlanInput

Field	Type	Details
`name`Required	string	Plan name.
`durationDays`Required	integer	Duration, 1–366 days.
`pricePaise`Required	integer	Amount in integer INR paise; 100 paise equals INR 1.
`gracePeriodDays`	integer	Nonnegative grace period.
`externalRef`	string	Optional external reference.

SandboxVerifyInput

Field	Type	Details
`userId`	string	Test member ID; or supply a valid cardToken.
`cardToken`	string	Alternative supported test card token.
`terminalId`	string	Optional nonrevoked terminal belonging to this tenant.
`tenantPlanId`	string	Optional plan filter.