支払設定情報取得API

概要

決済方法の情報取得をするAPIです。

支払方法・支払タイミング・プラン・クレジットカード情報・コンビニ支払情報を一挙に取得します。

エンドポイント

メソッド URI Headers
GET /api/payment/method Default

リクエストパラメーター

{primary} リクエストパラメーターはありません。

レスポンス

パラメーター名 型 内容 テーブル 特記
payment_method tinyint 1：クレジット
5：コンビニ払い		 organization_payment_settings
credit_card_type tinyint 1 ：VISA
5 ：MASTER
10：JCB
15：AMEX
20：DINERS		 organization_payment_settings

※支払設定未登録の場合はtemp_payment_settings		 ※カード支払いの時のみデータが登録されてます。
credit_card_number varchar カード番号 organization_payment_settings

※支払設定未登録の場合はtemp_payment_settings		 ※カード支払いの時のみデータが登録されてます。
credit_card_nominee varchar カード名義人 organization_payment_settings

※支払設定未登録の場合はtemp_payment_settings		 ※カード支払いの時のみデータが登録されてます。
credit_card_effective_month tinyint カード有効期限 月 organization_payment_settings

※支払設定未登録の場合はtemp_payment_settings		 ※カード支払いの時のみデータが登録されてます。
credit_card_effective_year tinyint カード有効期限 年 organization_payment_settings

※支払設定未登録の場合はtemp_payment_settings		 ※カード支払いの時のみデータが登録されてます。
cvs_code varchar 支払先コンビニエンスコード organization_payment_settings ※GMO PAYMENTの支払先コンビニエンスコードがどんな値なのか不明なので確認後変更の可能性あり
plan int プラン人数 organization_payment_settings
payment_timing tinyint 1：年払い 5：月払い organization_payment_settings 
{
    "result"                          : true,
    "errors"                          : "",
    "data"                            : {
        'payment_method'              : 1,
        'credit_card_type'            : 1,
        'credit_card_number'          : '41111********111',
        'credit_card_nominee'         : 'MASATOSHI KUMAGAI',
        'credit_card_effective_month' : 15,
        'credit_card_effective_year'  : 10,
        'cvs_code'                    : '00001', // @todo GMOの資料にはCHAR(5)と記載されているが実際の値不明なので分かり次第修正
        'plan'                        : 999,
        'payment_timing'              : 1,
    },
}

{primary} 何もなければ空配列で返却

{
    "result"   : true,
    "errors"   : "",
    "data"     : {},
}

{danger} 失敗時は、200以外のエラーコードが返却されます。共通ルールのレスポンスをチェック。

データ取得

organization_payment_settings

  • 絞り込み条件のorganization_idはログイン情報から取得します。
SELECT
    *
FROM
    `organization_payment_settings`
WHERE
    `organization_id` = Auth::organizationId()
AND `deleted_at` IS NULL

temp_payment_settings

{primary} 支払設定情報は未登録だがクレジットカード情報は登録されている場合、temp_payment_settingsのデータを取得し、

temp_payment_settingsの値をレスポンスとして返します。

コンビニ支払いを選択して登録する場合はこのテーブルは使用しません。テーブルの論理名は「支払設定一時保存」ですが実質クレカ情報一時登録テーブルです。

初回の支払設定時、クレジットカード情報は登録したが支払設定を完了する前に画面を離脱した後、

再度初回の支払設定にもどってきたときに使用されることを想定しています。

  • 絞り込み条件のorganization_idはログイン情報から取得します。
SELECT
    *
FROM
    `temp_payment_settings`
WHERE
    `organization_id` = Auth::organizationId()
AND `deleted_at` IS NULL

RUN