メインコンテンツへスキップ
支払いの返金をリクエストします。返金は処理前にレビューワークフローを経ます。
POST /v1/actions/refund-ticket/create-ticket
認証: API Key

リクエストボディ

フィールド必須説明
paymentIdstringはい支払い ID(Short ID 形式 PAY_xxx
reasonstringはい返金リクエストの理由
amountstringいいえ一部返金金額の表示形式文字列(例:“15.00”)。全額返金の場合は省略

リクエスト例

// Full refund
const { ticket } = await client.orders.createRefundTicket({
  paymentId: "PAY_6eYCunG3IMmIgcQOnaXdoA",
  reason: "Product did not meet expectations",
});

// Partial refund
const { ticket } = await client.orders.createRefundTicket({
  paymentId: "PAY_6eYCunG3IMmIgcQOnaXdoA",
  reason: "Partial service used",
  amount: "15.00",
});

成功レスポンス (200)

{
  "data": {
    "ticketId": "TKT_8gAEwpI5KOoKieSQL1ZfqC",
    "status": "pending",
    "requestedAmount": "29.00"
  }
}

レスポンスフィールド

フィールド説明
ticketIdstring返金チケット ID(Short ID 形式 TKT_xxx
statusstringチケットステータス(初期値 pending
requestedAmountstring返金金額の表示形式文字列

エラーレスポンス

ステータス説明
400paymentId または reason が欠落しています
400返金期間が過ぎています(単発商品は7日間)
400一部返金金額が元の支払い金額を超えています
401認証失敗
404支払いが見つかりません
500内部サーバーエラー