get-transfers-ROW_ID.rst (2341B)
1 .. http:get:: /transfers/$ROW_ID 2 3 Return the status of a transfer initiated from the exchange, identified by the ``ROW_ID``. 4 5 Since protocol **v3**. 6 7 **Response:** 8 9 :http:statuscode:`200 OK`: 10 The transfer is known, and details are given in the `TransferStatus` response body. 11 :http:statuscode:`400 Bad request`: 12 Request malformed. 13 :http:statuscode:`401 Unauthorized`: 14 Authentication failed, likely the credentials are wrong. 15 :http:statuscode:`404 Not found`: 16 The transfer was not found. 17 18 **Details:** 19 20 .. ts:def:: TransferStatus 21 22 interface TransferStatus { 23 // Current status of the transfer 24 // pending: the transfer is in progress 25 // transient_failure: the transfer has failed but may succeed later 26 // permanent_failure: the transfer has failed permanently and will never appear in the outgoing history 27 // success: the transfer has succeeded and appears in the outgoing history 28 status: "pending" | "transient_failure" | "permanent_failure" | "success"; 29 30 // Optional unstructured messages about the transfer's status. Can be used to document the reasons for failure or the state of progress. 31 status_msg?: string; 32 33 // Amount to transfer. 34 amount: Amount; 35 36 // Base URL of the exchange. Shall be included by the bank gateway 37 // in the appropriate section of the wire transfer details. 38 exchange_base_url: string; 39 40 // Optional additional metadata to be stored in the transaction. 41 // @since **v5** 42 metadata?: string; 43 44 // Wire transfer identifier chosen by the exchange, 45 // used by the merchant to identify the Taler order(s) 46 // associated with this wire transfer. 47 wtid: ShortHashCode; 48 49 // The recipient's account identifier as a full payto URI. 50 credit_account: string; 51 52 // Timestamp that indicates when the wire transfer was executed. 53 // In cases where the wire transfer gateway is unable to know when 54 // the wire transfer will be executed, the time at which the request 55 // has been received and stored will be returned. 56 // The purpose of this field is for debugging (humans trying to find 57 // the transaction) as well as for taxation (determining which 58 // time period a transaction belongs to). 59 timestamp: Timestamp; 60 }