請求情報取得API

概要

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

エンドポイント

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

リクエストパラメーター

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

レスポンス

パラメーター名 型 内容 特記
payment_method int 支払方法 1：クレジット　 5：コンビニ払い
billing_start string 決済対象開始日 /区切り
billing_end string 決済対象終了日（末日） /区切り
billing_next string 次回決済予定日 /区切り
billing_confirmation_date string 請求確定日
settlement_date string 決済確認日 nullable
billing_fee int 請求料金
plan int プラン
payment_card_digits int カード下四桁 クレジット払いの時
status int 決済状況 1:未入金　5:入金済み　10:処理失敗
failed_reason string 処理失敗時のエラー文章 決済実行後、失敗時のエラー文章（なぜ失敗したか）
pdf_url string PDF の URL
cvs_code int 支払先コンビニ ※Enum参照
cvs_conf_no int 確認番号 支払先確認番号
cvs_receipt_no int 受付番号 支払先受付番号 
{
    "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,
        'payment_card_digits'       : 1234,
        'billing_confirmation_date' : '2021/10/20',
        'settlement_date'           : '2021/10/30',
        'plan'                      : 10,
        'status'                    : 10,
        'failed_reason'             : '有効なカードではありませんでした',
        'pdf_url'                   : 'https://......pdf',
        'cvs_code'                  : '', // @todo 実際の値わかったら記述します
        'cvs_conf_no'               : '', // @todo 実際の値わかったら記述します
        'cvs_receipt_on'            : '', // @todo 実際の値わかったら記述します
    },
}

{primary} 何もなければ空配列で返却
失敗ではなく、成功として返却。

　

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

データ取得SQL

  • 所属している監理団体IDorganizations.id
  • 請求種類が「初月」 or 「アカウント停止」
  • 請求状態が「未入金」
  • 論理削除されていない
SELECT
    *
FROM
    `organization_payments`
WHERE
    `organization_payments`.`organization_id` = Auth::organizationId()  // ログインしている監理団体のID
AND (
        `organization_payments`.`payment_type` = PaymentType::FIRST_PAYMENT // 請求種類：初月
     OR `organization_payments`.`payment_type` = PaymentType::UNSUSPENDED   // 請求種類：アカウント停止
)
AND `organization_payments`.`status` = PaymentStatus::NOT_DEPOSITED // 請求状態：未入金
AND `organization_payments`.`deleted_at` IS NULL
LIMIT 1

RUN