settlementRequests
Returns requests for incoming and outgoing settlement
POST api/settlementRequests
Request parameters
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
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
Last updated