支払方法取得

GET

/payments/{payment_id}

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-oms/payments/example?fields=paymentId%2CpaymentMethod';
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/ec-oms/payments/example?fields=paymentId%2CpaymentMethod' \
  --header 'Authorization: Bearer <token>'

支払方法を取得します。

Authorizations

AppAccessToken
ec-oms.payments:read

Parameters

Path Parameters

payment_id

required

string

>= 1 characters

支払方法ID

Query Parameters

fields

Array<string>

>= 1 items unique items

Allowed values: paymentId paymentMethod

取得するフィールドをカンマ区切りで指定します。指定がない場合すべてのフィールドを取得します。

Example

?fields=paymentId,paymentMethod

Responses

200

取得成功

application/json

Payment

object

paymentId

支払方法ID

string

>= 1 characters <= 9 characters

paymentMethod

支払方法名

string

>= 1 characters <= 50 characters

Examples

default

{
  "paymentId": "1",
  "paymentMethod": "テスト支払方法"
}

400

Fieldsに指定外の値が設定されている場合

application/json

object

type

required

string

title

required

string

detail

One of:

string
Array<string>

string

status

integer

Examples

fieldsに指定外の値が設定されている場合

{
  "type": "about:blank",
  "title": "BadRequest",
  "detail": "指定されたfields項目が不正です: {invalid_field}",
  "status": 400
}

404

指定されたIDのリソースが存在しない場合

application/json

object

type

required

string

title

required

string

detail

One of:

string
Array<string>

string

status

integer

Examples

指定したリソースが存在しない場合

{
  "type": "about:blank",
  "title": "NotFound",
  "detail": "指定されたIDのリソースが見つかりません",
  "status": 404
}

500

サーバー内部エラー

application/json

object

type

required

string

title

required

string

detail

One of:

string
Array<string>

string

status

integer

Examples

default

{
  "type": "about:blank",
  "title": "InternalServerError",
  "status": 500
}