支払方法取得

GET

/payment_methods/{payment_method_id}

サンドボックス
本番

支払方法を取得します。

対象プラン

スタンダード
プレミアム
プレミアムプラス
フードビジネス
リテールビジネス

Authorizations

AppAccessToken
pos.transactions:read
UserAccessToken
pos.transactions:read

Parameters

Path Parameters

payment_method_id

required

string

支払方法ID
※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で取扱いしている支払方法IDを指定してください。

Query Parameters

fields

array

検索パラメータ（カンマ区切りで指定可）
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可

with_stores

string

default: none

Allowed values: all none

支払方法取扱店舗を付加するか(付加する場合はall, しない場合はnone)

Responses

200

取得成功

Array<object>

object

paymentMethodId

支払方法ID：各支払方法に紐づくID。

string

paymentMethodCode

支払方法コード：半角英数記号20文字以内。

string

paymentMethodName

支払方法名：支払方法名。85文字以内。

string

unitPrice

単価：商品券のように1枚あたりの価格が決まっている場合に設定。
(例：商品券1枚が500円の場合、500)

string

displayFlag

表示フラグ：端末で表示するかを設定。（0:表示しない、1:表示する）

string

displaySequence

表示番号

string

changeFlag

釣銭フラグ：釣銭の有無を設定。（0:釣銭なし、1:釣銭あり）

string

paymentMethodGroupId

支払方法分類ID：[管理画面->設定->販売設定->支払方法分類] から確認できる支払方法分類のIDを指定。

string

securitiesFlag

有価証券フラグ：有価証券であるかを設定。（0:有価証券ではない、1:有価証券である）

string

pointGivingUnitPrice

ポイント付与単位(金額)：ポイント付与の設定 m円につきnポイントの「m円」の部分。（設定範囲1円～99999円)
（例10円ごとに2ポイントの場合、10円）
※ポイント付与が重複で設定されている場合、適用される優先度は【カード会社＞支払方法＞会員＞会員ランク＞店舗】の順。

string

pointGivingUnit

ポイント付与単位(ポイント)：ポイント付与の設定 m円につきnポイントの「nポイント」の部分（設定範囲0.00ポイント～99999.99ポイント)
（例10円ごとに0.2ポイントの場合、0.2ポイント）

string

insDateTime

作成日時：登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

updDateTime

更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

stores

支払方法取扱店舗

object

paymentMethodId

支払方法ID

string

storeId

店舗ID

string

assignDivision

取扱区分：この支払方法を取扱うかを設定。（0:取扱う、1:取扱わない）

string

Example

[
  {
    "paymentMethodId": "string",
    "paymentMethodCode": "string",
    "paymentMethodName": "string",
    "unitPrice": "string",
    "displayFlag": "string",
    "displaySequence": "string",
    "changeFlag": "string",
    "paymentMethodGroupId": "string",
    "securitiesFlag": "string",
    "pointGivingUnitPrice": "string",
    "pointGivingUnit": "string",
    "insDateTime": "string",
    "updDateTime": "string",
    "stores": {
      "paymentMethodId": "string",
      "storeId": "string",
      "assignDivision": "string"
    }
  }
]