> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scripxhq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Prepare a cross

> Prepare a block deal or intra-group transfer on the ScripX cross desk: a created cross never settles by itself, funding and release are separate explicit steps.

<Note>
  Cross desk endpoints require the cross desk to be active on your key. Write to [amin@eximfiles.io](mailto:amin@eximfiles.io) to have it enabled.
</Note>

Books a deal between two firms on your desk, your exporter selling, your importer buying, at **prices you set on both sides**. Works equally for a brokered external block and an internal transfer between your own entities (`intra_group`, e.g. straight from a [netting plan](/api-reference/group/net-plan)). Requires the `orders:write` scope. Returns `201` with the prepared deal.

**A prepared cross never settles by itself.** Money moves only at [settle](/api-reference/cross/settle), and the trade completes only at [confirm](/api-reference/cross/confirm). Each step is a separate, deliberate call.

### Request example

```bash theme={"dark"}
curl -X POST "https://api.scripxhq.com/v1/cross" \
  -H "X-ScripX-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"seller_iec": "0512345678", "buyer_iec": "0499887766", "scheme": "RODTEP",
       "amount_paise": 500000000, "buy_price_bps": 9700, "sell_price_bps": 9640,
       "rfq": true, "note": "July block, as agreed"}'
```

With `rfq: true` the counterparty must accept the terms before the cross can be funded; without it the deal is ready for [settle](/api-reference/cross/settle) immediately.

### Response example

```json theme={"dark"}
{
  "deal": {
    "cross_id": "crs_01HZY…",
    "status": "prepared",
    "scheme": "RODTEP",
    "amount_paise": 500000000,
    "buy_price_bps": 9700,
    "sell_price_bps": 9640
  }
}
```

### Errors

* `422 unprocessable`, missing parties or inconsistent prices.

**Terms used here:** [scheme](/annexure/terminology#scheme), [paise](/annexure/terminology#paise), [bps](/annexure/terminology#basis-point), [cross](/annexure/terminology#cross-block-deal), [RFQ](/annexure/terminology#rfq), [group netting](/annexure/terminology#group-netting), [API key](/annexure/terminology#api-key), [scope](/annexure/terminology#scope). Full list in the [terminology annexure](/annexure/terminology).

### Next steps

* [Settle](/api-reference/cross/settle) to fund, then [confirm](/api-reference/cross/confirm) to release.


## OpenAPI

````yaml POST /v1/cross
openapi: 3.1.0
info:
  title: ScripX Partner API
  version: 1.2.0
  description: >-
    Automate duty-credit-scrip trading: quote, order, positions, market,
    webhooks. Auth: `X-ScripX-Key: scripx_live_…`. Money = integer paise; price
    = bps of face.
  contact:
    name: ScripX API Support
    email: amin@eximfiles.io
    url: https://scripxhq.com
servers:
  - url: https://api.scripxhq.com
    description: >-
      Production and sandbox share one host; a scripx_test_ key selects the
      sandbox.
security:
  - ApiKeyAuth: []
tags:
  - name: Firms
    description: >-
      client-firm lifecycle: register, verify, authorize, credits, update,
      offboard
  - name: Trading
    description: quote, orders, positions, market
  - name: Group
    description: intra-group netting + positions (enterprise/broker)
  - name: Cross
    description: 'broker cross-desk: block deals + intra-group transfers'
  - name: Webhooks
    description: event subscriptions + delivery
  - name: Account
    description: usage + metering
  - name: Keys
    description: self-serve scoped child keys (sub-accounts)
paths:
  /v1/cross:
    post:
      tags:
        - Cross
      summary: PREPARE a cross on your desk (never settles)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CrossRequest'
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrossDeal'
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    CrossRequest:
      type: object
      required:
        - seller_iec
        - buyer_iec
        - amount_paise
        - buy_price_bps
        - sell_price_bps
      properties:
        seller_iec:
          type: string
        buyer_iec:
          type: string
        scheme:
          type: string
        amount_paise:
          type: integer
        buy_price_bps:
          type: integer
        sell_price_bps:
          type: integer
        rfq:
          type: boolean
          description: send as an RFQ the counterparty must accept before settle
        note:
          type: string
    CrossDeal:
      type: object
      properties:
        deal:
          type: object
    Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          description: stable machine code
          enum:
            - bad_request
            - unauthorized
            - forbidden
            - not_found
            - conflict
            - unprocessable
            - rate_limited
            - internal
        message:
          type: string
        detail:
          type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-ScripX-Key
      description: >-
        Your API key, e.g. `scripx_live_…`. Bound to one firm; tenant isolation
        is enforced.

````