Skip to main content

PaymentRequest

@cashu/cashu-ts

@cashu/cashu-ts / PaymentRequest

Class: PaymentRequest

Defined in: cashu-ts/src/model/PaymentRequest.ts:11

Constructors​

new PaymentRequest()​

new PaymentRequest(transport, id?, amount?, unit?, mints?, description?, singleUse?): PaymentRequest

Defined in: cashu-ts/src/model/PaymentRequest.ts:12

Parameters​

transport​

PaymentRequestTransport[]

id?​

string

amount?​

number

unit?​

string

mints?​

string[]

description?​

string

singleUse?​

boolean = false

Returns​

PaymentRequest

Properties​

amount?​

optional amount: number

Defined in: cashu-ts/src/model/PaymentRequest.ts:15

description?​

optional description: string

Defined in: cashu-ts/src/model/PaymentRequest.ts:18

id?​

optional id: string

Defined in: cashu-ts/src/model/PaymentRequest.ts:14

mints?​

optional mints: string[]

Defined in: cashu-ts/src/model/PaymentRequest.ts:17

singleUse​

singleUse: boolean = false

Defined in: cashu-ts/src/model/PaymentRequest.ts:19

transport​

transport: PaymentRequestTransport[]

Defined in: cashu-ts/src/model/PaymentRequest.ts:13

unit?​

optional unit: string

Defined in: cashu-ts/src/model/PaymentRequest.ts:16

Methods​

getTransport()​

getTransport(type): undefined | PaymentRequestTransport

Defined in: cashu-ts/src/model/PaymentRequest.ts:54

Parameters​

type​

PaymentRequestTransportType

Returns​

undefined | PaymentRequestTransport

toEncodedRequest()​

toEncodedRequest(): string

Defined in: cashu-ts/src/model/PaymentRequest.ts:47

Returns​

string

toRawRequest()​

toRawRequest(): RawPaymentRequest

Defined in: cashu-ts/src/model/PaymentRequest.ts:22

Returns​

RawPaymentRequest

fromEncodedRequest()​

static fromEncodedRequest(encodedRequest): PaymentRequest

Defined in: cashu-ts/src/model/PaymentRequest.ts:75

Parameters​

encodedRequest​

string

Returns​

PaymentRequest

fromRawRequest()​

static fromRawRequest(rawPaymentRequest): PaymentRequest

Defined in: cashu-ts/src/model/PaymentRequest.ts:58

Parameters​

rawPaymentRequest​

RawPaymentRequest

Returns​

PaymentRequest