請求情報取得API

概要

現在請求されている請求情報を取得します。

エンドポイント

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

リクエストパラメーター

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

レスポンス

成功時
パラメーター名 型 内容 特記
payment_method int 支払方法 1：クレジット　 5：コンビニ払い
billing_start string 決済対象開始日 /区切り
billing_end string 決済対象終了日（末日） /区切り
billing_next string 次回決済予定日 /区切り
billing_fee int 請求料金
billing_confirmed_at string 請求確定日
plan int プラン
credit_card_number int カード番号 間マスクされているクレジットカード番号

※convenience_store_payment　は取得できない場合があるかもしれない。要はこける可能性があるので注意。

{
    "result"   : true,
    "errors"   : "",
    "data"     : {
        'payment_method'                   : 1,
        'billing_start'                    : '2021/09/08',
        'billing_end'                      : '2021/09/31',
        'billing_next'                     : '2021/09/31',
        'billing_fee'                      : 100000,
        'billing_confirmed_at'             : '2021/10/20',
        'plan'                             : 10,
        'credit_card_number'               : '411111********111'
    },
}
失敗時

DBにクレジットカード情報が登録されていない時、もしくはGMOの決済実行APIでエラーが返却された時に、ブラウザに返却するエラー

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果
billing_next string 次回の請求日 
{
  "result"   : false,
  "errors"   : {},
  "data"     : {
      "billing_next" => '2021/11/30'
  },  
}

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

データ取得SQL

  • 所属している監理団体IDorganizations.id
  • 論理削除されていない
SELECT
    *
FROM
    `organization_payments`
WHERE
    `organization_payments`.`id` = Auth::organizationId()
AND `organization_payments`.`deleted_at` IS NULL
ORDER BY

{warning} ※実際はfindで取得します。

RUN