Skip to main content

GetPayment

決済情報の取得

Description​

外部から決済レコードを取得

Method​

GET

Request URL Format​

/api/v1/payments

Payload​

Content-Type : application/json

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

Request Parameter​

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

Request URL Sample​

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

Response Sample​

{
    "status": true,
    "code": 200,
    "message": "プロジェクト情報取得に成功しました。",
    "data": [
        {
            "payment": {
                "payment_no": 2,
                "paid_at": "2023-05-19 10:00:00",
                "deposit_date": "2023-06-19",
                "payment_type": "one_time",
                "plan_id": 101,
                "plan_name": "スタンダードプラン",
                "unit_price": 2000,
                "quantity": 1,
                "amount": 2000,
                "payment_method": "card_stripe",
                "created_at": "2025-11-10 10:00:00",
                "updated_at": "2025-11-10 10:00:00",
            },
            "custom_fields": [
                {
                    "id": 1,
                    "name": "応援メッセージ",
                    "value": [
                        "頑張ってください！"
                    ]
                }
            ],
            "project": {
                "project_id": 6,
                "project_name": "ベーシック"
            },
            "receipt": {
                "receipt_no": 1411,
                "receipt_status": "issued"
            },
            "recurring": {
                "recurring_no": 1532
            },
            "supporter": {
                "supporter_no": 2,
                "entity_type": "individual",
                "organization_name": "サンプル株式会社",
                "department_and_title": "営業部 マネージャー",
                "last_name": "山田",
                "first_name": "太郎",
                "email": "test@example.com",
                "phone_number": "090-1234-5678",
                "gender": "male",
                "birth_date": "1990-01-01",
                "address": {
                    "country": "日本",
                    "postal_code": "100-0001",
                    "prefecture": "東京都",
                    "city": "千代田区",
                    "address_line": "1-1-1 サンプルビル101"
                }
            }
        },
    ]
}

Response Explanation​

  • payment - 決済情報
    • payment_no - 決済No
    • paid_at - 受領日
    • deposit_at - 入金日
    • payment_type - 決済頻度。(単発:one_time、毎月:monthly、毎年:annually、タップ寄付:tap)
    • plan_id - プランID
    • plan_name - プラン名
    • unit_price - 単価
    • quantity - 口数
    • amount - 金額
    • payment_method - 受領方法。(カード決済（Stripe）:card_stripe、カード決済（テレコム）:card_telecom、カード決済（GOJO）:card_gojo、ポイント寄付（GOJO）:point_gojo、銀行振込:bank_transfer、郵便振替:postal_transfer、PayPay:paypay、Amazon Pay:amazon_pay、無料申込:free、他)
    • created_at - 作成日時
    • updated_at - 更新日時
  • custom_fields - 決済カスタム項目
    • id - カスタム項目ID
    • name - カスタム項目名
    • value - カスタム項目回答
  • project - 関連プロジェクト情報
    • project_id - プロジェクトID
    • project_name - プロジェクトタイトル
  • receipt - 関連領収書情報
    • receipt_no - 領収書No.
    • receipt_status - 領収書発行ステータス。(未発行:unissued、発行済み:issued、無効:invalid)
  • recurring - 関連継続契約情報
    • recurring_no - 継続契約No
  • 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 - 番地・建物