settlementTransactions

Returns incoming and outgoing settlement transactions

POST api/settlementTransactions

Payload

{
    "filter": "all"
}

200 OK

[
    [                         // Incoming settlement transactions
        [
            7,                 // Counterparty id
            "BTC",             // Currency name
            10000000,          // Amount
            123456789,         // Settlement order id
            "some comment",    // Comment
            1558050900000,     // Created at
            "a79f290b3a0928c", // Tx Id
            1558050900000,     // Sent at
            0,                 // Reserved flags
            0,                 // Transaction moment
            0,                 // Transaction id
            100,               // Network fee
            "BTC"              // Transaction network name  
        ]
     ],
     [                         // Outgoing settlement transactions
         ...
     ]
]

400 Bad request

{
    "error": 2
}

Request parameters

Field name	Type	Description
filter	string	Optional field for master accounts only (FM Liquidity Match). - absent or "all": returns settlement transactions for all counterparties - "subaccounts": returns settlement transactions for the sub-accounts - "external": returns settlement transactions for external counterparties

Response description

Field name	Type	Description
	Array[2]	Array of settlement transactions
0	Array of SettlementTransactions	Incoming settlement transactions
1	Array of SettlementTransactions	Outgoing settlement transactions
SettlementTransaction	Array[13]
0	Efx::ClientId	Counterparty id
1	string	Currency name
2	Efx::Size	Amount
3	Efx::OrderId	Settlement order id
4	string	Comment
5	Efx::Timestamp	Created at
6	string	Tx id
7	Efx::Timestamp	Sent at
8	unsigned int16	Transaction Flags
9	Efx::Timestamp	Transaction moment
10	Efx::DealId	Transaction id
11	Efx::Size	Network fee
12	string	Network or empty