支払API
受け取った請求書ごとに、支払指示（全銀データの出力）・振込予定日・支払済の状態を読み取るAPIエンドポイントです。 支払指示の確定・支払済の記録はアプリの画面から行います（APIでは提供していません）。 状態が変わったことは Webhook の payment.instructed / payment.completed / payment.reverted でも受け取れます。
GET /api/v1/payments
受領請求書ごとの支払の状態（未指示・支払指示済み・支払済）を取得します。
必要なスコープ: payments:read
| パラメータ | 型 | 説明 |
|---|---|---|
limit | number | 1回に返す件数（既定: 20 / 最大: 100） |
starting_after | string | 前回の応答の next_cursor。続きのページを返します |
updated_since | string (ISO 8601) | この日時以降に更新された行だけを返します（差分の同期用） |
status | string | open（未指示）/ instructed（支払指示済み・振込待ち）/ paid（支払済）で絞り込み |
vendor_id | string | 取引先IDで絞り込み |
レスポンス
{
"object": "list",
"data": [
{
"object": "payment",
"id": "clxxx...",
"invoice_id": "clxxx...",
"invoice_number": "INV-0042",
"vendor": { "id": "clxxx...", "name": "取引先名" },
"status": "instructed",
"due_date": "2026-12-31T00:00:00.000Z",
"payment_instructed_at": "2026-12-20T01:00:00.000Z",
"scheduled_transfer_date": "2026-12-25T00:00:00.000Z",
"paid_at": null,
"created_at": "2026-12-01T00:00:00.000Z",
"updated_at": "2026-12-20T01:00:00.000Z",
"amounts": { "currency": "JPY", "amount": 110000 }
}
],
"has_more": false,
"next_cursor": null
}- ●並びは作成日時の古い順です。has_more が true のときは next_cursor を starting_after に渡して続きを取ります。
- ●支払は受領請求書の単位です（id は請求書の id と同じ）。請求書の来ない取引先（支払明細書で払う取引先）への振込は載りません。
- ●status は paid（支払済）→ instructed（支払指示＝全銀データの出力を確定した・振込予定日つき）→ open（どちらもまだ）の順に判定します。支払指示は着金ではありません。支払済は人が着金を確かめて付けます。
- ●金額（amounts）は amounts:read スコープを持つキーにだけ返します。組織で請求・支払の機能が使えない場合は付けても返しません。金額は発行時に保存した値で、再計算しません。