Documentation Index
Fetch the complete documentation index at: https://waffo.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
決済手段フィルタリング
payMethodType と payMethodName を使用して、Cashier に表示する決済手段を制御します。
決済手段ごとの特例や App WebView / iframe の制限については、Payment method integration notes を参照してください。
推奨パラメータの組み合わせ
| シナリオ | payMethodType | payMethodName | payMethodCountry | 備考 |
|---|
| Cashier 内でユーザーが選択（推奨） | 省略 | 省略 | 省略 | 利用可能なすべての決済手段を表示し、ユーザーに選択させる |
| カード決済 | "CREDITCARD,DEBITCARD" | 省略 | 省略 | クレジット/デビットカード両対応。Waffo が BIN からカードブランド（Visa/Mastercard）を自動判別し、ユーザーの手間を軽減 |
| クレジットカードのみ | "CREDITCARD" | 省略 | 省略 | クレジットカードのみ表示 |
| VA（仮想口座） | "VA" | 省略 | 必要に応じて渡す | Cashier 内でユーザーが具体的な銀行を選択 |
| 特定のウォレット | 対応する種別 | 対応する名前 | 必要に応じて渡す | 例："EWALLET" + "DANA" |
// Best practice: card payments (credit + debit, Visa + Mastercard)
{
"paymentInfo": {
"productName": "ONE_TIME_PAYMENT",
"payMethodType": "CREDITCARD,DEBITCARD"
}
}
payMethodCountry を渡すタイミング
Cashier で特定の国の決済手段のみを表示したい場合に、このフィールドを渡します。
- 省略：加盟店契約に基づく、すべての国で利用可能な決済手段を表示します。
- 指定：指定した国の決済手段のみ表示します。
// Show Indonesian payment methods only
{
"paymentInfo": {
"productName": "ONE_TIME_PAYMENT",
"payMethodCountry": "IDN"
}
}
グローバルカード（CREDITCARD/DEBITCARD）には payMethodCountry を渡さないでください。グローバルカードは特定の国に属しません。
多通貨対応
加盟店の価格通貨とユーザーの決済通貨が異なる場合（クロスカレンシー注文）：
{
"orderCurrency": "USD",
"orderAmount": "10.00"
}
userCurrency は省略可能です。Waffo が自動的に為替変換を処理し、ユーザーには Cashier 上で現地通貨の金額が表示されます。
言語設定
paymentInfo.cashierLanguage を使用して Cashier の表示言語を設定します（IETF BCP 47 形式）：
{
"paymentInfo": {
"productName": "ONE_TIME_PAYMENT",
"cashierLanguage": "en-HK"
}
}
| 言語コード | 言語 | 適用通貨 | 適用国 |
|---|
en | 英語 | すべての通貨 | すべての国（既定のフォールバック） |
id-ID | インドネシア語 | IDR | インドネシア |
vi-VN | ベトナム語 | VND | ベトナム |
pt-BR | ポルトガル語（ブラジル） | BRL | ブラジル |
es-MX | スペイン語（メキシコ） | MXN | メキシコ |
es-PE | スペイン語（ペルー） | PEN | ペルー |
es-CO | スペイン語（コロンビア） | COP | コロンビア |
es-CL | スペイン語（チリ） | CLP | チリ |
ru-RU | ロシア語 | RUB | ロシア |
en-KE | 英語（ケニア） | KES | ケニア |
zh-Hant-TW | 繁体字中国語（台湾） | TWD | 台湾 |
zh-Hant-HK | 繁体字中国語（香港） | HKD | 香港 |
自動選択ロジック
cashierLanguage を指定しない場合、Waffo は以下の優先順位で自動的に言語を選択します：
- ユーザーの国でマッチング（例：ユーザーの国が IDN →
id-ID）
- 注文通貨でマッチング（例：通貨が BRL →
pt-BR）
- マッチしない場合 →
en にフォールバック
注意事項
- 言語は通貨/国と一致する必要があります。例えば
IDR 通貨の注文では id-ID または en のみ使用可能で、pt-BR を指定するとエラーコード A0026 が返されます。
en は汎用言語であり、すべての通貨と国で使用できます。- 上記の表に記載されていない通貨（例：
USD、EUR、SGD）は en のみサポートされます。
サポート外の言語はエラーコード A0026 を返します。
テーマカスタマイズ
Cashier のカラー、フォント、スタイルをブランドに合わせてカスタマイズできます。
3 つの設定方法
| 方法 | 優先度 | 説明 |
|---|
| API パラメータ（トランザクション単位） | 最高 | paymentInfo.cashierAppearance 経由で渡す。トランザクションごとに変更可能 |
| Merchant Portal（グローバル） | 中 | Merchant Portal でグローバルな既定テーマを設定 |
| SDK 初期化（クライアント側） | 最低 | フロントエンド SDK の初期化時にテーマ設定を渡す |
cashierAppearance が渡された場合、他のすべての設定を上書きします。
テーマ変数
| 変数 | 説明 | 値の例 |
|---|
colorPrimary | プライマリーカラー（ボタン、リンク、選択状態） | #0570de |
colorBackground | ページ背景色 | #ffffff |
colorText | メインテキストの色 | #30313d |
borderRadius | 角の丸み | 8px |
API パラメータ方式
対応エンドポイント：
POST /api/v1/order/createPOST /api/v1/subscription/create
cashierAppearance フィールドは JSON 文字列（JSON オブジェクトではなく）である必要があり、構造は {"variables": { ... }} です。内部のクォートはエスケープしてください。
{
"paymentInfo": {
"productName": "ONE_TIME_PAYMENT",
"cashierAppearance": "{\"variables\":{\"colorPrimary\":\"#0570de\",\"colorBackground\":\"#ffffff\",\"colorText\":\"#30313d\",\"borderRadius\":\"8px\"}}"
}
}
Merchant Portal での設定
Merchant Portal にログインし、Cashier 設定ページでグローバルな既定テーマを設定します。すべてのトランザクションで統一されたブランドスタイルを共有したい場合に最適な選択肢です。
SDK 初期化
フロントエンド SDK（@waffo/payment-sdk）の初期化時にテーマ設定を渡します。優先度は最低で、API および Merchant Portal のいずれにもテーマ設定がない場合にのみ有効となります。
注文の有効期限
orderExpiredAt を使用して注文の有効期限を設定します（ISO 8601、UTC+0）。
{
"orderExpiredAt": "2026-03-25T11:00:00.000Z"
}
リダイレクト URL
| パラメータ | 説明 |
|---|
successRedirectUrl | 決済成功後のリダイレクト |
failedRedirectUrl | 決済失敗後のリダイレクト |
cancelRedirectUrl | ユーザーが能動的にキャンセルした後のリダイレクト |
リダイレクト URL はユーザー体験を制御するのみで、決済結果を表すものではありません。決済結果の信頼できる情報源は常に Webhook または照会 API を使用してください。
