決済実行API

概要

当月費用支払い画面のみで使用します。

決済を実行するAPIです。

クレジットの場合とコンビニ決済の場合で処理が異なります。

※コンビニ決済は追加処理となります。

メソッド	URI	Headers
POST	`/api/payment/settlement`	Default

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

成功時

パラメーター名	型	内容	特記
result	boolean	リクエスト結果

{
    "result"   : true,
}

失敗時

ステータスコード：200

パラメーター名	型	内容	特記
result	boolean	リクエスト結果
errors/error	string	list

{
  "result" : false,
  "errors" : {
    'error' : ['エラー'],
  },
}

{primary} このAPIでは支払方法がクレジットカード払いかコンビニ払いかで処理の流れが異なるため、このに処理の流れを記載しています。

ここに記載するのはバリデーション通過後の処理の流れです。

未払いの請求データorganization_paymentsを取得します。
決済APIにて未払いの請求データで取引登録を行います。
上記で登録した取引に対して、決済APIにて決済実行します。
決済が失敗した場合は失敗した結果とエラーメッセージを返して処理を終了します。
決済が成功した場合は監理団体organizationsのステータスを「5：利用中」へ更新します。アカウント停止日が登録されている場合はそのアカウント停止日をNULLにします。
請求データorganization_paymentsを請求完了状態へ更新します。
対象監理団体のマスターアカウントのメールアドレス宛に決済が完了した旨を記載したメールを送信します。
当月費用支払いの決済を行った日が21日以降の場合、次月の請求データの作成を行います。
処理が成功した旨、結果を返します。

未払いの請求データorganization_paymentsを取得します。
決済APIにて取引状態参照を行い、現状態が「REQSUCCESS（要求成功）」もしくは「AUTHPROCESS（認証処理中）」の場合は決済が完了していない旨の結果とエラーメッセージを返して処理を終了します。
決済APIにて取引状態参照を行い、現状態が「CAPUTURE（即時売上）」の場合はコンビニ払いが完了しているので、監理団体organizationsのステータスを「5：利用中」へ更新します。アカウント停止日が登録されている場合はそのアカウント停止日をNULLにします。
請求データorganization_paymentsを請求完了状態へ更新します。
対象監理団体のマスターアカウントのメールアドレス宛に決済が完了した旨を記載したメールを送信します。
当月費用支払いの決済を行った日が21日以降の場合、次月の請求データの作成を行います。
処理が成功した旨、結果を返します。

未払いの請求データ取得条件項目	値	テーブル.カラム
監理団体支払設定ID	対象監理団体の支払設定ID	`organization_pyaments.organization_payment_setting_id`
支払年月が今月	今月の年月	`organization_pyaments.payment_year` & `payment_month`
請求状態	未入金	`organization_pyaments.payment_status`
請求データクローズフラグ	false	`organization_pyaments.closed`