跳轉到主要內容
你可以為任何交易新增備註類別,以及/或附件(例如收據、發票、採購單)。註記可在原始交易時加入,或之後使用 updateTransactionMetadata mutation 進行更新。 支援註記的類型:
  • 存款(depositCashBalance1
  • 禮品卡購買(purchaseGiftCard
  • 錢包轉帳(createTransfer, transferInternalBalance
  • 虛擬卡建立(createVirtualCard
    • 不支援 attachment

運作方式

  1. 選用:若你想附加檔案,先透過 REST 上傳端點上傳。你會收到一個 attachmentId
  2. 在 mutation 的 input 中傳入 memotransactionCategory,以及/或 attachmentId——可以在交易發生時傳入,或之後透過 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 input 中使用它。
attachmentId 會限制在你的帳戶範圍內。當你提交 mutation 時,系統會驗證該檔案是否存在於你的帳戶儲存空間中。來自其他帳戶的 ID 會被拒絕。

上傳錯誤


第 2 步:為交易加上註記

你可以在原始交易發生時提供註記,或是之後再更新。

選項 A — 在交易發生時

以下 mutations 的 input 接受 memotransactionCategory,以及 attachmentId 作為選填欄位:
  • depositCashBalanceDepositCashBalanceInput
  • purchaseGiftCardPurchaseGiftCardInput
  • createTransferCreateTransferInput
  • transferInternalBalanceTransferInternalBalanceInput

註記欄位

範例 — 購買禮品卡並加上註記


選項 B — 交易後(updateTransactionMetadata

使用此 mutation 為任何現有交易新增或更新註記。
部分更新語意:只有你包含的欄位會被更新。省略的欄位維持不變。傳入 null 可清除欄位值。

Mutation

UpdateTransactionMetadataInput

必要 Scopes

LIST_PAYMENTLIST_PURCHASES

範例 — 新增備註與類別

範例 — 將檔案附加至現有交易

範例 — 清除備註

範例回應

錯誤


讀取註記

以下會回傳註記:
⚠️ attachmentUrl 是簽名 URL,會在產生後不久過期。請勿儲存它——當你需要顯示或存取檔案時,重新抓取該交易資料。