taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

commit f92967cc5f6d46025dabba45c5abf767bdbd57c8
parent 7e446a3684ea2a1faf3191ad596c3c98c195046e
Author: Christian Grothoff <christian@grothoff.org>
Date:   Thu,  5 Feb 2026 16:30:04 +0100

use new endpoint for #10965

Diffstat:
Mcore/api-merchant.rst | 58++++++++++++++++++++++++++++++++++++++++++++--------------
1 file changed, 44 insertions(+), 14 deletions(-)

diff --git a/core/api-merchant.rst b/core/api-merchant.rst @@ -5090,13 +5090,13 @@ Querying expected wire transfers **Response:** :http:statuscode:`200 OK`: - The body of the response is a `ExpectedTransferList`. + The body of the response is a `ExpectedTransferListResponse`. **Details:** - .. ts:def:: ExpectedTransferList + .. ts:def:: ExpectedTransferListResponse - interface ExpectedTransferList { + interface ExpectedTransferListResponse { // List of all the expected incoming transfers that fit the // filter that we know. incoming : ExpectedTransferDetails[]; @@ -5139,17 +5139,6 @@ Querying expected wire transfers // (a matching entry exists in /private/transfers) confirmed: boolean; - // List of orders that are settled by this wire - // transfer according to the exchange. Only - // available if ``last_http_status`` is 200. - // @since **v26** - reconciliation_details?: ExchangeTransferReconciliationDetails[]; - - // Wire fee paid by the merchant. Only - // available if ``last_http_status`` is 200. - // @since **v26** - wire_fee: Amount; - // Last HTTP status we received from the exchange, 0 for // none (incl. timeout) last_http_status: Integer; @@ -5161,6 +5150,47 @@ Querying expected wire transfers last_error_detail?: string; } + +.. http:get:: [/instances/$INSTANCE]/private/incoming/$ID + + Obtain details about an expected incoming wire transfers the backend is + anticipating. ID must be the ``expected_transfer_serial_id`` + from `ExpectedTransferDetails`. + Since protocol **v26**. + + **Required permission:** ``transfers-read`` + + **Response:** + + :http:statuscode:`200 OK`: + The body of the response is a `ExpectedTransferDetailResponse`. + :http:statuscode:`404 Not found`: + The expected wire transfer ``$ID`` is unknown. + :http:statuscode:`409 Conflict`: + The exchange did not yet provide the transaction details + (the ``last_http_status`` of the `ExpectedTransferDetails` is + not 200). The information may be available later but is not yet. + + **Details:** + + .. ts:def:: ExpectedTransferDetailResponse + + interface ExpectedTransferDetails { + + // List of orders that are settled by this wire + // transfer according to the exchange. Only + // available if ``last_http_status`` is 200. + reconciliation_details?: ExchangeTransferReconciliationDetails[]; + + // Wire fee paid by the merchant. Only + // available if ``last_http_status`` is 200. + // Not present if the backend was unable to obtain the + // wire fee for the ``execution_time`` from the exchange. + // (If missing, this is thus indicative of a minor error.) + wire_fee?: Amount; + + } + .. ts:def:: ExchangeTransferReconciliationDetails interface ExchangeTransferReconciliationDetails {