Class PaymentRequest

constructor

• new PaymentRequest(
      transport?: PaymentRequestTransport[],
      id?: string,
      amount?: AmountLike,
      unit?: string,
      mints?: string[],
      description?: string,
      singleUse?: boolean,
      nut10?: NUT10Option,
  ): PaymentRequest

  Parameters

  • Optionaltransport: PaymentRequestTransport[]
  • Optionalid: string
  • Optionalamount: AmountLike
  • Optionalunit: string
  • Optionalmints: string[]
  • Optionaldescription: string
  • singleUse: boolean = false
  • Optionalnut10: NUT10Option

  Returns PaymentRequest

Optionalamount

Optionaldescription

Optionalid

Optionalmints

Optionalnut10

singleUse

Optionaltransport

Optionalunit

getTransport

• getTransport(
      type: PaymentRequestTransportType,
  ): PaymentRequestTransport | undefined

  Parameters

  • type: PaymentRequestTransportType

  Returns PaymentRequestTransport | undefined

toEncodedCreqA

• toEncodedCreqA(): string

  Encodes the payment request to creqA format (CBOR).

  Returns string

  A base64 encoded payment request string with 'creqA' prefix.

toEncodedCreqB

• toEncodedCreqB(): string
  Experimental

  Encodes the payment request to creqB format (TLV + bech32m).

  Returns string

  A bech32m encoded payment request string with 'CREQB' prefix.

toEncodedRequest

• toEncodedRequest(): string

  Returns string

toP2PKOptions

• toP2PKOptions(): P2PKOptions | undefined

  Converts this request's nut10 locking option into the P2PKOptions accepted by the .asP2PK() builder, so a payer can produce proofs locked to exactly the spending condition the payee requested.

  Supports P2PK (NUT-11) and HTLC (NUT-14) only. Returns undefined when there is no nut10 option or its kind is not one we can build.

  Returns P2PKOptions | undefined

  Throws

  If the option is missing its data field, or carries malformed NUT-10 tags — invalid lock semantics must not be silently dropped.

toRawRequest

• toRawRequest(): RawPaymentRequest

  Returns RawPaymentRequest

StaticfromEncodedRequest

• fromEncodedRequest(encodedRequest: string): PaymentRequest

  Parameters

  • encodedRequest: string

  Returns PaymentRequest

StaticfromRawRequest

• fromRawRequest(rawPaymentRequest: RawPaymentRequest): PaymentRequest

  Creates a PaymentRequest from a raw payment request. Supports both creqA and creqB versions.

  Parameters

  • rawPaymentRequest: RawPaymentRequest

    The raw payment request string to create a PaymentRequest from.

  Returns PaymentRequest

  A PaymentRequest object.

  Throws

  An error if the raw payment request is not supported.