@criapix/saas-assinaturas-client
Version:
SDK JavaScript/TypeScript para o AssinaturasService - Sistema de gestão de assinaturas SaaS com processamento de pagamentos de faturas (cartão, PIX, débito), gerenciamento de métodos de pagamento, pagamentos recorrentes e análise de falhas de pagamento
53 lines • 2.66 kB
TypeScript
/**
* Helper class for payment failure analysis and retry logic.
* Provides utilities to analyze payment failures and provide user-friendly feedback.
*/
export declare class PaymentFailureHelper {
/**
* Determines if a payment can be retried based on the failure code/reason.
* @param failureCode - The failure code returned by the payment gateway
* @param failureReason - The failure reason/message
* @returns True if the payment can be retried, false otherwise
*/
static canRetryPayment(failureCode?: string | null, failureReason?: string | null): boolean;
/**
* Gets a suggested action based on the failure code/reason.
* @param failureCode - The failure code returned by the payment gateway
* @param failureReason - The failure reason/message
* @param canRetry - Whether the payment can be retried
* @returns A user-friendly suggested action message
*/
static getSuggestedAction(failureCode?: string | null, failureReason?: string | null, canRetry?: boolean): string;
/**
* Extracts a user-friendly failure reason from code/message.
* @param failureCode - The failure code returned by the payment gateway
* @param failureReason - The failure reason/message
* @param errorMessage - Additional error message
* @returns A user-friendly error message in Portuguese
*/
static getUserFriendlyReason(failureCode?: string | null, failureReason?: string | null, errorMessage?: string | null): string;
}
/**
* Convenience function to check if a payment can be retried
* @param failureCode - The failure code
* @param failureReason - The failure reason
* @returns true if the payment can be retried
*/
export declare function canRetryPayment(failureCode?: string | null, failureReason?: string | null): boolean;
/**
* Convenience function to get suggested action for a payment failure
* @param failureCode - The failure code
* @param failureReason - The failure reason
* @param canRetry - Whether the payment can be retried
* @returns User-friendly suggested action
*/
export declare function getSuggestedAction(failureCode?: string | null, failureReason?: string | null, canRetry?: boolean): string;
/**
* Convenience function to get user-friendly failure reason
* @param failureCode - The failure code
* @param failureReason - The failure reason
* @param errorMessage - Additional error message
* @returns User-friendly error message
*/
export declare function getUserFriendlyReason(failureCode?: string | null, failureReason?: string | null, errorMessage?: string | null): string;
//# sourceMappingURL=paymentFailureHelper.d.ts.map