@deliverart/sdk-js-payment

中文文档
3.0.1发布于 2026/11/11TypeScriptESM + CJS近 30 天下载 4165

为支付管理交付JavaScript SDK

中文使用文档
文档目录13 节
  1. 安装
  2. 额外订单付款
  3. 导出类型
  4. 核心类型
  5. 付款方法类型
  6. 付款状况类型
  7. IRI 类型
  8. 可用请求
  9. 付款
  10. 支付配置
  11. 完成使用示例
  12. 许可证
  13. 人工用餐凭单和财务控制

@ deliverart/ sdk- js - 付款

交付艺术JavaScript SDK的支付管理套件.

安装

npm install @deliverart/sdk-js-payment @deliverart/sdk-js-core

额外订单付款

GetPaymentInfo 读着修正案的单行费,没有投票费. 它的同步出票正在准备中, sessionUrl 财务报告和审定财务报表 expiresAt 两者都是 null一旦准备好,它们就包含存储的链接和过期时间戳. 只有当 sessionUrl 是非无. 过期、失效或已付款 语句返回无效链接; 仅过期不能证明付款失败. 金额是额外余额的十进制字符串,而不是原顺序 支付。 建立链接并不确认收到资金.

现有 /orders/{id}/pay 全订单流动和一般付款 一旦修正结算会计活动开始,则无法替换付款。 使用 命令的结算业务代替。 原付款保持不变.

导出类型

核心类型

  • Payment - 付款信息
  • PaymentDetails - 附有订单细节的延期付款
  • PaymentConfig - 销售点的付款配置
  • PaymentMethod - 付款方法类型
  • PaymentStatus - 缴款情况

付款方法类型

type PaymentMethod = 
  | 'CASH'
  | 'CREDIT_CARD'
  | 'DEBIT_CARD'
  | 'STRIPE'
  | 'PAYPAL'
  | 'SATISPAY'
  | 'ONLINE'
  | 'POS'

付款状况类型

type PaymentStatus = 
  | 'PENDING'
  | 'PROCESSING'
  | 'COMPLETED'
  | 'FAILED'
  | 'REFUNDED'
  | 'CANCELLED'

IRI 类型

  • PaymentIri - 支付IRI/payments/:id(中文(简体) )
  • PaymentConfigIri - 付款配置IRI/payment_configs/:id(中文(简体) )

可用请求

付款

创建支付

import { CreatePayment } from '@deliverart/sdk-js-payment';

const payment = await sdk.call(new CreatePayment({
  order: '/orders/123',
  method: 'CREDIT_CARD',
  amount: 2500, // In cents
  status: 'PENDING'
}));

输入参数:

  • order: string (必需) - IRI命令
  • method: PaymentMethod (必需) - 支付方法
  • amount: number (所需) -- -- 以美分计的数额
  • status?: PaymentStatus (可选) - 初始状态(默认:"PENDING")
  • transactionId?: string (可选) - 外部交易ID
  • metadata?: object (可选) - 附加元数据

获得付款

import { GetPayments } from '@deliverart/sdk-js-payment';

const payments = await sdk.call(new GetPayments({
  query: {
    order: '/orders/123',
    method: 'CREDIT_CARD',
    'status[]': ['COMPLETED', 'PENDING'],
    page: 1
  }
}));

查询参数:

  • order?: string - 按顺序过滤
  • method?: PaymentMethod - 通过支付方法过滤
  • status[]?: PaymentStatus[] - 按状态过滤
  • createdAt[before]?: string - 在日期之前创建
  • createdAt[after]?: string - 日期后创建
  • page?: number - 页号

获取付款细节

import { GetPaymentDetails } from '@deliverart/sdk-js-payment';

const payment = await sdk.call(new GetPaymentDetails('payment-123'));

更新付款

import { UpdatePayment } from '@deliverart/sdk-js-payment';

const updated = await sdk.call(new UpdatePayment('payment-123', {
  status: 'COMPLETED',
  transactionId: 'txn_abc123'
}));

支付配置

创建付费配置

import { CreatePaymentConfig } from '@deliverart/sdk-js-payment';

const config = await sdk.call(new CreatePaymentConfig({
  pointOfSale: '/point_of_sales/123',
  method: 'STRIPE',
  enabled: true,
  config: {
    publicKey: 'pk_test_...',
    secretKey: 'sk_test_...'
  }
}));

