集成Paytm支付API网关时遇paytmchecksum.generateSignature未处理错误

问题根源 #

Paytm官方的paytmchecksum包未提供TypeScript类型声明，仅添加declare module 'paytmchecksum';只能让TS编译通过，但因模块导入方式错误，会导致运行时无法正确加载模块，进而出现generateSignature未定义的报错。

具体解决步骤 #

• 修正模块导入方式
  由于paytmchecksum是CommonJS模块，优先使用CommonJS语法导入：

  const PaytmChecksum = require('paytmchecksum');
  

  若要使用ES模块的import语法，需在tsconfig.json中开启"allowSyntheticDefaultImports": true，再按以下方式导入：

  import PaytmChecksum from 'paytmchecksum';
  

• 完善类型声明
  不要仅用空的模块声明，在index.d.ts中添加具体的方法类型定义，让TS识别模块导出内容：

  declare module 'paytmchecksum' {
    export function generateSignature(params: Record<string, any>, key: string): Promise<string>;
    export function verifySignature(params: Record<string, any>, key: string, checksum: string): Promise<boolean>;
    // 按需补充其他需要用到的方法
  }
  

• 环境依赖与测试验证

  1. 确保paytmchecksum安装到生产依赖：

     npm install paytmchecksum --save
     

  2. 部署前用本地模拟器测试云函数，验证模块加载正常：

     firebase emulators:start --only functions
     

可运行代码示例 #

import * as functions from "firebase-functions";
const PaytmChecksum = require('paytmchecksum');

exports.generatePaytmChecksum = functions.https.onRequest(async (req, res) => {
  const paytmParams = {
    MID: '你的商户ID',
    ORDER_ID: '唯一订单ID',
    TXN_AMOUNT: '订单金额',
    // 其他Paytm要求的必要参数
  };
  const merchantKey = '你的商户密钥';

  try {
    const checksum = await PaytmChecksum.generateSignature(paytmParams, merchantKey);
    res.status(200).json({ checksum });
  } catch (error) {
    functions.logger.error('生成Checksum失败:', error);
    res.status(500).json({ error: '生成Checksum失败' });
  }
});

内容的提问来源于stack exchange，提问作者Rakesh Kejriwal