Package tbdex.sdk.messages
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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classOrderInstructions.Companion
-
Field Summary
Fields Modifier and Type Field Description private final MessageMetadatametadataprivate final OrderInstructionsDatadataprivate final Stringsignaturepublic final static OrderInstructions.CompanionCompanion
-
Method Summary
Modifier and Type Method Description final MessageMetadatagetMetadata()Metadata about the message, including sender, recipient, and protocol information. final OrderInstructionsDatagetData()The data part of the Order Instructions, including payment instructions for payin and payout. final StringgetSignature()The signature verifying the authenticity and integrity of the Order Instructions message. final StringtoJsonString()Serializes the Order Instructions to a JSON string. final Unitsign(BearerDid bearerDid)Signs the Order Instructions using the provided Bearer DID. final Unitverify()Verifies the Order Instructions' signature and validity. -
-
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.
-
-
-
-