Class OrderInstructions

  • All Implemented Interfaces:
    tbdex.sdk.http.ReplyToMessage , tbdex.sdk.messages.Message

    
    public final class OrderInstructions
     implements Message, ReplyToMessage
                        

    Represents an Order Instructions message in the tbDEX protocol.

    An Order Instructions message is sent by a PFI to Alice, providing detailed instructions on how to make a payin or receive a payout.

    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      final MessageMetadata getMetadata() Metadata about the message, including sender, recipient, and protocol information.
      final OrderInstructionsData getData() The data part of the Order Instructions, including payment instructions for payin and payout.
      final String getSignature() The signature verifying the authenticity and integrity of the Order Instructions message.
      final String toJsonString() Serializes the Order Instructions to a JSON string.
      final Unit sign(BearerDid bearerDid) Signs the Order Instructions using the provided Bearer DID.
      final Unit verify() Verifies the Order Instructions' signature and validity.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • getMetadata

         final MessageMetadata getMetadata()

        Metadata about the message, including sender, recipient, and protocol information.

      • getData

         final OrderInstructionsData getData()

        The data part of the Order Instructions, including payment instructions for payin and payout.

      • getSignature

         final String getSignature()

        The signature verifying the authenticity and integrity of the Order Instructions message.

      • toJsonString

         final String toJsonString()

        Serializes the Order Instructions to a JSON string.

        Returns:

        The serialized JSON string of the Order Instructions.

      • sign

         final Unit sign(BearerDid bearerDid)

        Signs the Order Instructions using the provided Bearer DID.

        Parameters:
        bearerDid - The Bearer DID used to sign the Order Instructions.
      • verify

         final Unit verify()

        Verifies the Order Instructions' signature and validity.