taler-docs

commit fa7275c153452f99c3ac8259f68487b0589a9ed1
parent c058bddb7b7688459daabf7dc8a1111a513f0840
Author: Antoine A <>
Date:   Mon, 13 Jan 2025 15:40:15 +0100

coreapi: clarify more payto types

Diffstat:
M
core/api-bank-revenue.rst
 | 
4
++--
M
core/api-corebank.rst
 | 
33
+++++++++++++++++++--------------

2 files changed, 21 insertions(+), 16 deletions(-)
diff --git a/core/api-bank-revenue.rst b/core/api-bank-revenue.rst
@@ -111,7 +111,7 @@ Querying the transaction history
       // Array of incoming transactions.
       incoming_transactions : RevenueIncomingBankTransaction[];
 
-      // Payto URI to identify the receiver of funds.
+      // Full payto URI to identify the receiver of funds.
       // Credit account is shared by all incoming transactions
       // as per the nature of the request.
       credit_account: string;
@@ -134,7 +134,7 @@ Querying the transaction history
       // @since **v1**
       credit_fee?: Amount;
 
-      // Payto URI to identify the sender of funds.
+      // Full payto URI to identify the sender of funds.
       debit_account: string;
 
       // The wire transfer subject.
diff --git a/core/api-corebank.rst b/core/api-corebank.rst
@@ -308,14 +308,15 @@ Account Management
       // Addresses where to send the TAN for protected operations.
       contact_data?: ChallengeContactData;
 
-      // Full 'payto' URI of a fiat bank account with a 'receiver-name' parameter.
+      // Payto URI of a fiat bank account with an optional 
+      // 'receiver-name' parameter.
       // If 'receiver-name' is missing, ``name`` will be used instead.
       // Payments will be sent to this bank account
       // when the user wants to convert the regional currency
       // back to fiat currency outside bank.
       cashout_payto_uri?: string;
 
-      // Internal payto URI of this bank account.
+      // Simple payto URI of this bank account.
       // Used mostly for testing, this field is ignored if the bank payment
       // method is not IBAN.
       payto_uri?: string;
@@ -375,7 +376,7 @@ Account Management
   .. ts:def:: RegisterAccountResponse
 
     interface RegisterAccountResponse {
-      // Internal payto URI of this bank account.
+      // Full payto URI of this bank account.
       internal_payto_uri: string;
     }
 
@@ -393,7 +394,8 @@ Account Management
       // Addresses where to send the TAN for protected operations.
       contact_data?: ChallengeContactData;
 
-      // Full 'payto' URI of a fiat bank account with a 'receiver-name' parameter.
+      // Payto URI of a fiat bank account with an optional 'receiver-name' 
+      // parameter.
       // If 'receiver-name' is missing, ``name`` will be used instead.
       // Payments will be sent to this bank account
       // when the user wants to convert the regional currency
@@ -548,7 +550,7 @@ Account Management
       // Username of the account
       username: string;
 
-      // Internal payto URI of this bank account.
+      // Full payto URI of this bank account.
       payto_uri: string;
 
       // Current balance of the account
@@ -621,7 +623,7 @@ Account Management
       // Legal name of the account owner.
       name: string;
 
-      // Internal payto URI of this bank account.
+      // Full payto URI of this bank account.
       payto_uri: string;
 
       // Current balance of the account
@@ -689,7 +691,7 @@ Account Management
       // Available balance on the account.
       balance: Balance;
 
-      // payto://-URI of the account.
+      // Full payto URI of the account.
       payto_uri: string;
 
       // Number indicating the max debit allowed for the requesting user.
@@ -707,7 +709,7 @@ Account Management
       // as well.
       contact_data?: ChallengeContactData;
 
-      // Full 'payto' URI (with a 'receiver-name' parameter) of a fiat bank
+      // Full 'payto' URI of a fiat bank
       // account where to send cashouts. This field is optional
       // because not all the accounts are required to participate
       // in the merchants' circuit.  One example is the exchange:
@@ -801,25 +803,28 @@ Transactions
   .. ts:def:: BankAccountTransactionInfo
 
     interface BankAccountTransactionInfo {
-      // ???
+      // Full payto URI to identify the receiver of funds.
       creditor_payto_uri: string;
-      // ???
+
+      // Full payto URI to identify the sender of funds.
       debtor_payto_uri: string;
 
-      // ???
+      // Amount received.
       amount: Amount;
 
-      // ???
+      // The direction of the transaction relative to $USERNAME account.
+      // debit: $USERNAME is the debtor
+      // credit: $USERNAME is the creditor
       direction: "debit" | "credit";
 
-      // ???
+      // The wire transfer subjec
       subject: string;
 
       // Transaction unique ID.  Matches
       // $TRANSACTION_ID from the URI.
       row_id: Integer;
 
-      // ???
+      // Date of the transaction.
       date: Timestamp;
     }