APIオブジェクト
PaymentIntent、CryptoQuote、Refund、Event、WebhookEndpointのfield
SDKはREST APIの snake_case をTypeScript向けの camelCase に変換します。
| オブジェクト | ID例 | 役割 |
|---|---|---|
| PaymentIntent | pi_… | 支払い1件の金額、状態、入金指示、返金、内部取引 |
| CryptoQuote | cq_… | stablecoin数量と参照レートのプレビュー |
| Refund | RF-… | PaymentIntentに紐づく返金台帳 |
| Event | evt_… | PaymentIntentの完了・キャンセル・返金イベント |
| WebhookEndpoint | 数値ID | マーチャントのWebhook受信先 |
PaymentIntent
| SDKフィールド | 意味 |
|---|---|
amount | 請求額。法定通貨の主単位 |
amountReceived | 記録された受領額 |
amountRefunded | 起票済みの返金額 |
currency | 小文字の法定通貨コード（jpy / usd など） |
status | requires_payment_method / requires_action / processing / succeeded / canceled / failed |
clientSecret | ホスト型セッションのブラウザ認可情報。Webhookスナップショットには含まれない |
nextAction | requires_action 中の入金指示。それ以外は null |
transactions | 取引ハッシュ（explorerUrl は現行実装では常に null） |
refunds.data | この支払いに紐づく返金一覧 |
metadata | マーチャントが保存した任意データ |
livemode | live key由来かどうか |
settlement | 内部取引ID、チャネル、取引ハッシュ。精算完了ステータスではない |
amount は主単位です。一方、nextAction.cryptoDeposit.amount や見積りのtoken数量は、小数精度を保つため文字列です。
入金指示
nextAction.cryptoDeposit の主なフィールド:
| フィールド | 説明 |
|---|---|
stablecoin / network | 選択したレール |
chainId / tokenContract | ウォレット送金に必要なチェーン情報 |
depositAddress | 入金先アドレス |
amount | 送るtoken数量（文字列） |
eip681Uri | QR／ウォレットdeep link用URI |
expiresAt | 入金期限（Unix秒） |
refreshRemaining | 参照値（現行実装では常に 2。confirm の再実行回数は制限されない） |
mode | simulate / testnet / live |
faucets | testnet時のfaucetリンク |
CryptoQuote
cryptoQuote は状態を変えないプレビューです。有効期限は約15分ですが、confirm は cq_… をロックせず、確定時に金額を再計算します。UIでは確定レスポンスの nextAction.cryptoDeposit.amount を最終的な送金額として表示してください。
Refund
PaymentIntentの refunds.data は返金台帳を返します。status: "requested" は返金が起票された状態で、実際の資金返却完了を意味しません。
Event
| SDKフィールド | 意味 |
|---|---|
id | evt_…。Webhookの Tradom-Event-Id headerと同じ値 |
object | 常に "event" |
type | payment_intent.succeeded / payment_intent.canceled / payment_intent.refunded |
created | 発生時刻（Unix秒）。null の場合あり |
data.object | 発生時点のPaymentIntentスナップショット |
livemode | live key由来かどうか |
Eventの data.object は発生時点のPaymentIntentスナップショットです。clientSecret は除外されます。イベント種別は Webhookとイベント を参照してください。
WebhookEndpoint
| SDKフィールド | 意味 |
|---|---|
id | 数値ID |
url | 配信先URL（https / http のみ。private・loopbackアドレスは url_invalid） |
enabled | 有効かどうか（APIから変更する手段は現在なし） |
secret | whsec_…。create のresponseにのみ含まれ、list では返らない |