get-private-incoming-ID.rst (3486B)
1 .. http:get:: [/instances/$INSTANCE]/private/incoming/$ID 2 3 Obtain details about an expected incoming wire transfers the backend is 4 anticipating. ID must be the ``expected_transfer_serial_id`` 5 from `ExpectedTransferDetails`. 6 Since protocol **v26**. 7 8 **Required permission:** ``transfers-read`` 9 10 **Response:** 11 12 :http:statuscode:`200 OK`: 13 The body of the response is a `ExpectedTransferDetailResponse`. 14 :http:statuscode:`404 Not found`: 15 The expected wire transfer ``$ID`` is unknown. 16 :http:statuscode:`409 Conflict`: 17 The exchange did not yet provide the transaction details 18 (the ``last_http_status`` of the `ExpectedTransferDetails` is 19 not 200). The information may be available later but is not yet. 20 21 **Details:** 22 23 .. ts:def:: ExpectedTransferDetailResponse 24 25 interface ExpectedTransferDetailResponse { 26 27 // List of orders that are settled by this wire 28 // transfer according to the exchange. Only 29 // available if ``last_http_status`` is 200. 30 reconciliation_details?: ExchangeTransferReconciliationDetails[]; 31 32 // Wire fee paid by the merchant. Only 33 // available if ``last_http_status`` is 200. 34 // Not present if the backend was unable to obtain the 35 // wire fee for the ``execution_time`` from the exchange. 36 // (If missing, this is thus indicative of a minor error.) 37 wire_fee?: Amount; 38 39 // How much should be wired to the merchant (minus fees). 40 // Optional, missing if unknown. Happens if we are still waiting for 41 // details from the exchange. 42 // Since protocol **v27**. 43 expected_credit_amount?: Amount; 44 45 // Raw wire transfer identifier identifying the wire transfer (a base32-encoded value). 46 // Since protocol **v27**. 47 wtid: WireTransferIdentifierRawP; 48 49 // Full payto://-URI of the bank account that should 50 // receive the wire transfer. 51 // Since protocol **v27**. 52 payto_uri: string; 53 54 // Base URL of the exchange that made the wire transfer. 55 // Since protocol **v27**. 56 exchange_url: string; 57 58 // Expected time of the execution of the wire transfer 59 // by the exchange, according to the exchange. Used 60 // to compute the applicable wire fee. 61 // Since protocol **v27**. 62 expected_time: Timestamp; 63 64 // Actual execution time of the wire transfer 65 // as seen by us. 66 // Optional, missing if not ``confirmed``. 67 // Since protocol **v27**. 68 execution_time?: Timestamp; 69 70 // True if we checked the exchange's answer and are happy with 71 // the reconciation data. 72 // False if we have an answer and are unhappy, missing if we 73 // do not (yet) have an answer from the exchange. 74 // Does not imply that the wire transfer was settled. 75 // Since protocol **v27**. 76 validated: boolean; 77 78 } 79 80 .. ts:def:: ExchangeTransferReconciliationDetails 81 82 interface ExchangeTransferReconciliationDetails { 83 84 // ID of the order for which these are the 85 // reconciliation details. 86 order_id: string; 87 88 // Remaining deposit total to be paid, 89 // that is the total amount of the order 90 // minus any refunds that were granted. 91 // The actual amount to be wired is this 92 // amount minus ``deposit_fee`` and (overall) 93 // minus the ``wire_fee`` of the transfer. 94 remaining_deposit: Amount; 95 96 // Deposit fees paid to the exchange for this order. 97 deposit_fee: Amount; 98 99 }