Prepare a cross

PREPARE a cross on your desk (never settles)

curl --request POST \
  --url https://api.scripxhq.com/v1/cross \
  --header 'Content-Type: application/json' \
  --header 'X-ScripX-Key: <api-key>' \
  --data '
{
  "seller_iec": "<string>",
  "buyer_iec": "<string>",
  "amount_paise": 123,
  "buy_price_bps": 123,
  "sell_price_bps": 123
}
'

import requests

url = "https://api.scripxhq.com/v1/cross"

payload = {
    "seller_iec": "<string>",
    "buyer_iec": "<string>",
    "amount_paise": 123,
    "buy_price_bps": 123,
    "sell_price_bps": 123
}
headers = {
    "X-ScripX-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-ScripX-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    seller_iec: '<string>',
    buyer_iec: '<string>',
    amount_paise: 123,
    buy_price_bps: 123,
    sell_price_bps: 123
  })
};

fetch('https://api.scripxhq.com/v1/cross', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scripxhq.com/v1/cross",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'seller_iec' => '<string>',
    'buyer_iec' => '<string>',
    'amount_paise' => 123,
    'buy_price_bps' => 123,
    'sell_price_bps' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-ScripX-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scripxhq.com/v1/cross"

	payload := strings.NewReader("{\n  \"seller_iec\": \"<string>\",\n  \"buyer_iec\": \"<string>\",\n  \"amount_paise\": 123,\n  \"buy_price_bps\": 123,\n  \"sell_price_bps\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-ScripX-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.scripxhq.com/v1/cross")
  .header("X-ScripX-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"seller_iec\": \"<string>\",\n  \"buyer_iec\": \"<string>\",\n  \"amount_paise\": 123,\n  \"buy_price_bps\": 123,\n  \"sell_price_bps\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scripxhq.com/v1/cross")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-ScripX-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"seller_iec\": \"<string>\",\n  \"buyer_iec\": \"<string>\",\n  \"amount_paise\": 123,\n  \"buy_price_bps\": 123,\n  \"sell_price_bps\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "deal": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": {}
}

POST

cross

PREPARE a cross on your desk (never settles)

curl --request POST \
  --url https://api.scripxhq.com/v1/cross \
  --header 'Content-Type: application/json' \
  --header 'X-ScripX-Key: <api-key>' \
  --data '
{
  "seller_iec": "<string>",
  "buyer_iec": "<string>",
  "amount_paise": 123,
  "buy_price_bps": 123,
  "sell_price_bps": 123
}
'

import requests

url = "https://api.scripxhq.com/v1/cross"

payload = {
    "seller_iec": "<string>",
    "buyer_iec": "<string>",
    "amount_paise": 123,
    "buy_price_bps": 123,
    "sell_price_bps": 123
}
headers = {
    "X-ScripX-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-ScripX-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    seller_iec: '<string>',
    buyer_iec: '<string>',
    amount_paise: 123,
    buy_price_bps: 123,
    sell_price_bps: 123
  })
};

fetch('https://api.scripxhq.com/v1/cross', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.scripxhq.com/v1/cross",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'seller_iec' => '<string>',
    'buyer_iec' => '<string>',
    'amount_paise' => 123,
    'buy_price_bps' => 123,
    'sell_price_bps' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-ScripX-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scripxhq.com/v1/cross"

	payload := strings.NewReader("{\n  \"seller_iec\": \"<string>\",\n  \"buyer_iec\": \"<string>\",\n  \"amount_paise\": 123,\n  \"buy_price_bps\": 123,\n  \"sell_price_bps\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-ScripX-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.scripxhq.com/v1/cross")
  .header("X-ScripX-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"seller_iec\": \"<string>\",\n  \"buyer_iec\": \"<string>\",\n  \"amount_paise\": 123,\n  \"buy_price_bps\": 123,\n  \"sell_price_bps\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scripxhq.com/v1/cross")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-ScripX-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"seller_iec\": \"<string>\",\n  \"buyer_iec\": \"<string>\",\n  \"amount_paise\": 123,\n  \"buy_price_bps\": 123,\n  \"sell_price_bps\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "deal": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": {}
}

Cross desk endpoints require the cross desk to be active on your key. Write to amin@eximfiles.io to have it enabled.

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). Requires the orders:write scope. Returns 201 with the prepared deal. A prepared cross never settles by itself. Money moves only at settle, and the trade completes only at confirm. Each step is a separate, deliberate call.

Request example

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 immediately.

Response example

{
  "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, paise, bps, cross, RFQ, group netting, API key, scope. Full list in the terminology annexure.

Next steps

Settle to fund, then confirm to release.

Authorizations

X-ScripX-Key

string

header

required

Your API key, e.g. scripx_live_…. Bound to one firm; tenant isolation is enforced.

Body

application/json

seller_iec

string

required

buyer_iec

string

required

amount_paise

integer

required

buy_price_bps

integer

required

sell_price_bps

integer

required

scheme

string

rfq

boolean

send as an RFQ the counterparty must accept before settle

note

string

Response

deal

object

Price a cross List crosses

⌘I

Overview

Firms

Scrips & credits

Quotes & orders

Positions

Cross desk

Market & rates

Statements, earnings & usage

Settings

API keys

Webhooks

Audit

Request example

Response example

Errors

Next steps

Authorizations

Body

Response

​Request example

​Response example

​Errors

​Next steps

Authorizations

Body

Response

Request example

Response example

Errors

Next steps