跳转到主要内容
你可以为任何交易添加备注类别和/或附件(例如收据、发票、采购订单)。可以在原始交易发生时添加注释,或之后通过 updateTransactionMetadata mutation 进行更新。 支持注释的场景:
  • 存款(depositCashBalance1
  • 礼品卡购买(purchaseGiftCard
  • 钱包转账(createTransfer, transferInternalBalance
  • 虚拟卡创建(createVirtualCard
    • 不支持 attachment

工作原理

  1. 可选:如果你想附加文件,先通过 REST 上传端点上传。你会获得一个 attachmentId
  2. memotransactionCategory 和/或 attachmentId 传入你的 mutation 输入中——可在交易发生时传入,或之后通过 updateTransactionMetadata 传入。
  3. 通过 getTransactionsgetUserPurchases 或 mutation 响应读取注释。attachmentUrl 字段会返回一个短期有效的签名 URL 用于文件访问。

第 1 步:上传附件(可选)

这是一个 REST 端点,而不是 GraphQL mutation

端点

POST /api/v1/file-upload/transaction-memo-attachment

认证

Authorization: Bearer <YOUR_USER_ACCESS_TOKEN>

请求

multipart/form-data 发送文件,字段名为 file 接受类型: application/pdf, image/png
⚠️ 交易附件不接受 JPEG。

示例请求

响应

复制该 attachmentId —— 你将在下一步将其传入 mutation 输入中。
attachmentId 的作用域限定在你的账户内。当你提交 mutation 时,系统会验证该文件是否存在于你账户的存储中。来自其他账户的 ID 将被拒绝。

上传错误


第 2 步:为交易添加注释

你可以在原始交易发生时提供注释,在之后进行更新。

选项 A — 交易发生时

以下 mutations 在其输入中接受可选字段 memotransactionCategoryattachmentId
  • depositCashBalanceDepositCashBalanceInput
  • purchaseGiftCardPurchaseGiftCardInput
  • createTransferCreateTransferInput
  • transferInternalBalanceTransferInternalBalanceInput

注释字段

示例 — 带注释的礼品卡购买


选项 B — 交易之后(updateTransactionMetadata

使用此 mutation 为任意已有交易添加或更新注释。
部分更新语义:只会更新你传入的字段。未包含的字段保持不变。传入 null 可清空字段。

Mutation

UpdateTransactionMetadataInput

必需的作用域

LIST_PAYMENTLIST_PURCHASES

示例 — 添加备注和类别

示例 — 为现有交易附加文件

示例 — 清空备注

示例响应

错误


读取注释

以下接口会返回注释:
⚠️ attachmentUrl 是签名 URL,生成后会很快过期。请不要存储它——当你需要显示或访问文件时重新获取该交易。