Module types 

Structs

AcknowledgeMessageParams

Parameters for acknowledging (marking as read) a set of messages.

AdvertisementToken

An advertisement token recovered from an overlay lookup.

AuthenticatedPeerMessage

A live-delivered peer message paired with its authenticated-decrypt provenance.

FailedRecipient

A failed recipient entry in a sendList result.

IncomingPayment

A parsed incoming payment from the payment_inbox.

IncomingPaymentRequest

A validated incoming payment request (after filtering and HMAC verification).

InsertionRemittanceInfo

Basket insertion remittance — used when the output targets a basket.

ListDevicesResponse

Response from the /devices (list registered devices) endpoint.

ListMessagesParams

Parameters for listing messages from a specific inbox.

ListMessagesResponse

Response from the /listMessages endpoint.

MessageBoxMultiQuote

Aggregated delivery quotes for multiple recipients.

MessageBoxPermission

A permission record as returned by /permissions/get (camelCase) or /permissions/list (snake_case).

MessageBoxQuote

Quote for delivering a message to a recipient.

MessagePayment

Payment structure included in a sendMessage request when check_permissions requires a fee.

MessagePaymentOutput

One output entry in a MessagePayment.

Payment

A payment token for attaching BSV remittance to a sendList call.

PaymentCustomInstructions

Custom instructions embedded in a PeerPay transaction output.

PaymentOutput

A single output within a Payment struct.

PaymentRemittanceInfo

Remittance output describing how a payment was routed to a recipient.

PaymentRequestLimits

Optional limits for filtering incoming payment requests.

PaymentRequestMessage

A payment request message sent to a recipient’s payment_requests inbox.

PaymentRequestResponse

Response to a payment request, sent to the requester’s payment_request_responses inbox.

PaymentRequestResult

Result returned from request_payment.

PaymentToken

A PeerPay payment token sent to a recipient’s payment_inbox.

RecipientQuote

Quote for a single recipient in a multi-recipient quote request.

RegisterDeviceRequest

Request body for registering an FCM device token.

RegisterDeviceResponse

Response from the /registerDevice endpoint.

RegisteredDevice

A registered device record as returned by the server’s /devices endpoint.

SendListParams

Parameters for sending a message to multiple recipients in one call.

SendListResult

Result of a sendList operation.

SendListTotals

Aggregate fee totals returned in a sendList or multi-quote response.

SendMessageParams

Parameters for sending a message to a recipient’s inbox.

SendMessageRequest

Wire format wrapper — serializes as {"message": <params>} for the /sendMessage endpoint.

SendMessageResponse

Response from the /sendMessage endpoint.

SentRecipient

A single successfully-delivered recipient entry in a sendList result.

ServerPeerMessage

A message as returned by the server’s list endpoint.

SetPermissionParams

Parameters for setting a permission rule on a message box.

WsSendMessageData

Payload for the sendMessage WebSocket event.

WsSendMessagePayload

The message object inside a sendMessage event.

Constants

DEFAULT_PAYMENT_REQUEST_MAX_AMOUNT

DEFAULT_PAYMENT_REQUEST_MIN_AMOUNT

Default limits for filtering incoming payment requests.

PAYMENT_REQUESTS_MESSAGEBOX

Message box names for the payment request system.

PAYMENT_REQUEST_RESPONSES_MESSAGEBOX