Release a cross - ScripX Docs

Release a funded cross (gated terminal step)

curl --request POST \
  --url https://api.scripxhq.com/v1/cross/{cross_id}/confirm \
  --header 'X-ScripX-Key: <api-key>'

import requests

url = "https://api.scripxhq.com/v1/cross/{cross_id}/confirm"

headers = {"X-ScripX-Key": "<api-key>"}

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

print(response.text)

const options = {method: 'POST', headers: {'X-ScripX-Key': '<api-key>'}};

fetch('https://api.scripxhq.com/v1/cross/{cross_id}/confirm', 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/{cross_id}/confirm",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scripxhq.com/v1/cross/{cross_id}/confirm"

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

	req.Header.Add("X-ScripX-Key", "<api-key>")

	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/{cross_id}/confirm")
  .header("X-ScripX-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scripxhq.com/v1/cross/{cross_id}/confirm")

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

request = Net::HTTP::Post.new(url)
request["X-ScripX-Key"] = '<api-key>'

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

{cross_id}

confirm

Release a funded cross (gated terminal step)

curl --request POST \
  --url https://api.scripxhq.com/v1/cross/{cross_id}/confirm \
  --header 'X-ScripX-Key: <api-key>'

import requests

url = "https://api.scripxhq.com/v1/cross/{cross_id}/confirm"

headers = {"X-ScripX-Key": "<api-key>"}

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

print(response.text)

const options = {method: 'POST', headers: {'X-ScripX-Key': '<api-key>'}};

fetch('https://api.scripxhq.com/v1/cross/{cross_id}/confirm', 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/{cross_id}/confirm",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.scripxhq.com/v1/cross/{cross_id}/confirm"

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

	req.Header.Add("X-ScripX-Key", "<api-key>")

	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/{cross_id}/confirm")
  .header("X-ScripX-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.scripxhq.com/v1/cross/{cross_id}/confirm")

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

request = Net::HTTP::Post.new(url)
request["X-ScripX-Key"] = '<api-key>'

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.

The terminal step. Releasing a funded cross completes delivery versus payment: credit to the buyer, proceeds to the seller, deal closed. Requires the orders:write scope. Release only after your off-platform checks are done; this is the point of no return, and the gate exists so it is always a human-authorised decision, never a side effect.

Request example

curl -X POST "https://api.scripxhq.com/v1/cross/crs_01HZY…/confirm" \
  -H "X-ScripX-Key: <YOUR_API_KEY>"

Response example

{
  "deal": {
    "cross_id": "crs_01HZY…",
    "status": "settled",
    "amount_paise": 500000000
  }
}

settlement.settled and payout.sent webhooks follow.

Errors

409 conflict, the cross is not funded, or is already terminal.
404 not_found, no such cross on your desk.

Terms used here: paise, cross, DvP, API key, scope, webhook. Full list in the terminology annexure.

Next steps

Earnings, your desk’s take lands in payable_paise.

Authorizations

X-ScripX-Key

string

header

required

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

Path Parameters

cross_id

string

required

Response

deal

object

Fund a cross Market snapshot

⌘I

​Request example

​Response example

​Errors

​Next steps

Authorizations

Path Parameters

Response

Request example

Response example

Errors

Next steps