ステップ1：アカウントの作成

プラットフォームアカウントはJammチームが作成します。開始するには、以下の情報をご提供ください：

プラットフォーム名
連絡先メールアドレス
入金モードの希望：一括入金（PLATFORM）またはダイレクト（MERCHANT）— 入金モードの詳細については、Payout Guideを参照してください。
入金スケジュールの希望：月次（EVERY_MONTH）または月2回（TWICE_PER_MONTH）
銀行口座情報（一括入金モードの場合は必須）：
- 銀行番号
支店番号
口座番号
預金種別
受取人名

Jammがプラットフォームアカウントを作成し、プラットフォームID（plt-*）を発行します。

ステップ2：加盟店の連携

加盟店の代理として操作を行うには、事前に加盟店をプラットフォームに連携する必要があります。

加盟店をオンボーディングするには、加盟店ごとに1行のCSV/Excelシートを作成し、Jamm Opsチームと共有してください。

Jammが加盟店アカウントを作成し、プラットフォームに連携します。

加盟店のステータスが APPROVED になると、その加盟店の代理としてAPIコールが行えるようになります。プラットフォームの設定によっては、新規加盟店の有効化前にJammチームによる審査・承認が必要な場合があります。

CSVテンプレート

name,email,phone,platform_merchant_webhook_url,bank_number,branch_number,account_number,deposit_type,recipient_name
Sample Shop One,owner1@example.com,09011112222,,,,,,
Sample Shop Two,owner2@example.com,09011112223,https://example.com/webhook,0001,001,1234567,普通,サンプル ショップ

カラム一覧

カラム	必須	備考
`name`	はい	加盟店の表示名
`email`	はい	有効なメールアドレス。各行ユニーク
`phone`	はい	例：`09011112222`
`platform_merchant_webhook_url`	いいえ	加盟店の請求イベントを受信するWebhook URL。複数の加盟店で同じURLを使用可能
`bank_number`	ダイレクトモードのみ	銀行コード（例：9999）
`branch_number`	ダイレクトモードのみ	支店コード（例：001）
`account_number`	ダイレクトモードのみ	口座番号
`deposit_type`	ダイレクトモードのみ	`普通`または`当座`
`recipient_name`	ダイレクトモードのみ	口座名義人

銀行口座カラムは、プラットフォームがダイレクト（MERCHANT**）**入金モードを使用する場合のみ必要です — 一括入金（PLATFORM）モードでは、ステップ1で設定したプラットフォームの銀行口座に入金されるため、加盟店ごとの銀行情報は不要です。提供する場合、5つの銀行口座カラムすべてを入力する必要があります（全部または無し）。

APIによる加盟店の自動オンボーディングは近日公開予定です。

ステップ3：認証情報の受け取り

Jammがプラットフォーム用の認証情報を発行します。以下を受け取ります：

クライアントID
クライアントシークレット

環境ごとに別々の認証情報が発行されます。認証情報、データ、Webhook設定は各環境間で完全に分離されています。

	ステージング	本番
用途	開発・テスト	本番運用
ダッシュボード	https://dashboard.staging.jamm-pay.jp	https://dashboard.jamm-pay.jp
認証情報	ステージング専用クライアントID / シークレット	本番専用クライアントID / シークレット
データ	テストデータのみ。実際の入出金は発生しません。	実データ。実際の資金移動が発生します。

認証情報は安全に管理してください。クライアントサイドのコードには絶対に含めないでください。

ステップ4：インストールと設定

SDKの使用（TypeScript / Node.js）

Jamm Node SDKをインストールします：

npm install @jamm-pay/node-sdk

認証情報を使って初期化します。platform: true フラグは、（単一の加盟店ではなく）プラットフォームとして認証することをSDKに伝えます：

import jamm from "@jamm-pay/node-sdk";

jamm.config.init({
  clientId: process.env.JAMM_CLIENT_ID,
  clientSecret: process.env.JAMM_CLIENT_SECRET,
  environment: process.env.JAMM_ENVIRONMENT as "staging" | "prod",
  platform: true,
});

