ポーリング可能なトランザクション

API のトランザクションは作成直後に処理中(pending)のステータスになります。この状態は、クレジットカード会社などの決済事業者によって処理された結果が反映されていない為、決済直後に課金情報を取得しても、その時点でのステータスは参考になる情報ではありません。
決済を行った後、ユーザーに対して現在の決済の状態をなるべく早く反映させたい場合は、ポーリングを利用することを推奨します。

ウェブフックを使わない場合、対象のトランザクションに対して、ステータスの変化を検出するまで GET リクエストを行うことで、トランザクションのステータスが変更されたタイミングで通知を受けることが可能です。
しかし、この方法はAPIのリクエスト制限を受けないように適切なエラー処理を行ったポーリングの仕組みを加盟店側で実装しなくてはなりません。

そこで、 API は以下のリソースに対して1回のAPIリクエストでトランザクションのステータスを効率的にポーリングする手段を提供しています:

これらのリソースに GET リクエストを送信する時、polling リクエストパラメータを true と指定すると、APIは対象のリソースが最終的な状態 ※(例: 成功失敗継続中 など)に遷移するまでAPIの内部でポーリングします。
3秒 以内にこのような状態に到達した場合、APIは更新されたレスポンスを返します。ポーリング実行から3秒以内にステータス変更がない場合、状態が何であっても3秒後時点の状態を返します。

※最終的な状態について
ポーリングする対象のリソースによって、最終的な状態を表すステータスは異なります。

  • 課金Canceled, Error, Failed, Successful(最初の状態がpendingの場合は、何かしらステータスが変化したタイミングで最終的な状態としてポーリングは終了いたします)
  • 返金 Error, Failed, Successful
  • キャンセル Error, Failed, Successful
  • 定期課金 : 最終状態なし(最初の状態がUnverifiedの場合は、何かしらステータスが変化したタイミングで最終的な状態としてポーリングは終了いたします)