> ## Documentation Index > Fetch the complete documentation index at: https://docs.unibee.dev/llms.txt > Use this file to discover all available pages before exploring further. # New Checkout Session > New session for hosted checkout or client portal. You can create user and get ClientSession from here, then append it to the checkout link (copied from Admin Portal Plan) as a query parameter, e.g. https://cs.unibee.dev/hosted/checkout?planId=253&env=prod&session=${clientSession} ## Endpoint Overview **POST** `https://api.unibee.dev/merchant/session/new_session` New session for hosted checkout or client portal. You can create user and get ClientSession from here, then append it to the checkout link (copied from Admin Portal Plan) as a query parameter, e.g. [https://cs.unibee.dev/hosted/checkout?planId=253\&env=prod\&session=\$\{clientSession}](https://cs.unibee.dev/hosted/checkout?planId=253\&env=prod\&session=\$\{clientSession}) *** ## Authorization All UniBee Merchant API requests require authentication via API key. | Header | Required | Description | | --------------- | -------- | ------------------------------------- | | `Authorization` | Yes | Bearer `` | | `Content-Type` | Yes | `application/json` (for request body) | *** ## Parameters Parameters for this endpoint are listed below. The schema is also shown in the Try it panel. ### Request body | Name | Type | Required | Description | | ---------------- | ------ | -------- | -------------------------------------------------- | | `address` | string | No | Address | | `cancelUrl` | string | No | CancelUrl, back to cancelUrl if checkout cancelled | | `email` | string | Yes | Email | | `externalUserId` | string | No | ExternalUserId | | `firstName` | string | No | First Name | | `lastName` | string | No | Last Name | | `password` | string | No | Password | | `phone` | string | No | Phone | | `returnUrl` | string | No | ReturnUrl, back to returnUrl if checkout completed | *** ## Request examples ### cURL ```bash theme={null} curl -X POST "https://api.unibee.dev/merchant/session/new_session" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "address": "", "cancelUrl": "https://example.com", "email": "user@example.com", "externalUserId": "id_example", "firstName": "", "lastName": "", "password": "", "phone": "", "returnUrl": "https://example.com" }' ``` ### Sandbox ```bash theme={null} curl -X POST "https://api-sandbox.unibee.top/merchant/session/new_session" \ -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "address": "", "cancelUrl": "https://example.com", "email": "user@example.com", "externalUserId": "id_example", "firstName": "", "lastName": "", "password": "", "phone": "", "returnUrl": "https://example.com" }' ``` *** ## Response Success responses return a JSON envelope with `code`, `data`, `message`, `redirect`, and `requestId`. `code` `0` indicates success. | Field | Type | Description | | --------------------- | ------- | ---------------------------- | | `code` | integer | Response code. `0` = success | | `data` | object | Response payload | | `data.clientSession` | string | ClientSession | | `data.clientToken` | string | ClientToken | | `data.email` | string | Email | | `data.externalUserId` | string | ExternalUserId | | `data.url` | string | Url | | `data.userId` | string | UserId | | `message` | string | Human-readable message | | `requestId` | string | Request ID for support | *** ## Error handling | HTTP status | Meaning | | ----------- | ------------------------------------------------------------------------- | | 400 | Bad request — invalid or missing parameters. Check `message` in the body. | | 401 | Unauthorized — missing or invalid API key. | | 404 | Not found — invalid path or resource. | | 500 | Server error — retry with backoff. | When `code` in the response body is non-zero, check `message` for details. Use `requestId` when contacting support. ## OpenAPI ````yaml post /merchant/session/new_session openapi: 3.0.0 info: description: UniBee Api Server license: name: Apache-2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: OpenAPI UniBee version: daily,buildtime:202603161017 servers: - url: https://api.unibee.dev - url: https://api-sandbox.unibee.top security: - Authorization: [] paths: /merchant/session/new_session: post: tags: - Session summary: New Checkout Session description: >- New session for hosted checkout or client portal. You can create user and get ClientSession from here, then append it to the checkout link (copied from Admin Portal Plan) as a query parameter, e.g. https://cs.unibee.dev/hosted/checkout?planId=253&env=prod&session=${clientSession} requestBody: content: application/json: schema: $ref: '#/components/schemas/unibee.api.merchant.session.NewReq' required: true responses: '200': content: application/json: schema: properties: code: format: int properties: {} type: integer data: properties: clientSession: description: ClientSession format: string properties: {} type: string clientToken: description: ClientToken format: string properties: {} type: string email: description: Email format: string properties: {} type: string externalUserId: description: ExternalUserId format: string properties: {} type: string url: description: Url format: string properties: {} type: string userId: description: UserId format: string properties: {} type: string type: object merchantId: format: int64 properties: {} type: integer message: format: string properties: {} type: string redirect: format: string properties: {} type: string requestId: format: string properties: {} type: string type: object description: '' components: schemas: unibee.api.merchant.session.NewReq: description: >- New session for hosted checkout or client portal. You can create user and get ClientSession from here, then append it to the checkout link (copied from Admin Portal Plan) as a query parameter, e.g. https://cs.unibee.dev/hosted/checkout?planId=253&env=prod&session=${clientSession} properties: address: description: Address format: string properties: {} type: string cancelUrl: description: CancelUrl, back to cancelUrl if checkout cancelled format: string properties: {} type: string email: description: Email format: string properties: {} type: string externalUserId: description: ExternalUserId format: string properties: {} type: string firstName: description: First Name format: string properties: {} type: string lastName: description: Last Name format: string properties: {} type: string password: description: Password format: string properties: {} type: string phone: description: Phone format: string properties: {} type: string returnUrl: description: ReturnUrl, back to returnUrl if checkout completed format: string properties: {} type: string required: - email type: object securitySchemes: Authorization: bearerFormat: JWT scheme: bearer type: http ````