個別アプリ専用支払方法登録

POST

/app_payment_methods

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/app_payment_methods';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"paymentMethodName":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/app_payment_methods \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "paymentMethodName": "string" }'

個別アプリ専用支払方法を登録します。

クライアントIDに基づいて、契約毎に一意な支払方法IDを発行します。

※ 本APIで発行される支払方法IDは、取引登録APIでキャッシュレス決済時の伝票番号・金種・クレジットカード会社のデータを登録する場合に使用します。

※ 非有価証券・釣銭なしの支払方法として登録されます。

※ クライアントIDごとに登録可能な支払方法は最大3つです。

対象プラン

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

Authorizations

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

Request Body

application/json

object

paymentMethodName

required

個別アプリ専用支払方法名

string

<= 20 characters

Example

{
  "paymentMethodName": "string"
}

Responses

200

更新成功

application/json

object

paymentMethodId

個別アプリ専用支払方法ID：クライアントIDに紐づく、契約毎に一意な支払方法ID

string

paymentMethodName

個別アプリ専用支払方法名

string

Example

{
  "paymentMethodId": "string",
  "paymentMethodName": "string"
}

403

同一クライアントIDに紐づく個別アプリ専用支払方法の登録上限数を超えてしまう場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

同一クライアントIDに紐づく個別アプリ専用支払方法の登録上限数を超えてしまう場合

{
  "type": "about:blank",
  "title": "Forbidden",
  "detail": "同一クライアントIDに紐づく個別アプリ専用支払方法の登録件数の上限をオーバーしたため、登録できません。",
  "status": 403
}