| description | A high level overview on how our API does payment detection |
|---|
The Request API uses a reference-based payment detection system that automatically monitors blockchain transactions to detect when payments are made to your requests. This system works across multiple blockchains and handles various payment scenarios.
When you create a payment request, the API automatically generates a unique payment reference, a 16-character identifier that acts as a fingerprint for your request. This reference is what connects blockchain transactions back to your specific request.
The API continuously monitors supported blockchains using subgraphs that scan for transactions containing payment references. This happens automatically in the background, no action required from you.
When someone makes a payment and includes the payment reference in their transaction, our system:
- Detects the transaction within minutes
- Validates the payment details (amount, currency, recipient)
- Updates the request status (partially paid, fully paid, etc.)
- Triggers your configured webhooks
Once a payment is detected, your request status is immediately updated and you can get the latest information via:
- GET requests to check payment status using the request's id
- Automatically receive updates to your webhooks
All crosschain payments done using the Request Network API use our ERC 20 Fee proxy contract as the last leg of payment, so payment detection works out of the box.
For real-time integration, you can configure webhooks to be notified for the following events:
- Payment Confirmed: Full payment received
- Payment Partial: Partial payment received
- Payment Failed: Transaction failed
- Payment Refunded: Payment was refunded
This allows your application to react immediately to payment events without constantly polling the API.
- Zero Configuration: Payment detection happens automatically
- Multi-blockchain: Works across all supported networks
- Real-time: Fast detection and status updates
- Flexible: Handles various payment scenarios
- Reliable: Built on proven blockchain indexing infrastructure
The system is designed to be completely transparent to your application, simply create requests and let the API handle all the complexity of monitoring blockchains for payments.