本文へ
GETBearer トークン

支払い状況を取得

/api/v1/payments/:id

決済リクエストと、対応する注文または残高チャージの結果を取得します。

呼び出す前に

ブロックチェーンやプロバイダーの処理結果が未確定の場合は、同じ決済リクエストを照会してください。再度支払ったり requestKey を変更したりしないでください。

API のフィールド名、型、コードはすべての言語で共通です。

リクエスト例

cURL
curl "https://tovahub.com/api/v1/payments/507f1f77bcf86cd799439012" \
  -H "Authorization: Bearer $TOVAHUB_TOKEN"

表示のみ。このページから API リクエストは送信されません。

レスポンス例
JSON
{
  "id": "507f1f77bcf86cd799439011",
  "purpose": "order",
  "amount": "1200",
  "asset": "USD",
  "state": "quoted",
  "mode": null,
  "expiresAt": "2026-11-07T12:30:00.000Z",
  "transactionHash": null,
  "network": null,
  "result": null,
  "error": null
}

パラメーター

idパス · 必須

string

リソース ID。24 桁の16進数文字列です。対応する一覧エンドポイントが返すプラットフォーム ID を使用し、プロバイダーのインスタンス ID は使用しないでください。

レスポンス

HTTP ステータス 200

組織の既存の決済リクエストについて、現在の永続化された状態を取得します。

idstring (ObjectId)

決済リクエストの識別子。見積もりの識別子も兼ねます。

purposestring

決済の用途。現在の公開作成経路では order または deposit を使用します。保存済みの値には renew もあり得ますが、現在の更新対応を意味しません。

amountstring

整数の USD セント数。

assetstring ('USD')

プラットフォームの会計用資産。

statestring ('quoted' | 'authorized' | 'broadcast' | 'settled' | 'applied' | 'failed')

永続化された決済リクエストの状態。

modestring ('balance' | 'x402') | null

選択済みの資金調達方法。選択前は null。

expiresAtstring (ISO 8601)

見積もりの有効期限。受領済みの資金については、この時刻を過ぎても照合処理が必要です。

transactionHashstring | null

存在する場合、ブロックチェーンのトランザクションハッシュ。

networkstring | null

存在する場合、決済ネットワーク。

resultunknown | null

用途別に永続化された適用結果。共通のネストされたレスポンス構造は定義されていません。

errorstring | null

存在する場合、永続化された決済エラー。