個別アプリ専用支払方法一覧取得

GET

/app_payment_methods

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/app_payment_methods';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/app_payment_methods \
  --header 'Authorization: Bearer <token>'

クライアントIDに紐づく個別アプリ専用支払方法の一覧を取得します。

※現状、返却される支払方法は最大3つです。

対象プラン

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

Authorizations

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

Parameters

Query Parameters

fields

array

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

sort

string

並び順（カンマ区切りで指定可）

指定可能なパラメータ

paymentMethodId：個別アプリ専用支払方法ID

limit

integer

上限数

page

integer

ページ

payment_method_id

string

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

Responses

200

取得成功

application/json

Array<object>

0 <= 3 items

object

paymentMethodId

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

string

paymentMethodName

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

string

Example

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