输入参数:

  • pointOfSale: string (需要) - 销售点
  • method: PaymentMethod (必需) - 支付方法
  • enabled: boolean (要求) - 启用/残疾支付方法
  • config: object (要求) - 针对具体方法的配置

获取付费配置

import { GetPaymentConfigs } from '@deliverart/sdk-js-payment';

const configs = await sdk.call(new GetPaymentConfigs({
  query: {
    pointOfSale: '/point_of_sales/123',
    enabled: true
  }
}));

更新 Payment 配置

import { UpdatePaymentConfig } from '@deliverart/sdk-js-payment';

const updated = await sdk.call(new UpdatePaymentConfig('config-123', {
  enabled: false
}));

完成使用示例

import { sdk } from './lib/sdk';
import {
  CreatePaymentConfig,
  CreatePayment,
  UpdatePayment,
  GetPayments
} from '@deliverart/sdk-js-payment';

async function paymentWorkflow() {
  // Setup payment methods for point of sale
  await sdk.call(new CreatePaymentConfig({
    pointOfSale: '/point_of_sales/123',
    method: 'STRIPE',
    enabled: true,
    config: {
      publicKey: process.env.STRIPE_PUBLIC_KEY,
      secretKey: process.env.STRIPE_SECRET_KEY
    }
  }));

  // Create payment for order
  const payment = await sdk.call(new CreatePayment({
    order: '/orders/456',
    method: 'CREDIT_CARD',
    amount: 2500,
    status: 'PENDING'
  }));

  // Process payment (integrate with payment gateway)
  // ... payment processing logic ...

  // Update payment status
  await sdk.call(new UpdatePayment(payment.id, {
    status: 'COMPLETED',
    transactionId: 'txn_abc123'
  }));

  // Get all completed payments
  const completed = await sdk.call(new GetPayments({
    query: {
      'status[]': ['COMPLETED'],
      'order[createdAt]': 'desc'
    }
  }));

  console.log(`Total completed: ${completed.pagination.totalItems}`);
}

许可证

麻省理工学院

人工用餐凭单和财务控制

CreatePaymentConfigTicket 创建一个手动的,仅Hub的POS配置. 阅读曝光 availableChannels 财务报告和审定财务报表 execution。 。 。 . platform 只有证据,不能作为 POS 配置启用。 付款内容包括: management, (中文(简体) ), collectingPlatform,以及 ticketProvider;呼叫者必须尊重服务器接收能力,而不是从方法推断控制.

顺序 paymentSummary 包含原始供资部分和明显不完整的报告证据。 已支付/应退还的净额仍然来自API。 通过记录的机票报销 RecordOrderReceipt 或离线结算输入 confirmedOutsideSystem: true 还有参考文献 电子商务配置通过明确选择符合条件的 POS 配置 IRI UpdateIntegrationEcommerce。 。 。 .

版本与发布记录

@deliverart/sdk-js-payment 共发布 321 个版本,首次发布于 2025/06/30;过去 12 个月发布了 231 个版本。

版本发布日期距今
3.0.1latest2026/11/111 天前
3.0.02026/11/092 天前
3.0.0-dev.1dev2026/11/092 天前
2.48.12026/10/2518 天前
2.48.02026/10/2319 天前
2.47.02026/10/2319 天前

关于 @deliverart/sdk-js-payment 的常见问题

@deliverart/sdk-js-payment 是什么?

为支付管理交付JavaScript SDK

如何安装 @deliverart/sdk-js-payment?

在项目目录运行 npm install @deliverart/sdk-js-payment,或使用 pnpm add / yarn add / bun add。

@deliverart/sdk-js-payment 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@deliverart/sdk-js-payment 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@deliverart/sdk-js-payment 可以商用吗?

@deliverart/sdk-js-payment 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@deliverart/sdk-js-payment 的下载量有多少?

根据 npm 官方下载统计,@deliverart/sdk-js-payment 在 2026/10/12 – 2026/11/10 这 30 天内被下载 4,165 次,日均约 139 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@deliverart/sdk-js-payment 还在维护吗?

最新版本 3.0.1 发布于 2026/11/11(1 天前);至今共发布 321 个版本,其中过去 12 个月发布了 231 个;首次发布于 2025/06/30。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。