Helpdesk
  • Overview
    • Welcome to Finery Markets
    • About Our Products
      • FM Liquidity Match
        • Master Account
        • Sub-Account
      • FM Pulse
      • White Label solution
  • Product Features
    • Onboarding
    • Risk Management
    • Trading
      • Aggregated Order Book
      • Firm Order Book
      • Pending Limit Orders (GTC)
      • RFQ
      • Toxic Flow Protection
      • Markups
      • Authorized trading
      • Non-Deliverable Trading
      • Voice Trading
      • Interdealer Trading
    • Position Management
    • Settlements
      • Automated Settlements
      • Addresses
    • Control Center
      • Multi-Roles
      • Notifications
      • Reporting
      • Bulk Edit
    • Referral program
  • API Reference
    • Quick Start with API
      • For Market Makers
      • For Takers
    • Data Types
    • REST API
      • Client management
        • getSubaccounts
      • RFQ
        • getSettings
        • getSettings (authorized)
        • getUserSettings (authorized)
        • setUserSettings (authorized)
        • getProviders
        • getSessions
      • Trading
        • add
        • add (authorized)
        • Pending limit orders
          • add (pending limit order)
          • add (pending limit order) (authorized)
          • del
          • del (authorized)
          • delAll
          • delAll (authorized)
          • orders
          • orders (authorized)
        • mod
        • del
        • delAll
        • book
        • voiceTrade
        • liquidationTrade
        • dealHistory
        • dealHistory (authorized)
        • instruments
        • positions
        • instrumentMarkups
        • addInstrumentMarkups
        • delInstrumentMarkups
      • Settlements
        • settlementRequests
        • settlementOrders
        • settlementTransactions
        • settlementHistory
        • settlementTransactionHistory
        • addIncomingSettlementRequest
        • delIncomingSettlementRequest
        • delIncomingSettlementCPRequest
        • addOutgoingSettlementTransaction
        • addIncomingSettlementTransaction
        • sendSettlementTransaction
        • commitIncomingSettlementTransaction
        • delSettlementTransaction
      • Risk Management
        • climits
        • setCLimit
        • delCLimit
        • subaccountsLimits
        • setSubaccountLimit
        • delSubaccountLimit
        • enableTrading
        • disableTrading
        • cAssetLimits
        • setCAssetLimit
        • delCAssetLimit
        • cShortSalesBan
        • setShortSalesBan
        • delShortSalesBan
        • enableInstrumentsWhitelist
        • setInstrumentsWhitelist
        • disableInstrumentsWhitelist
        • instrumentsWhitelist
      • Non-deliverable Trading
        • settings/getOvernightRates
        • settings/setOvernightRates
    • Websocket API
      • Feed 'A' - Assets
      • Feed 'P' - Positions
      • Feed 'L' - Counterparty limits
      • Feed 'B' - Global order books
      • Feed 'F' - Tradable order books
      • Feed 'R' - Settlement requests
      • Feed 'N' - Settlement transactions
      • Feed 'K' - Positions
      • Feed 'O' - Orders
      • Feed 'S' - Settlement orders
      • RFQ
    • FIX API
      • Admin messages
      • Market Data
      • Trade
        • Trading for Takers
        • Trading for LPs and Masters
    • Troubleshooting Errors
      • List of Error Codes
      • Error 3
      • Error 6
      • Error 7
      • Error 14
Powered by GitBook
On this page
  1. API Reference
  2. REST API
  3. Settlements

settlementOrders

Returns pending settlement orders

POST api/settlementOrders

{
    "filter": "all",
    "filterTransactions": true,
    "counterpartyId": 5
}
[
  {
    "settlementOrderId": Efx::OrderId,
    "clientId": Efx::ClientId,
    "counterpartyId": Efx::ClientId,
    "createdAt": Efx::Timestamp,
    "comment": string,
    "flags": uint,
    "currency1": string,
    "size1": Efx::Size,
    "network1": string,  // optional
    "currency2": string, // optional
    "size2": Efx::Size,  // optional
    "network2": string   // optional
  },
  ...
]
{
    "error": 2
}

Request parameters

Field name
Type
Description

filter

string

Optional field for master accounts only (FM Liquidity Match):

• absent or "all" – returns settlement orders for all counterparties

• "subaccounts" – returns settlement orders for sub-accounts

• "external" – returns settlement orders for external counterparties

filterTransactions

bool

Optional. False by default. If set to true, returns settlement orders created without an associated transaction

counterpartyId

Efx::ClientId

Optional. Returns settlement orders associated with the specified counterparty

Response description

Field name
Type
Description

0

Array

Array of settlement orders

SettlementOrder

settlementOrderId

Efx::OrderId

Settlement order id

clientId

Efx::ClientId

Settlement order client id

counterpartyId

Efx::CounterpartyId

Settlement order counterparty id

createdAt

Efx::Timestamp

Created at

comment

string

Comment

flags

unsigned int16

Settlement order flags 1 - controlled by transaction 2 - external 4 - overnights 8 - forced by admin

currency1

string

First currency name

size1

Efx::Size

The first size represents the amount transferred from the client to the counterparty

network1

string

Optional. First network name.

currency2

string

Optional. Second currency name.

size2

Efx::Size

Optional. The second size represents the amount transferred from the counterparty to the client

network2

string

Optional. Second network name

PrevioussettlementRequestsNextsettlementTransactions

Last updated 1 month ago