Class PaymentLinksService

Index

Constructors

Methods

create delete get list update

Constructors

constructor

new PaymentLinksService(http: HttpClient): PaymentLinksService
Parameters
- http: HttpClient
Returns PaymentLinksService
- Defined in src/services/payment-links.ts:12

Methods

create

create(
params: CreatePaymentLinkParams,
options?: RequestOptions,
): Promise<APIResponseEnvelope<PaymentLinkData>>
Create hosted payment link.
Parameters
- params: CreatePaymentLinkParams
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<PaymentLinkData>>
Example
```
const link = await marzpay.paymentLinks.create({
  title: 'Invoice Payment #102',
  amount: 50000,
  currency: 'UGX',
  country: 'UG'
}, { idempotencyKey: 'idemp-link-102' });
```
- Defined in src/services/payment-links.ts:27

delete

delete(
uuid: string,
options?: RequestOptions,
): Promise<APIResponseEnvelope<{ message: string }>>
Delete payment link by UUID.
Parameters
- uuid: string
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<{ message: string }>>
- Defined in src/services/payment-links.ts:86

get

get(
uuid: string,
options?: RequestOptions,
): Promise<APIResponseEnvelope<PaymentLinkData>>
Get payment link details by UUID.
Parameters
- uuid: string
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<PaymentLinkData>>
- Defined in src/services/payment-links.ts:59

list

list(
params?: ListPaymentLinksParams,
options?: RequestOptions,
): Promise<APIResponseEnvelope<{ payment_links: PaymentLinkRecord[] }>>
List payment links.
Parameters
- params: ListPaymentLinksParams = {}
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<{ payment_links: PaymentLinkRecord[] }>>
- Defined in src/services/payment-links.ts:41

update

update(
    uuid: string,
    params: Partial<CreatePaymentLinkParams>,
    options?: RequestOptions,
): Promise<APIResponseEnvelope<PaymentLinkData>>
Update existing payment link details by UUID.
Parameters
- uuid: string
- params: Partial<CreatePaymentLinkParams>
- Optionaloptions: RequestOptions
Returns Promise<APIResponseEnvelope<PaymentLinkData>>
- Defined in src/services/payment-links.ts:71