支払い方法の設定

決済画面に表示する支払い方法をアカウント単位で制御する

Payment Method Configuration (支払い方法の設定)APIは、決済画面に表示する支払い方法をアカウント単位で制御する仕組みです。

カードは審査状況などに応じて自動的に表示されます。それ以外の支払い手段は、ダッシュボードの設定画面または API から表示可否を変更できます。設定はテストモードとライブモードでそれぞれ独立しています。

表示設定

各支払い方法には、表示設定として preference を指定します。指定できる値は次の 3 つです。

preference	意味
`on`	この支払い方法を決済画面に表示する
`off`	この支払い方法を決済画面に表示しない
`none`	明示的に設定せずデフォルトに従う

ダッシュボードの設定画面では、none は「選択してください」と表示されます。

「none（選択してください）」は「off」ではありません

none に設定されている決済手段は条件により決済画面に表示されることもあります。非表示にしたい場合は off を選択してください。

決済画面に表示されるかどうかの決まり方

支払い方法が決済画面に表示されるかどうかは、次の 2 つで決まります。

設定値 preference
審査状況などの結果によってその支払い方法が利用できる状態かどうか

preference	表示されるか
`off`	必ず非表示
`on` / `none`	利用できる状態なら表示、そうでなければ非表示

具体例

支払い方法	preference	利用できる状態かどうか	表示されるか
PayPay	`off`	利用できる	非表示
PayPay	`none`	利用できる	表示される
PayPay	`on`	利用できない	非表示
Apple Pay	`none`	利用できる	表示される

利用できる状態かどうかの条件は、支払い方法ごとに異なります。

支払い方法	利用できる状態の条件
カード Apple Pay	利用できるカードブランドが 1 つ以上ある Apple Pay で使えるブランドは Visa・Mastercard・JCBです
PayPay	アカウントで PayPay を利用できる状態である

テストモードでは利用できる状態かどうかを判定しません

テストモードでは off 以外はすべて表示されます。

API レスポンスでの確認

API のレスポンスには、設定値に加えて判定結果が含まれます。

フィールド	説明
`display_preference.preference`	設定した値（`on` / `off` / `none`）
`display_preference.value`	`preference` と利用できる状態から最終的に決まる値（`on` / `off`）
`available`	決済画面に表示されるかどうか。`value` が `on` のとき `true` になる

カードの表示設定

カードの表示可否は自動的に判定されます。preference を off にして非表示にすることはできません。

ダッシュボードで設定する

支払い方法の設定はダッシュボードから変更できます。

ダッシュボードの「API 設定」を開きます。
「決済手段の表示設定（API v2）」セクションに、支払い方法とモードの組み合わせごとに設定項目が表示されます。
それぞれ「ON」「OFF」「選択してください」のいずれかを選び、保存します。

利用できる状態の支払い方法を「ON」にすると決済画面に表示されます。「ON」にしても表示されない場合は、「本番環境の利用申請」から審査状況をご確認ください。

API で設定を変更する

支払い方法の設定は API からも取得・更新できます。

設定を取得する

curl https://api.pay.jp/v2/payment_method_configurations/pmc_xxxxx \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンス例

{
  "object": "payment_method_configuration",
  "id": "pmc_xxxxx",
  "livemode": true,
  "active": true,
  "name": "Default Configuration",
  "card": {
    "available": true,
    "display_preference": { "preference": "none", "value": "on" }
  },
  "paypay": {
    "available": false,
    "display_preference": { "preference": "off", "value": "off" }
  },
  "apple_pay": {
    "available": true,
    "display_preference": { "preference": "none", "value": "on" }
  }
}

設定を更新する

更新したい支払い方法の display_preference.preference を指定します。指定しなかった支払い方法の設定は変更されません。

curl https://api.pay.jp/v2/payment_method_configurations/pmc_xxxxx \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "paypay": { "display_preference": { "preference": "on" } },
    "apple_pay": { "display_preference": { "preference": "off" } }
  }'