Skip to main content
POST
/
v1
/
trades
/
{trade_id}
/
abandon
Abandon unused settlement
curl --request POST \
  --url https://api.firmament.shaikazeem.com/v1/trades/{trade_id}/abandon \
  --header 'Content-Type: application/json' \
  --data '
{
  "secret_hash": "1212121212121212121212121212121212121212121212121212121212121212"
}
'
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    secret_hash: '1212121212121212121212121212121212121212121212121212121212121212'
  })
};

fetch('https://api.firmament.shaikazeem.com/v1/trades/{trade_id}/abandon', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "trade_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "quote_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "current_run": true,
  "created_at": "2023-11-07T05:31:56Z",
  "tx_signatures": [
    "<string>"
  ],
  "tx_signature_kinds": [
    {
      "signature": "<string>"
    }
  ],
  "amounts": {
    "input": {
      "asset": "USDC",
      "amount_raw": 1
    },
    "output": {
      "asset": "USDC",
      "amount_raw": 1
    }
  },
  "ledger_summary": {
    "balanced": true,
    "entry_count": 1,
    "net_usdc_estimate": "<string>"
  },
  "integration_status": "runtime_orchestrated",
  "taker_wallet": "11111111111111111111111111111111",
  "expires_at": "2023-11-07T05:31:56Z",
  "input": {
    "asset": "USDC",
    "amount": "1.000000",
    "amount_raw": "1000000",
    "decimals": 9,
    "mint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"
  },
  "output": {
    "asset": "USDC",
    "amount": "1.000000",
    "amount_raw": "1000000",
    "decimals": 9,
    "mint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"
  }
}
{
  "error": {
    "code": "invalid_json",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}
{
  "error": {
    "code": "invalid_json",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}
{
  "error": {
    "code": "invalid_json",
    "message": "<string>",
    "details": [
      "<string>"
    ]
  }
}

Path Parameters

​
trade_id
string<uuid>
required

Trade identifier.

Body

application/json
​
secret_hash
string
required

Browser-held hash commitment for the unused pre-lock settlement.

Pattern: ^[0-9a-fA-F]{64}$

Response

Settlement abandoned.

​
trade_id
string<uuid>
required
​
quote_id
string<uuid>
required
​
run_id
string<uuid>
required

Runtime invocation that created the trade.

​
current_run
boolean
required

Whether the trade belongs to the currently running backend process.

​
created_at
string<date-time>
required
​
settlement_status
enum<string>
required
Available options:
pending,
initiated,
redeemed,
refunded,
failed
​
tx_signatures
string[]
required

Solana transaction signature.

​
tx_signature_kinds
object[]
required
​
amounts
object
required
​
ledger_summary
object
required
​
integration_status
enum<string>
required
Available options:
runtime_orchestrated
​
taker_wallet
string | null

Taker wallet that requested the trade when attribution is known.

Example:

"11111111111111111111111111111111"

​
expires_at
string<date-time> | null

HTLC expiry timestamp when known.

​
input
object | null

Display-friendly input amount, present when known.

​
output
object | null

Display-friendly output amount, present when known.