Package io.fliqa.client.interledger.model

Class IncomingPayment

java.lang.Object
io.fliqa.client.interledger.model.IncomingPayment
public class IncomingPayment extends Object
Represents an incoming payment request on a receiver's wallet.

An incoming payment is created to establish a payment destination with a specific amount that senders can pay to. It serves as the target for outgoing payments and tracks the completion status and received amount.

This is created in step 2 of the payment flow on the receiver's wallet and referenced by senders when creating quotes and executing payments.

Since:
1.0
See Also:

  • Field Details

    • id

      public URI id
      Unique identifier for this incoming payment.

      This URI uniquely identifies the incoming payment resource and is used by senders to reference this payment destination when creating quotes and outgoing payments.

      Example: "https://ilp.interledger-test.dev/incoming-payments/123e4567-e89b-12d3-a456-426614174000"

    • completed

      public boolean completed
      Indicates whether the incoming payment has been completed.

      A payment is considered completed when the full expected amount has been received or when the payment has been explicitly marked as complete by the receiver.

    • createdAt

      public Instant createdAt
      Timestamp when this incoming payment was created.

      This is set when the incoming payment resource is first created and remains immutable throughout the payment's lifecycle.

    • updatedAt

      public Instant updatedAt
      Timestamp when this incoming payment was last updated.

      This is updated whenever the payment status changes, amounts are received, or other modifications are made to the payment resource.

    • expiresAt

      public Instant expiresAt
      Optional expiration timestamp for this incoming payment.

      After this time, the payment will no longer accept incoming funds. If not specified, the payment may remain open indefinitely or use the wallet's default expiration policy.

    • incomingAmount

      public InterledgerAmount incomingAmount
      The expected amount to be received for this payment.

      This represents the total amount that the receiver expects to receive. It may be used by senders to determine the appropriate payment amount, though senders can also send partial payments.

    • methods

      public Set<InterledgerMethod> methods
      The payment methods supported by this incoming payment.

      This set contains the various ways senders can deliver payments to this incoming payment endpoint. Each method includes the necessary information for establishing a payment connection.

      See Also:

    • receivedAmount

      public InterledgerAmount receivedAmount
      The actual amount received so far for this payment.

      This tracks the cumulative amount that has been successfully received for this incoming payment. It starts at zero and increases as payments are received from senders.

    • walletAddress

      public URI walletAddress
      The wallet address where this incoming payment is hosted.

      This identifies the wallet or account that will receive the funds. It corresponds to the base wallet address used to create this payment.

    • metadata

      public MetaData metadata
      Optional metadata associated with this incoming payment.

      This can include additional context, references, or descriptive information about the payment purpose, invoice numbers, or other business-related data.

      See Also:

  • Constructor Details

    • IncomingPayment

      public IncomingPayment()