Package io.fliqa.client.interledger.model

Class Limits

java.lang.Object
io.fliqa.client.interledger.model.Limits
public class Limits extends Object
Represents access limits for Interledger payment operations.

This class defines the constraints and limits that can be applied to access grants for payment operations. Limits help control the scope and scale of operations that can be performed using an access token, providing security and risk management for payment flows.

All fields are optional and will be excluded from JSON serialization when null, allowing for flexible limit configurations based on specific use cases and security requirements.

Since:
1.0

  • Field Details

    • receiver

      public URI receiver
      The specific receiver (incoming payment) URI that this limit applies to.

      When specified, this limit restricts operations to only work with the specified incoming payment endpoint. This provides fine-grained control over which payment destinations can be accessed.

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

      See Also:

    • receiveAmount

      public InterledgerAmount receiveAmount
      The maximum amount that can be received through this access grant.

      This field sets an upper limit on the total amount that can be received in the specified asset. It helps prevent unauthorized or excessive payment amounts and provides spending control.

      When set, any payment operation that would exceed this limit will be rejected by the authorization server.

    • debitAmount

      public InterledgerAmount debitAmount
      The maximum amount that can be debited (sent) through this access grant.

      This field sets an upper limit on the total amount that can be debited from the account in the specified asset. It provides spending control and helps prevent unauthorized large transactions.

      When set, any payment operation that would exceed this limit will be rejected by the authorization server.

    • interval

      public String interval
      ISO8601 repeating interval specification for recurring payment limits.

      This field defines the time interval for recurring payment operations. It follows the ISO8601 duration and repeating interval format, allowing for complex recurring payment schedules.

      Note: This field is currently not fully implemented and is reserved for future use when repeating transaction functionality is added to the system.

      Example formats:

      • P1D - Daily recurring
      • P1W - Weekly recurring
      • P1M - Monthly recurring
      • R12/2023-01-01T00:00:00Z/P1M - 12 monthly payments starting January 1, 2023
      See Also:

  • Constructor Details

    • Limits

      public Limits()