nodejs-cryptomus
Version:
A comprehensive Node.js client for the Cryptomus API
94 lines (93 loc) • 2.73 kB
TypeScript
import { CryptomusClient } from '../client';
import { CreatePaymentRequest, PaymentInfo, PaymentStatusRequest, PaymentHistoryRequest, CreateStaticWalletRequest, GenerateQrCodeRequest, RefundRequest, BlockWalletRequest, TestWebhookRequest, ResendWebhookRequest } from '../types';
/**
* Payment service for managing invoices and payments
*/
export declare class PaymentService {
private readonly client;
/**
* Create a new payment service
*
* @param client - Cryptomus API client
*/
constructor(client: CryptomusClient);
/**
* Create a new payment invoice
*
* @param params - Payment creation parameters
* @returns Created payment information
*/
createInvoice(params: CreatePaymentRequest): Promise<PaymentInfo>;
/**
* Get payment information by UUID or order ID
*
* @param params - Parameters containing UUID or order ID
* @returns Payment information
*/
getPaymentInfo(params: PaymentStatusRequest): Promise<PaymentInfo>;
/**
* Get payment history
*
* @param params - History request parameters
* @returns List of payments
*/
getPaymentHistory(params?: PaymentHistoryRequest): Promise<PaymentInfo[]>;
/**
* Create a static wallet
*
* @param params - Static wallet creation parameters
* @returns Created wallet information
*/
createStaticWallet(params: CreateStaticWalletRequest): Promise<PaymentInfo>;
/**
* Block a static wallet
*
* @param params - Block wallet parameters
* @returns Success message
*/
blockWallet(params: BlockWalletRequest): Promise<{
message: string;
}>;
/**
* Generate QR code for a payment
*
* @param params - QR code generation parameters
* @returns QR code data URL
*/
generateQrCode(params: GenerateQrCodeRequest): Promise<{
qr_code: string;
}>;
/**
* Refund a payment
*
* @param params - Refund parameters
* @returns Refund information
*/
refund(params: RefundRequest): Promise<{
message: string;
}>;
/**
* Test a payment webhook
*
* @param params - Test webhook parameters
* @returns Success message
*/
testWebhook(params: TestWebhookRequest): Promise<{
message: string;
}>;
/**
* Resend a payment webhook
*
* @param params - Resend webhook parameters
* @returns Success message
*/
resendWebhook(params: ResendWebhookRequest): Promise<{
message: string;
}>;
/**
* Get list of available payment services
*
* @returns List of available payment services
*/
getServices(): Promise<any[]>;
}