支払い方法の一覧

GET /payments

システムに設定された支払い方法の一覧を取得するには、/api/paymentsに対してGETを送信します。

リクエスト:ヘッダー

Name
Value

Content-Type

application/json

Authorization

Basic <認証情報>

認証情報について

認証情報は、ユーザーのEメールアドレスとAPIキーをコロンで連結したものをBase64エンコードしたものです。

クエリ パラメータ

Name
Type
説明
デフォルト値

page

integer

ページ番号

1

items_per_page

integer

1ページあたりの表示数

10

レスポンス

{
  "payments": [
    {
      "payment_id": "1",
      "company_id": "1",
      "usergroup_ids": "0",
      "position": "10",
      "status": "A",
      "template": "views/orders/components/payments/cc.tpl",
      "processor_id": "0",
      "processor_params": "",
      "a_surcharge": "0.000",
      "p_surcharge": "0.000",
      "tax_ids": "",
      "localization": "",
      "payment_category": "tab3",
      "payment": "クレジットカード",
      "description": "ビザ、マスターカードなど",
      "instructions": "<p>この支払方法に関する指示を入力してください</p>",
      "surcharge_title": "",
      "lang_code": "ja",
      "processor_status": "A",
      "processor_type": null
    },
    {
      "payment_id": "2",
      "company_id": "1",
      "usergroup_ids": "0",
      "position": "20",
      "status": "D",
      "template": "views/orders/components/payments/phone.tpl",
      "processor_id": "0",
      "processor_params": "",
      "a_surcharge": "0.000",
      "p_surcharge": "0.000",
      "tax_ids": "",
      "localization": "",
      "payment_category": "tab3",
      "payment": "電話注文",
      "description": "ご注文用電話番号: 5555555",
      "instructions": "<p>この支払方法に関する指示を入力してください</p>",
      "surcharge_title": "",
      "lang_code": "ja",
      "processor_status": "A",
      "processor_type": null
    },
    {
      "payment_id": "12",
      "company_id": "0",
      "usergroup_ids": "0",
      "position": "20",
      "status": "A",
      "template": "views/orders/components/payments/cc_outside.tpl",
      "processor_id": "0",
      "processor_params": "",
      "a_surcharge": "0.000",
      "p_surcharge": "0.000",
      "tax_ids": "",
      "localization": "",
      "payment_category": "tab3",
      "payment": "銀行振込",
      "description": "",
      "instructions": null,
      "surcharge_title": "",
      "lang_code": "ja",
      "processor_status": "A",
      "processor_type": null
    }
  ],
  "params": {
    "items_per_page": "10",
    "page": 1,
    "total_items": 4
  }
}

最終更新