Alipay OpenAPI SDK for Node.js

The AlipaySdkConfig object defines how the SDK authenticates and communicates with Alipay.

Required Fields:

• appId: Your application ID.
• privateKey: Your application private key string.

Optional Fields:

• signType: Signature type. Defaults to "RSA2". Supports "RSA2" or "RSA".
• alipayPublicKey: Alipay public key (required if you need to verify responses).
• gateway: The gateway URL.
• timeout: Gateway timeout in milliseconds (default: 5000).
• camelcase: Whether to convert snake_case responses to camelCase (default: true).
• keyType: Type of privateKey. Defaults to "PKCS1". Supports "PKCS1" or "PKCS8".
• appCertPath / appCertContent / appCertSn: Application public key certificate settings.
• alipayRootCertPath / alipayRootCertContent / alipayRootCertSn: Alipay root certificate settings.
• alipayPublicCertPath / alipayPublicCertContent / alipayCertSn: Alipay public key certificate settings.
• encryptKey: AES key for AES encryption/decryption interfaces.
• wsServiceUrl: Server address.

The sdkExecute method is used for server-side generation of request strings. These strings are sent to a client (like a mobile App or Mini Program) which then uses them to invoke the Alipay client to complete the payment. It does not trigger a direct payment from the server.

Example for App payment:

const orderStr = sdk.sdkExecute('alipay.trade.app.pay', {
  bizContent: {
    out_trade_no: "ALIPfdf1211sdfsd12gfddsgs3",
    product_code: "FAST_INSTANT_TRADE_PAY",
    subject: "abc",
    body: "234",
    total_amount: "0.01"
  },
  returnUrl: 'https://www.taobao.com'
});

// The resulting orderStr is then passed to the client-side SDK (e.g., my.tradePay in Mini Programs)

// App 支付接口，生成请求字符串，
const orderStr = sdk.sdkExecute('alipay.trade.app.pay', {
  bizContent: {
    out_trade_no: "ALIPfdf1211sdfsd12gfddsgs3",
    product_code: "FAST_INSTANT_TRADE_PAY",
    subject: "abc",
    body: "234",
    total_amount: "0.01"
  },
  returnUrl: 'https://www.taobao.com'
});

console.log(orderStr);

In Public Key mode, you provide your application ID, your application's private key, and the Alipay public key.

Important Note on Key Formats: This SDK defaults to PKCS1 format. If you use the Alipay Key Tool and it generates a different format, you must either:

1. Use the 'Format Conversion' feature in the Key Tool to convert your keys to PKCS1.
2. Explicitly set keyType: 'PKCS8' in the configuration object.

Required configuration keys:

• appId: Your application ID.
• privateKey: Your application's private key (read as an ASCII string).
• alipayPublicKey: Alipay's public key (read as an ASCII string).
• keyType: (Optional) Set to 'PKCS8' if your keys are not in PKCS1 format.
• endpoint: (Optional) The gateway address. Defaults to https://openapi.alipay.com.

import { AlipaySdk } from 'alipay-sdk';
import fs from 'fs';

// Instantiate the client
const alipaySdk = new AlipaySdk({
  // Set application ID
  appId: 'your-APPID',
  // Set application private key
  privateKey: fs.readFileSync('/path/to/private-key.pem', 'ascii'),
  // Set Alipay public key
  alipayPublicKey: fs.readFileSync('/path/to/alipay-public-key.pem', 'ascii'),
  // Key type, must match the generated key format
  // keyType: 'PKCS1',
  // Set gateway address, default is https://openapi.alipay.com
  // endpoint: 'https://openapi.alipay.com',
});

For interfaces requiring file uploads, use the AlipayFormData class to construct multipart/form-data requests. You can add files using file paths, file streams, or file buffers.

Using a file path

const form = new AlipayFormData();
form.addFile('file_content', 'image.jpg', path.join(__dirname, './test.jpg'));

Using a file stream

import fs from 'node:fs';
const form = new AlipayFormData();
form.addFile('file_content', 'image.jpg', fs.createReadStream('/path/to/test-file'));

Using a file buffer

import fs from 'node:fs';
const form = new AlipayFormData();
form.addFile('file_content', 'image.jpg', fs.readFileSync('/path/to/test-file'));

To execute the upload, pass the form instance in the curl options:

const uploadResult = await alipaySdk.curl<{ file_id: string }>('POST', '/v3/alipay/open/file/upload', {
  form,
  body: {
    biz_code: 'openpt_appstore',
  },
});

import { AlipayFormData } from 'alipay-sdk';

const form = new AlipayFormData();
form.addFile('file_content', '图片.jpg', path.join(__dirname, './test.jpg'));

const uploadResult = await alipaySdk.curl<{
  file_id: string;
}>
('POST', '/v3/alipay/open/file/upload', {
  form,
  body: {
    biz_code: 'openpt_appstore',
  },
});

console.log(uploadResult);
// {
//   data: { file_id: 'A*7Cr9T6IAAC4AAAAAAAAAAAAAATcnAA' },
//   responseHttpStatus: 200,
//   traceId: '06033316171731110716358764348'
// }