taler-docs

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

get-accounts-USERNAME-transactions-TRANSACTION_ID.rst (1222B)


      1 .. http:get:: /accounts/$USERNAME/transactions/$TRANSACTION_ID
      2 
      3   Retrieve the transaction whose identifier is ``TRANSACTION_ID``.
      4 
      5   **Response:**
      6 
      7   :http:statuscode:`200 OK`:
      8     The bank responds with an `BankAccountTransactionInfo` object.
      9   :http:statuscode:`401 Unauthorized`:
     10     Invalid or missing credentials.
     11   :http:statuscode:`403 Forbidden`:
     12     Missing rights.
     13   :http:statuscode:`404 Not found`:
     14     The account pointed by ``$USERNAME`` was not found.
     15 
     16   **Details:**
     17 
     18   .. ts:def:: BankAccountTransactionInfo
     19 
     20     interface BankAccountTransactionInfo {
     21       // Full payto URI to identify the receiver of funds.
     22       creditor_payto_uri: string;
     23 
     24       // Full payto URI to identify the sender of funds.
     25       debtor_payto_uri: string;
     26 
     27       // Amount received.
     28       amount: Amount;
     29 
     30       // The direction of the transaction relative to $USERNAME account.
     31       // debit: $USERNAME is the debtor
     32       // credit: $USERNAME is the creditor
     33       direction: "debit" | "credit";
     34 
     35       // The wire transfer subjec
     36       subject: string;
     37 
     38       // Transaction unique ID.  Matches
     39       // $TRANSACTION_ID from the URI.
     40       row_id: Integer;
     41 
     42       // Date of the transaction.
     43       date: Timestamp;
     44     }