wallet_peerPayments

Lists pending PeerPay payments or receives one selected payment into the embedded BRC-100 wallet. Receiving requires an explicit messageId and internalizes funds before acknowledging the MessageBox item.

Read as Markdown

Result

PeerPay inbox, receipt or processing status for the selected operation.

Permissions

Embedded payment-wallet only. Receiving can internalize funds and acknowledge a message; it is a mutating operation, not a balance read.

Also available through wallet_payments in compact mode.

Inputs and availability

Full catalog · Local Vault · broadcasting disabled; Local Vault · all roles; Local Vault · payment role only; Local Vault + sponsor

Field	Type / required	Description
operation	"list" \| "receive" Required	See schema for details.
messageId	string Optional	See schema for details. minLength: 1; maxLength: 256

Nested fields are required only when their parent object or array item is supplied.

Full input schema

{
  "type": "object",
  "properties": {
    "operation": {
      "type": "string",
      "enum": [
        "list",
        "receive"
      ]
    },
    "messageId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    }
  },
  "required": [
    "operation"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}