modem-pay
Version:
A TypeScript SDK for integrating with the Modem Pay payment gateway, enabling seamless payment processing and financial services in your applications.
18 lines (17 loc) • 842 B
TypeScript
import BaseResource from "./base";
import { TransferParams, Transfer, TransferFeeCheckParams, TransferFeeCheckResponse } from "../types/transfers";
export default class TransfersResource extends BaseResource {
constructor(apiKey: string, maxRetries: number, timeout: number);
/**
* Initiates a transfer.
*
* @param params - The parameters required to initiate the transfer.
* @param idempotencyKey - A unique key to ensure idempotency of the transfer request.
* @returns A promise that resolves to the created Transfer object.
*/
initiate(params: TransferParams, idempotencyKey: string): Promise<Transfer>;
/** Retrieves Transfer data. */
retrieve(id: string): Promise<Transfer>;
/** Check the Transfer Fee */
fee(params: TransferFeeCheckParams): Promise<TransferFeeCheckResponse>;
}