Package io.fliqa.client.interledger.model

Class MetaData

java.lang.Object
io.fliqa.client.interledger.model.MetaData
public class MetaData extends Object
Represents metadata associated with Interledger payment operations.

This class contains optional metadata that can be attached to payments to provide additional context, references, or descriptive information. Metadata is useful for tracking, reconciliation, and providing human-readable information about payment transactions.

All fields are optional and will be excluded from JSON serialization when null, helping to keep the payload minimal.

Since:
1.0

  • Field Details

    • externalId

      public String externalId
      An external identifier for the payment.

      This field can be used to reference the payment in external systems such as accounting systems, invoicing systems, or other business applications. It provides a way to correlate Interledger payments with business transactions.

      Examples of external IDs include:

      • Invoice numbers (e.g., "INV-2023-001")
      • Order identifiers (e.g., "ORDER-12345")
      • Transaction references (e.g., "TXN-ABC123")

    • value

      public Set<MetaDataItem> value
      A set of key-value metadata items providing additional context.

      This field contains structured metadata as a collection of key-value pairs. It allows for flexible, extensible metadata that can be customized based on specific business requirements or use cases.

      Common use cases include:

      • Payment descriptions and notes
      • Customer or merchant information
      • Transaction categorization
      • Regulatory or compliance data
      See Also:

  • Constructor Details

    • MetaData

      public MetaData()