支払方法一覧取得

GET

/payments

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/ec-b2b/payments?limit=10&page=1&name=%E8%AB%8B%E6%B1%82%E6%9B%B8%E6%89%95%E3%81%84&payment_code=10&is_usage=true';
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-b2b/payments?limit=10&page=1&name=%E8%AB%8B%E6%B1%82%E6%9B%B8%E6%89%95%E3%81%84&payment_code=10&is_usage=true' \
  --header 'Authorization: Bearer <token>'

支払方法の一覧を取得します。

Authorizations

AppAccessToken
ec-b2b.payments:read

Parameters

Query Parameters

limit

integer

default: 10 >= 1 <= 100

取得件数

page

integer

default: 1 >= 1

ページ

name

string

<= 50 characters

名前で絞り込み

Example

請求書払い

payment_code

integer

支払コードで絞り込み

Example

is_usage

boolean

利用中フラグで絞り込み

Example

true

Responses

200

取得成功

application/json

Array

PaymentResponse

object

支払方法ID

string format: uuid

name

名前

string

<= 50 characters

displayName

表示名

string

<= 50 characters

paymentCode

支払コード

integer

isUsage

利用中フラグ

true: 利用中
false: 未利用

boolean

Examples

default

[
  {
    "id": "12345678-1234-1234-1234-1234567890ab",
    "name": "請求書払い",
    "displayName": "請求書払い",
    "paymentCode": 10,
    "isUsage": true
  },
  {
    "id": "12345678-1234-1234-1234-1234567890cd",
    "name": "クレジットカード決済",
    "displayName": "クレジットカード決済",
    "paymentCode": 20,
    "isUsage": false
  },
  {
    "id": "12345678-1234-1234-1234-1234567890ef",
    "name": "代金引換",
    "displayName": "代金引換",
    "paymentCode": 40,
    "isUsage": false
  }
]

Headers

Link

string

<前ページURI>; rel="prev", <次ページURI>; rel="next"

400

入力チェックエラーの場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "request_json:[limit]は100以下の数字を指定してください。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "request_json:[page]は1以上の数字を指定してください。",
  "status": 400
}