Class PaymentLinks

Hosted order pages (/l/plink_…), also opened by the widget's buy button.

Index

Constructors

Methods

create list retrieve update

Constructors

constructor

new PaymentLinks(client: Shieldz): PaymentLinks
Parameters
- client: Shieldz
Returns PaymentLinks
- Defined in work/shieldz-sdk/shieldz-sdk/src/catalog.ts:62

Methods

create

create(params: PaymentLinkCreateParams): Promise<PaymentLink>
Parameters
- params: PaymentLinkCreateParams
Returns Promise<PaymentLink>
- Defined in work/shieldz-sdk/shieldz-sdk/src/catalog.ts:64

list

list(): Promise<List<PaymentLink>>
Returns Promise<List<PaymentLink>>
- Defined in work/shieldz-sdk/shieldz-sdk/src/catalog.ts:77

retrieve

retrieve(id: string): Promise<PaymentLink>
Parameters
- id: string
Returns Promise<PaymentLink>
- Defined in work/shieldz-sdk/shieldz-sdk/src/catalog.ts:68

update

update(id: string, params: PaymentLinkUpdateParams): Promise<PaymentLink>
The URL stays the same; active: false turns the link off.
Parameters
- id: string
- params: PaymentLinkUpdateParams
Returns Promise<PaymentLink>
- Defined in work/shieldz-sdk/shieldz-sdk/src/catalog.ts:73