Skip to main content

Request

The payload example for a session creation request with all required fields for a direct API custom integration. Fields marked // required are mandatory for the full checkout session — the background pre-scoring call accepts a minimal subset. The // comments are annotations, not part of the payload — strip them before sending.

Response

A successful session creation returns 200 OK with this structure (the payment object echoes your request payload back, trimmed here for brevity):
What to read from it:
  • statuscreated means the customer can pay; rejected means hide Tabby or show the rejection message.
  • payment.id — save it; all later calls (verify, capture, refund) address the payment by this id.
  • configuration.available_products.installments[0].web_url — the Hosted Payment Page link to redirect the customer to. installments is an array: take the first element. Always validate web_url is present before redirecting.
  • On rejection (status: "rejected"), the reason is in configuration.products.installments.rejection_reason (null in created responses), and configuration.available_products comes back empty — no web_url to redirect to.