Package io.fliqa.client.interledger.model

Class OutgoingPayment

java.lang.Object
io.fliqa.client.interledger.model.OutgoingPayment
public class OutgoingPayment extends Object
Represents the response from creating an outgoing payment request.

This class contains the information returned by the authorization server when a client requests permission to create an outgoing payment. It includes continuation information for the access grant process and either interaction details or an access token, depending on the authorization flow.

The outgoing payment response is used in the Interledger Open Payments protocol to manage the authorization flow for sending payments. It provides the necessary information for the client to complete the payment authorization and proceed with the actual payment execution.

The response will contain either:

  • Interaction information if user consent is required
  • An access token if authorization is granted immediately
Since:
1.0
See Also:

  • Field Details

    • paymentContinue

      public AccessContinue paymentContinue
      The continuation information for the access grant process.

      This field contains the information needed to continue the access grant process after the initial request. It includes the access token and continuation URI that the client can use to manage the grant.

      The payment continuation is always provided and allows the client to track and manage the authorization status of the payment request.

      See Also:

    • interact

      public InteractContinue interact
      Optional interaction information if user consent is required.

      This field is present when the authorization server requires user interaction to complete the payment authorization. It contains the information needed to continue the grant process after the user has completed the required interaction.

      Note: Either this field or the access token field will be present, but not both. This field is used when user consent is required.

      See Also:

    • token

      public String token
      Optional access token if authorization is granted immediately.

      This field contains the access token that can be used immediately to access the payment resources. It is present when the authorization server can grant access without requiring user interaction.

      Note: Either this field or the interact field will be present, but not both. This field is used when immediate authorization is granted.

      Example: "OS9M2PMHKUR64TB8N6BW7OZB8CDFONP219RP1LT0"

  • Constructor Details

    • OutgoingPayment

      public OutgoingPayment()