settlementTransactionHistory

Returns settlement transaction history

POST api/settlementTransactionHistory

Payload

{
    "till": 12345,
    "limit": 10,
    "filter": "all"
}

200 OK

[
    [
        3,                // Counterparty id
        "USD",            // Currency
        1000000000,       // Amount
        1234,             // Settlement order id
        "Something",      // Comment
        1558050900000,    // Created at
        "12ehvb324gg",    // Tx UD 
        1558067800000,    // Sent At
        0,                // Reserved flags 
        1558091300000,    // Transaction moment
        567,              // Transaction id
        1000,             // Network fee
        "SWIFT"           // Transaction network 
    ]
]

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 full settlement transactions history - "subaccounts": returns settlement transactions history with subaccounts - "external": returns deals settlement transactions with external counterparties
till	Efx::OrderId	If specified only return settlement transactions with lesser ID
from	Efx::Timestamp	If specified only return settlement transactions with equal or greater timestamp
to	Efx::Timestamp	If specified only return settlement transactions with lesser timestamp
limit	unsigned int16	Default: 250 Maximum number of items to return (capped at 250)

Response description

Filed name	Type	Description
	Array of SettlementTransactions	Settlement Transactions
SettlementTransaction	Array[13]
0	Efx::ClientId	Counterparty Id
1	string	Currency
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 int 16	Transaction Flags
9	Efx::Timestamp	Transaction Moment
10	Efx::DealId	Transaction Id
11	Efx::Size	Network fee
12	string	Transaction network or empty