Class AchPayments

Hierarchy

Base
- AchPayments

Index

Constructors

Methods

processAchPayment processCreditCardRefund processCreditCardVoid request

Constructors

constructor

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

Methods

processAchPayment

processAchPayment(req): Promise<PaymentAchResponse>
Processes an ACH payment.
Parameters
- req: PaymentAchRequest
  
  The ACH payment request object.
Returns Promise<PaymentAchResponse>
- A promise that resolves to the payment response object.
- Defined in resources/ach-payments.ts:20

processCreditCardRefund

processCreditCardRefund(req): Promise<PaymentAchRefundResponse>
Process an ACH/Bank account refund.
Parameters
- req: PaymentAchRefund
  
  The ACH/Bank account payment refund object.
Returns Promise<PaymentAchRefundResponse>
The ACH/Bank account payment refund response.
- Defined in resources/ach-payments.ts:169

processCreditCardVoid

processCreditCardVoid(req): Promise<PaymentAchVoidResponse>
Processes an ACH/Bank account payment void.
Parameters
- req: PaymentAchVoid
  
  The ACH/Bank account payment void object.
Returns Promise<PaymentAchVoidResponse>
- The ACH/Bank account payment void response.
- Defined in resources/ach-payments.ts:154

`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