# .env（ステージング）
JAMM_CLIENT_ID=your-staging-client-id
JAMM_CLIENT_SECRET=your-staging-client-secret
JAMM_ENVIRONMENT=staging

SDKが認証（トークンの交換と更新）を自動で処理します。

ステップ5：最初の決済を行う

オンセッション決済

顧客はJammがホストする決済ページにリダイレクトされ、決済の完了および/または将来の引き落としへの同意を行います。

SDKの使用

merchant オプションで、代理として操作する加盟店を指定します：

const result = await jamm.payment.onSessionPayment({
  buyer: {
    email: "customer@example.com",
  },
  charge: {
    price: 10000,
    description: "注文 #1234",
    platform_fee: 500,   // 任意 — 下記の注意事項を参照
    metadata: {},        // 任意のキーと値のペア（独自の管理用）
  },
  redirect: {
    successUrl: "<https://yoursite.com/success>",
    failureUrl: "<https://yoursite.com/failure>",
  },
  merchant: "mer-abc123",
});

// 決済完了のために顧客をリダイレクト
const paymentUrl = result.data?.paymentLink?.url;

// 今後の請求のために顧客IDを保存
const customerId = result.data?.customer?.id; // "cus-..."

成功すると payment_link.url が返されます — 顧客をそこにリダイレクトして決済を完了させてください。

注意： リクエストの buyer フィールドは顧客レコードを作成または照合します。顧客ID（cus-*）は今後の利用のためにレスポンスで返されます。

platform_fee** は任意です。** ダイレクト入金モード（MERCHANT）でのみ有効であり、加盟店の入金から控除される金額を制御します。一括入金モード（PLATFORM）では省略可能です。独自の記録管理のためにメタデータとして提供することもできます。詳細については、Platform Overviewのプラットフォーム手数料を参照してください。

ステップ6：Webhookの設定

Jammは決済イベントの通知を、指定されたWebhook URL（ステージングと本番は別々）に送信します。

SDKの使用

import jamm from "@jamm-pay/node-sdk";

// Webhookシークレットを使用してWebhook署名を検証
jamm.webhook.verify({
  data: body,
  signature: request.headers.get("jamm-signature"),
});

// イベントをパース
const event = jamm.webhook.parse({ data: body });

if (jamm.types.eventTypeEquals(jamm.types.EventType.CHARGE_SUCCESS, event.eventType)) {
  // 決済成功 — 注文を処理する
}

イベントタイプ

イベント	説明
`CHARGE_CREATED`	新しい請求が作成されました
`CHARGE_UPDATED`	請求ステータスが更新されました
`CHARGE_SUCCESS`	決済が成功しました — 注文を処理してください
`CHARGE_FAIL`	決済が失敗しました
`REFUND_SUCCEEDED`	返金が正常に完了しました
`REFUND_FAILED`	返金が失敗しました
`CONTRACT_ACTIVATED`	顧客がオフセッション決済の準備が整いました
`USER_ACCOUNT_DELETED`	顧客が無効化されました

本番稼働前チェックリスト

本番稼働前に以下を確認してください：

プラットフォームアカウントが作成され、有効化されている
すべての加盟店が連携されている
本番認証情報で認証が正常に動作する
すべてのリクエストに加盟店IDが正しく設定されている（SDKの merchant オプション）
各請求に platform_fee が設定されている（ダイレクト入金モードを使用する場合）
決済フローがエンドツーエンドでテスト済み（決済作成、顧客による完了、Webhook受信）
返金フローがテスト済み（全額および部分返金）
Webhookエンドポイントが設定され、両環境でイベントを受信している
Webhook署名検証が正常に動作している
入金用銀行口座情報がJammチームと確認済み

近日公開予定

セルフサービス加盟店オンボーディング — Jammチームに連絡せず、APIで加盟店を追加
審査付きオンボーディング — Jammが各加盟店を有効化前に審査する必要があるプラットフォーム向け
プラットフォームダッシュボード — 加盟店の管理、取引の確認、入金レポートのダウンロード

関連ドキュメント