Class PayNow

Creates a paynow instance

export

Hierarchy

PayNow

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PayNow(apiKey: string, signatureKey: string, options?: PayNowOptions): PayNow

- Defined in src/paynow/PayNow.ts:24
Creates an instance of PayNow.

memberof

PayNow

Parameters
- apiKey: string
  
  API Key from panel
- signatureKey: string
  
  Signature Key from panel
- options: PayNowOptions = ...
Returns PayNow

Properties

Private apiKey

apiKey: string

Private baseUrl

baseUrl: string

Private client

client: AxiosInstance

Private options

options: PayNowOptions

Private signatureKey

signatureKey: string

Methods

calculateSignature

calculateSignature(data: unknown): string

- Defined in src/paynow/PayNow.ts:165
Calculate signature

memberof

PayNow

Parameters
- data: unknown
  
  data for calculate signature
Returns string

createPayment

createPayment(payment: Payment): Promise<PaymentCreatedResponse>

- Defined in src/paynow/PayNow.ts:55
Create a payment

throws

{PayNowError}

memberof

PayNow

Parameters
- payment: Payment
  
  payment details
Returns Promise<PaymentCreatedResponse>

createRefundRequest

createRefundRequest(paymentId: string, amount: number, reason: RefundReason): Promise<RefundCreatedResponse>

- Defined in src/paynow/PayNow.ts:108
Create refund request

memberof

PayNow

Parameters
- paymentId: string
  
  payment id from paynow
- amount: number
  
  amount to refund
- reason: RefundReason
  
  reason for refund
Returns Promise<RefundCreatedResponse>

paymentStatus

paymentStatus(paymentId: string): Promise<PaymentStatusResponse>

- Defined in src/paynow/PayNow.ts:86
Retrieves payment status after the payment request has been submitted

throws

{PayNowError}

memberof

PayNow

Parameters
- paymentId: string
  
  Unique ID of a payment generated by Paynow
Returns Promise<PaymentStatusResponse>

refundStatus

refundStatus(refundId: string): Promise<RefundStatusResponse>

- Defined in src/paynow/PayNow.ts:145
Check refund status of an refund request

memberof

PayNow

Parameters
- refundId: string
  
  id for refund
Returns Promise<RefundStatusResponse>

Generated using TypeDoc