Skip to main content

​
Overview

Use query endpoints to retrieve the latest status for a specific request. These endpoints are the main reconciliation surface for request-level state (paid/not paid, payment references, transaction hash, and optional metadata).

​
Core Endpoints

​
How It Works

1

Read a single request status

Call GET /v2/request/ to get current request-level status fields.Typical fields include:
  • hasBeenPaid
  • paymentReference
  • txHash
  • isListening
  • optional metadata such as customerInfo and reference
2

Combine with events for real-time updates

Use Webhooks & Events for push updates, and use query endpoints as source-of-truth reads.
3

Use wallet-level search when needed

For wallet-level reconciliation views, use GET /v2/payments.

​
Request Status Query

GET /v2/request/{requestId} is the canonical request-level status endpoint for:
  • request payment completion checks (hasBeenPaid)
  • transaction linkage (txHash)
  • request identification (requestId, paymentReference)
  • conversion-related status fields when applicable (amountInUsd, conversionRate, conversionBreakdown)

​
Reconciliation Pattern

Webhooks First

React to events in real time and update app state immediately.

Query for Verification

Use query endpoints to confirm latest status and backfill missed events.

​
Practical Notes

  • Use requestId for deterministic lookup.
  • Keep idempotent reconciliation logic in case the same request is processed multiple times by your workers.

Payment Detection

Understand automatic detection and status updates.

Query Payments

Search and reconcile payment-level events.

Webhooks & Events

Build real-time event-driven reconciliation.

​
API Reference

For full schemas and examples, see Request Network API Reference.