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)
      • Quote streams
      • 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
        • connectCounterparty
        • cancelConnectionInvite
        • getCounterpartyInfo
        • getSubaccounts
      • Trading
        • Order Book & QS
          • 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
          • qs/getAvailableQsProviders
        • RFQ
          • getSettings
          • getSettings (authorized)
          • getUserSettings (authorized)
          • setUserSettings (authorized)
          • getProviders
          • getSessions
      • Settlements
        • settlementRequests
        • settlementOrders
        • settlementTransactions
        • settlementHistory
        • settlementTransactionHistory
        • addIncomingSettlementRequest
        • delIncomingSettlementRequest
        • delIncomingSettlementCPRequest
        • addOutgoingSettlementTransaction
        • addIncomingSettlementTransaction
        • sendSettlementTransaction
        • commitIncomingSettlementTransaction
        • delSettlementTransaction
      • Risk Management
        • climits
        • setCLimit
        • delCLimit
        • enableTrading
        • disableTrading
        • cAssetLimits
        • setCAssetLimit
        • delCAssetLimit
        • cShortSalesBan
        • setShortSalesBan
        • delShortSalesBan
        • enableInstrumentsWhitelist
        • setInstrumentsWhitelist
        • disableInstrumentsWhitelist
        • instrumentsWhitelist
      • Non-deliverable Trading
        • settings/getOvernightRates
        • settings/setOvernightRates
      • QS Stream Management
        • qs/addStream
        • qs/removeStream
        • qs/getStreams
        • qs/addTakerToStream
        • qs/delTakerFromStream
    • 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
      • QS for Liquidity Providers
        • Market Data
        • Trading
      • QS for Takers
        • Market Data
    • FIX API
      • Admin messages
      • Market Data
      • Trade
        • Trading for Takers
        • Trading for LPs and Masters
      • QS for Liquidity Providers
        • Market Data
        • Trading
      • QS for Takers
        • Market Data
    • 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

settlementRequests

Returns requests for incoming and outgoing settlement

POST api/settlementRequests

{
    "filter": "all"
}
[
    [                        // Incoming requests array
        [
            4,               // Counterparty id
            "BTC",           // Currency name
            0,               // Flags
            6700000000,      // Requested amount
            "your comment",  // Comment
            1634406457410,   // Expiration time
            "BTC",           // Transaction network
            123456,          // Request id
            1634405457410    // Creation time    
        ]
    ],
    [                        // Outgoing requests array 
        [
            4,
            "USD",
            0,
            0,
            "",
            0,                // Request won't be cancelled
            ""                // Network is not specified
            123456,           // Request id
            1634405457410     // Creation time
        ]
    ]
]
{
    "error": 2
}

Request parameters

Field name
Type
Description

filter

string

Optional field for master accounts only (FM Liquidity Match). - absent or "all": returns settlement requests for all counterparties - "subaccounts": returns settlement requests for sub-accounts - "external": returns settlement requests for external counterparties

Response description

Field name
Type
Description

Array[2]

Settlement requests

0

Array of SettlementRequests

Incoming settlement requests

1

Array of SettlementRequests

Outgoing settlement requests

SettlementRequest

Array[7]

0

Efx::ClientId

Counterparty id

1

string

Currency name

2

Efx::Flags

0 - No flags

1 - Fee paid by recipient

3

Efx::Size

Requested amount. If zero, the full outstanding position is supposed to be settled

4

string

Comment

5

Efx::Timestamp

Request expiration time in milliseconds. If 0, request won't be expired.

6

string

Network or empty.

7

unsigned int64

Request id

8

Efx::Timestamp

Unix timestamp with milliseconds when the request was created

PreviousSettlementsNextsettlementOrders

Last updated 1 year ago