get-monitoring-pending-deposits.rst (1782B)
1 .. http:get:: /monitoring/pending-deposits 2 3 Get a list of pending deposits. 4 @since protocol **v2**. 5 6 The following query parameters are optional, and can be used to customise the response: 7 8 **Request:** 9 10 :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. 11 :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. 12 :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false. 13 14 With the default settings, the endpoint returns at most the 20 latest elements that are not suppressed. 15 16 **Response:** 17 18 :http:statuscode:`200 OK`: 19 The auditor responds with a top level array of :ts:type:`GetPendingDepositsResponse` objects. 20 21 **Details:** 22 23 .. ts:def:: GetPendingDepositsResponse 24 25 interface GetPendingDepositsResponse { 26 27 // Array of pending deposits. 28 pending_deposits: PendingDepositEntry[]; 29 30 } 31 32 .. ts:def:: PendingDepositEntry 33 34 interface PendingDepositEntry { 35 36 // Unique row identifier in the auditor table 37 row_id : Integer; 38 39 // Row identifier in the exchange's batch deposit table 40 batch_deposit_serial_id : Integer; 41 42 // Amount that was aggregated early. 43 total_amount : Amount; 44 45 // Hash of the bank account that should have received the funds. 46 h_wire : HashCode; 47 48 // When was the deadline for the transfer. 49 deadline : Timestamp; 50 51 // True if this diagnostic was suppressed. 52 suppressed : boolean; 53 54 } 55 56 .. note:: 57 58 This endpoint is still experimental. The endpoint will be further developed as needed.