当月費用支払API

概要

当月費用支払画面に表示されている決済を実行します。

エンドポイント

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

リクエストパラメーター

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

レスポンス

成功時
パラメーター名 型 内容 特記
result boolean リクエスト結果 
{
    "result" : true,
}


失敗時

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

ステータスコード：200

パラメーター名 型 内容 特記
result boolean リクエスト結果
errors array エラーメッセージ 
{
  "result"   : false,
  "errors"   : {
    '請求データがありません。',
    '決済に失敗しました。',
  },
}

{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