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

API のトランザクションは作成直後に処理中を表現する状態になります。この状態は、決済ゲートウェイによって処理された結果が反映されていない為、あまり有益な情報ではありません。しかし、決済を開始した後、ユーザーに対して現在の決済の状態をなるべく早くフィードバックしたいと考えるかと思います。

ウェブフックを使わずに、トランザクションの状態が変更されたタイミングで通知を受ける為に、リソースに対して状態の変化を検出するまで GET リクエストを行う方法があります。しかし、この方法はAPIのリクエスト制限を考慮して適切なエラー処理を行ったポーリングの仕組みを実装する必要があり、無駄な方法となります。

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

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