支払方法登録

Authorizations

AppAccessToken
pos.transactions:write
UserAccessToken
pos.transactions:write

Request Body

object

paymentMethodCode

支払方法コード

ユニーク値

string

<= 20 characters /^[ -~]+$/

paymentMethodName

required

支払方法名

string

<= 20 characters

unitPrice

単価

string format: int

>= 1 <= 99999999

displayFlag

表示フラグ

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

string

default: 1

Allowed values: 0 1

displaySequence

表示番号

string format: int

>= 1 <= 999999999

changeFlag

釣銭フラグ

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

string

default: 1

Allowed values: 0 1

paymentMethodGroupId

支払方法分類ID

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

string format: int

>= 1 <= 999999999

securitiesFlag

有価証券フラグ

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

string

default: 1

Allowed values: 0 1

pointGivingUnitPrice

ポイント付与単位(金額)

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

string format: int

>= 1 <= 99999

pointGivingUnit

ポイント付与単位(ポイント)

ポイント付与の設定 m円につきnポイントの「nポイント」の部分（設定範囲0.00ポイント～99999.99ポイント)
（例10円ごとに0.2ポイントの場合、0.2ポイント）
※ポイント付与単位(金額)を指定した場合、必須。

string format: decimal

<= 99999.99

stores

支払方法取扱店舗

Array<object>

object

storeId

required

店舗ID

string format: int

assignDivision

required

取扱区分

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

string

0

Allowed values: 0 1

Example

{
  "paymentMethodCode": "string",
  "paymentMethodName": "string",
  "unitPrice": "12345678",
  "displayFlag": "0",
  "displaySequence": "123456789",
  "changeFlag": "0",
  "paymentMethodGroupId": "123456789",
  "securitiesFlag": "0",
  "pointGivingUnitPrice": "12345",
  "pointGivingUnit": "99999.99",
  "stores": [
    {
      "storeId": "1",
      "assignDivision": "0"
    }
  ]
}

200

更新成功

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"
  }
}

400

ポイント付与単位(金額)とポイント付与単位(ポイント)のどちらか片方のみが指定されている場合
支払方法コードが重複している場合
指定された店舗IDが存在しない場合
指定された支払方法分類が存在しない場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "ポイント付与単位(金額)とポイント付与単位(ポイント)は、指定する場合は両方を指定して下さい。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "既に登録されている支払方法コードです。(支払方法ID-{支払方法ID}:支払方法コード-{支払方法コード})",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定された店舗が見つかりません",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定された支払方法分類が見つかりません",
  "status": 400
}

支払方法登録

対象プラン

Authorizations

Request Body

Example

Responses

200

Example

400

Examples