GetRecurring

継続契約情報の取得

Description

外部から継続契約情報を取得

Method

GET

Request URL Format

/api/v1/recurrings

Payload

Content-Type : application/json

Authorization : Bearer bbdf8d3b-ae12-4e63-93d8-d3a1c4254fc6

Request Parameter

パラメータ名	説明	補足
filter_date	日付の項目	（任意）フィルター項目を指定する（created_at、updated_at、first_paid_at、last_paid_at）、デフォルトはcreated_at
start_date	開始日	（必須）フィルターの開始日を指定する（yyyy-mm-dd形式）
end_date	終了日	（必須）フィルターの終了日を指定する（yyyy-mm-dd形式）
sort_item	並び順の項目	（任意）並び順の項目を指定する（created_at、updated_at、first_paid_at、last_paid_at）、デフォルトはcreated_at
sort_order	並び順の方向	（任意）並び順の方向を指定する（desc、asc）、デフォルトはdesc
project_id	プロジェクトID	（任意）紐づくプロジェクトのIDを指定する、デフォルトは全て
payment_type	決済頻度	（任意）決済頻度を指定する（monthly/annually）、デフォルトは全て

Request URL Sample

GET https://global-api.congrant.com/api/v1/recurrings?start_date=2023-05-16&end_date=2023-05-22&sort_item=first_paid_at

Response Sample

{
    "status": true,
    "code": 200,
    "message": "継続契約情報取得に成功しました。",
    "data": [
        {
            "recurring": {
                "recurring_no": 1234,
                "receipt_status": "active",
                "payment_type": "one_time",
                "unit_price": 2000,
                "quantity": 1,
                "amount": 2000,
                'project_name': "ベーシック",
                'cumulative_amount': 10000,
                'cumulative_count': 10,
                'first_paid_at': "2023-05-19",
                'last_paid_at': "2023-05-19",
                'fail_paid_at': "2023-05-19",
                'consecutive_fail_paid_count': 5,
                'cancelled_at': "2023-05-19",,
                'cancel_reason_type': "saw_impact",
                'cancel_reason_detail': "The activity reports from the organization were insufficient.",
                'created_at': "2023-05-19 02:12:45",
                'updated_at': "2023-05-19 02:16:45",
            },
            "supporter": {
                "supporter_no": 2,
                "entity_type": "individual",
                "organization_name": "サンプル株式会社",
                "department_and_title": "マーケティング部 担当者",
                "last_name": "山田",
                "first_name": "太郎",
                "email": "text@example.com",
                "phone_number": "080-1234-5678",
                "gender": "male",
                "birth_date": "1992-08-15",
                "address": {
                    "country": "日本",
                    "postal_code": "150-0001",
                    "prefecture": "東京都",
                    "city": "渋谷区",
                    "address_line": "神宮前1-2-3 サンプルマンション202"
                }
            }
        },
    ]
}

Response Explanation

• recurring - 決済情報
  • recurring_no - 継続契約No
  • recurring_status - 継続契約ステータス。(継続中:active、解約:canceled、再決済:error)
  • payment_type - 寄付タイプ。(単発:one_time、毎月:monthly、毎年:annually、タップ寄付:tap)
  • unit_price - 単価
  • quantity - 口数
  • amount - 金額
  • project_name - プロジェクト名
  • cumulative_amount - 累計金額
  • cumulative_count - 累計回数
  • first_paid_at - 初回決済日
  • last_paid_at - 最終決済日
  • next_payment_due_date - 次回決済予定日
  • fail_paid_at - 最終決済失敗日
  • consecutive_fail_paid_count - 連続決済失敗回数
  • cancelled_at - 解約日
  • cancel_reason_type - 解約理由。(寄付による成果が見えた:saw_impact、寄付が支援につながっている実感が持てない:no_impact_felt、団体からの活動報告が不十分:insufficient_reporting、団体の活動に共感できなくなった:lost_empathy、団体の対応に不満がある:dissatisfied_with_support、寄付先の変更:changed_recipient、生活環境の変化:life_circumstances_changed、その他:other、運営解約:canceled_by_operator、GOJO退会:gojo_withdrawal、自動解約:auto_canceled)
  • cancel_reason_detail - 解約理由詳細
  • created_at - 作成日時
  • updated_at - 更新日時
• supporter - 関連サポーター情報
  • supporter_no - サポーターNo.
  • entity_type - サポーター種別。(個人:individual、法人:corporation)
  • organization_name - 法人名
  • department_and_title - 部署・肩書
  • last_name - 氏名（姓）
  • first_name - 氏名（名）
  • email - メールアドレス
  • phone_number - 電話番号
  • gender - 性別。(男性:male、女性:female、その他:other、無回答:unanswered)
  • birth_date - 生年月日
  • address - 住所情報
    • country - 国名
    • postal_code - 郵便番号
    • prefecture - 都道府県
    • city - 市区町村
    • address_line - 番地・建物