Class CardPayments

Hierarchy

Base
- CardPayments

Index

Constructors

Methods

processCreditCardCapture processCreditCardPayment processCreditCardRefund processCreditCardVoid request

Constructors

constructor

new CardPayments(config): CardPayments
Constructor function for the Config class.
Parameters
- config: Config
  
  The configuration options for the class.
Returns CardPayments
Inherited from Base.constructor
- Defined in base.ts:22

Methods

processCreditCardCapture

processCreditCardCapture(card): Promise<PaymentCardAuthorizeCaptureResponse>
Processes a card authorization payment capture.
Parameters
- card: PaymentCardAuthorizeCapture
  
  The card information for the original card authorization and capture amount.
Returns Promise<PaymentCardAuthorizeCaptureResponse>
A promise that resolves to the response of the card authorization capture.
- Defined in resources/card-payments.ts:232

processCreditCardPayment

processCreditCardPayment(card): Promise<PaymentCardResponse>
Process a credit card payment.
Parameters
- card: PaymentCardRequest
  
  Process a credit card payment.
Returns Promise<PaymentCardResponse>
A promise that resolves to the credit card payment response.
- Defined in resources/card-payments.ts:24

processCreditCardRefund

processCreditCardRefund(card): Promise<PaymentCardRefundResponse>
Process a credit card refund.
Parameters
- card: PaymentCardRefund
  
  The payment card refund object.
Returns Promise<PaymentCardRefundResponse>
The payment card refund response.
- Defined in resources/card-payments.ts:217

processCreditCardVoid

processCreditCardVoid(card): Promise<PaymentCardVoidResponse>
Processes a credit card void.
Parameters
- card: PaymentCardVoid
  
  The payment card void object.
Returns Promise<PaymentCardVoidResponse>
- A promise that resolves to the payment card void response.
- Defined in resources/card-payments.ts:202

`Protected` request

request<T>(endpoint, queryParams?, options?): Promise<T>
Sends a request to the specified endpoint with optional query parameters and options.
Type Parameters
- T
Parameters
- endpoint: string
  
  The endpoint to send the request to.
- Optional queryParams: Record<string, any>
  
  Optional query parameters for the request.
- Optional options: RequestInit
  
  Optional additional options for the request.
Returns Promise<T>
A promise that resolves to the response data.
Inherited from Base.request
- Defined in base.ts:37

Generated using TypeDoc