taler-docs

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

confirm-peer-push-credit.rst (1066B)

      1 .. ts:op:: confirmPeerPushCredit
      2 
      3   Accept an incoming peer push payment, after reviewing it with
      4   :ts:op:`preparePeerPushCredit`.
      5 
      6   **Request:**
      7 
      8   The request body must be a `ConfirmPeerPushCreditRequest` object.
      9 
     10   **Response:**
     11 
     12   On success, the result is an `AcceptPeerPushPaymentResponse`
     13   object.  Confirmation is idempotent: confirming a transaction that
     14   already left the review state returns the same ``transactionId``.
     15 
     16   **Side effects:**
     17 
     18   Confirms an incoming peer push payment; the wallet withdraws the
     19   funds from the purse over the network.
     20 
     21   **Expected errors:**
     22 
     23   The caller can handle the following errors inline:
     24   ``WALLET_KYC_LIMIT_EXCEEDED``, ``WALLET_EXCHANGE_TOS_NOT_ACCEPTED``,
     25   ``WALLET_TRANSACTION_NOT_FOUND``,
     26   ``WALLET_EXCHANGE_KEYS_NOT_ACCEPTED``.
     27 
     28 .. ts:def:: ConfirmPeerPushCreditRequest
     29 
     30   interface ConfirmPeerPushCreditRequest {
     31     transactionId: string;
     32 
     33     progressToken?: string;
     34   }
     35 
     36 .. ts:def:: AcceptPeerPushPaymentResponse
     37 
     38   interface AcceptPeerPushPaymentResponse {
     39     transactionId: TransactionIdStr;
     40   }