Contents

initiatePeerPullCredit#

Initiate an outgoing peer pull payment: create a payment request (invoice) that another wallet can pay.

Request:

The request body must be an InitiatePeerPullCreditRequest object.

Response:

On success, the result is an InitiatePeerPullCreditResponse object.

Side effects:

Creates an outgoing peer pull payment request transaction.

Expected errors:

The caller can handle the following errors inline: WALLET_NO_SUITABLE_EXCHANGE, WALLET_KYC_LIMIT_EXCEEDED, WALLET_EXCHANGE_TOS_NOT_ACCEPTED, WALLET_CORE_API_BAD_REQUEST, WALLET_EXCHANGE_KEYS_NOT_ACCEPTED.

Details:

The taler://pay-pull/ URI to hand to the payer is available from the transaction (see getTransactionById) once the transaction is in the appropriate state; the talerUri field of the response is deprecated because it is not necessarily valid yet.

interface InitiatePeerPullCreditRequest {
  exchangeBaseUrl?: string;
  partialContractTerms: PeerContractTerms;

  progressToken?: string;
}

interface InitiatePeerPullCreditResponse {
  // Taler URI for the other party to make the requested payment.
  // Deprecated: not necessarily valid yet until the transaction is
  // in the right state.
  talerUri?: string;

  transactionId: TransactionIdStr;
}
Contents