支払区分情報取得

リクエストURL

ホスト

https://api.next-engine.org

エンドポイント

/api_v1_system_paymentmethod/info

リファレンス内容

情報取得について

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります

情報取得と検索APIの違いは、以下の通りです

情報取得は、対象データを全て取得します（検索条件などの指定が不可能）
情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能）

入力パラメータ

パラメータ	値	省略	備考
`access_token`	access_token取得により取得した値	必須(SDKの場合不要)
`refresh_token`	access_token取得により取得した値	可能(SDKの場合不要)	【指定してaccess_tokenの有効期限が切れた場合】正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます【省略してaccess_tokenの有効期限が切れた場合】出力パラメータ「result」の値がredirectになります（成功時以外の出力パラメータ参照)
`wait_flag`	1:メイン機能過負荷でも可能な限りエラーにせず実行1以外:メイン機能過負荷の場合、003002のエラーを返却	可能(省略時は1以外とする)	詳細はパラメータ共通事項「待機フラグについて」を参照して下さい

出力パラメータ

パラメータ名	値	備考
`result`	`success`	success以外の場合の出力パラメータは成功時以外の出力パラメータ参照
`access_token`	入力パラメータで指定したaccess_token／新たに発行されたaccess_token	有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります
`refresh_token`	入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token	access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります
`access_token_end_date`	入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時
`refresh_token_end_date`	入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時
`count`	検索結果の件数
`data`	検索結果の連想配列(JSONのオブジェクト型)	検索対象の全フィールドを返却します

支払区分

項目名	フィールド名	データ型	備考
支払区分	`payment_method_id`	文字列型
支払名	`payment_method_name`	文字列型
非表示フラグ	`payment_method_deleted_flag`	数値型	1:非表示になっている区分 0:表示されている区分

サンプル

リクエスト

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_system_paymentmethod/info"

レスポンス

{
  "result": "success",
  "count": "47",
  "data": [
    {
      "payment_method_id": "0",
      "payment_method_name": "クレジットカード"
    },
    {
      "payment_method_id": "1",
      "payment_method_name": "代金引換"
    },
    {
      "payment_method_id": "15",
      "payment_method_name": "銀行振込前払い"
    },
    {
      "payment_method_id": "16",
      "payment_method_name": "銀行振込後払い"
    },
    {
      "payment_method_id": "20",
      "payment_method_name": "郵便振替"
    },
    {
      "payment_method_id": "21",
      "payment_method_name": "現金書留"
    },
    {
      "payment_method_id": "51",
      "payment_method_name": "auかんたん決済"
    },
    {
      "payment_method_id": "30",
      "payment_method_name": "まとめてau支払い"
    },
    {
      "payment_method_id": "31",
      "payment_method_name": "モバイルSuica"
    },
    {
      "payment_method_id": "32",
      "payment_method_name": "コンビニ決済"
    },
    {
      "payment_method_id": "33",
      "payment_method_name": "ペイジー決済"
    },
    {
      "payment_method_id": "34",
      "payment_method_name": "NP後払い"
    },
    {
      "payment_method_id": "35",
      "payment_method_name": "ローソン前払"
    },
    {
      "payment_method_id": "36",
      "payment_method_name": "セブンイレブン前払"
    },
    {
      "payment_method_id": "40",
      "payment_method_name": "楽天バンク決済"
    },
    {
      "payment_method_id": "41",
      "payment_method_name": "S!まとめて支払い"
    },
    {
      "payment_method_id": "42",
      "payment_method_name": "ドコモケータイ払い"
    },
    {
      "payment_method_id": "43",
      "payment_method_name": "iD決済"
    },
    {
      "payment_method_id": "44",
      "payment_method_name": "Yahoo!かんたん決済"
    },
    {
      "payment_method_id": "45",
      "payment_method_name": "ウェブマネー決済"
    },
    {
      "payment_method_id": "46",
      "payment_method_name": "楽天銀行"
    },
    {
      "payment_method_id": "47",
      "payment_method_name": "Edy決済 "
    },
    {
      "payment_method_id": "48",
      "payment_method_name": "Amazonペイメント"
    },
    {
      "payment_method_id": "49",
      "payment_method_name": "ジャパンネット銀行"
    },
    {
      "payment_method_id": "50",
      "payment_method_name": "後払い.com"
    },
    {
      "payment_method_id": "52",
      "payment_method_name": "ペイジェント決済"
    },
    {
      "payment_method_id": "53",
      "payment_method_name": "クレジットカード(pg)"
    },
    {
      "payment_method_id": "54",
      "payment_method_name": "コンビニ決済(pg)"
    },
    {
      "payment_method_id": "55",
      "payment_method_name": "銀行ネット決済(pg)"
    },
    {
      "payment_method_id": "56",
      "payment_method_name": "ATM決済(pg)"
    },
    {
      "payment_method_id": "57",
      "payment_method_name": "携帯キャリア決済(pg)"
    },
    {
      "payment_method_id": "58",
      "payment_method_name": "ペーパーレス決済"
    },
    {
      "payment_method_id": "59",
      "payment_method_name": "Qoo10"
    },
    {
      "payment_method_id": "60",
      "payment_method_name": "Paypal"
    },
    {
      "payment_method_id": "61",
      "payment_method_name": "＠払い"
    },
    {
      "payment_method_id": "63",
      "payment_method_name": "ソフトバンクまとめて支払い"
    },
    {
      "payment_method_id": "64",
      "payment_method_name": "アトディーネ"
    },
    {
      "payment_method_id": "65",
      "payment_method_name": "Yahoo!マネー／預金払い"
    },
    {
      "payment_method_id": "66",
      "payment_method_name": "クロネコ代金後払い"
    },
    {
      "payment_method_id": "80",
      "payment_method_name": "前払決済"
    },
    {
      "payment_method_id": "85",
      "payment_method_name": "ポイント全額支払い"
    },
    {
      "payment_method_id": "90",
      "payment_method_name": "サンプル・貸し出し"
    },
    {
      "payment_method_id": "91",
      "payment_method_name": "国際取引決済"
    },
    {
      "payment_method_id": "95",
      "payment_method_name": "掛売"
    },
    {
      "payment_method_id": "96",
      "payment_method_name": "その他"
    },
    {
      "payment_method_id": "70",
      "payment_method_name": "その他２"
    },
    {
      "payment_method_id": "99",
      "payment_method_name": "支払済"
    }
  ],
  "access_token": "xxxxxxxxxxx",
  "access_token_end_date": "2017-04-13 18:24:53",
  "refresh_token": "xxxxxxxxxxx",
  "refresh_token_end_date": "2017-04-15 18:24:53"
}

エラー

エラーコード

エンドポイント固有のエラーコードはありません。共通エラーコードはメッセージコード一覧を参照してください。