From b89f3ddaa58fc9187fd7d04876ae58631c741c18 Mon Sep 17 00:00:00 2001 From: Aimen Sahnoun Date: Mon, 2 Mar 2026 02:20:17 +0400 Subject: [PATCH] =?UTF-8?q?docs(api-features):=20refine=20payment-detectio?= =?UTF-8?q?n=20with=20legacy-aligned,=20accurate=20guidance=20Update=20`ap?= =?UTF-8?q?i-features/payment-detection.mdx`=20to=20remove=20AI-generated?= =?UTF-8?q?=20placeholder=20framing=20and=20align=20the=20page=20with=20le?= =?UTF-8?q?gacy-supported=20detection=20concepts=20while=20keeping=20Mintl?= =?UTF-8?q?ify=20structure.=20-=20removed=20AI=20warning=20banner=20and=20?= =?UTF-8?q?legacy=20=E2=80=9Cstable=20docs=E2=80=9D=20dependency=20messagi?= =?UTF-8?q?ng=20-=20tightened=20overview=20and=20flow=20language=20around?= =?UTF-8?q?=20reference-based=20payment=20detection=20-=20kept=20core=20de?= =?UTF-8?q?tection=20lifecycle=20intact:=20=20=20-=20payment=20reference?= =?UTF-8?q?=20generation=20=20=20-=20blockchain=20monitoring=20=20=20-=20a?= =?UTF-8?q?utomatic=20validation=20+=20status=20updates=20=20=20-=20webhoo?= =?UTF-8?q?k=20triggering=20-=20clarified=20API=20access=20point=20for=20s?= =?UTF-8?q?tatus=20checks=20with=20`GET=20/v2/request/{requestId}`=20-=20r?= =?UTF-8?q?eplaced=20hardcoded=20supported-network=20lists=20with=20canoni?= =?UTF-8?q?cal=20internal=20reference:=20=20=20`/resources/supported-chain?= =?UTF-8?q?s-and-currencies`=20-=20kept=20crosschain=20detection=20explana?= =?UTF-8?q?tion=20and=20webhook=20sections,=20but=20removed=20over-specifi?= =?UTF-8?q?c/unverified=20claims=20-=20removed=20rigid=20payment-state=20m?= =?UTF-8?q?atrix=20to=20avoid=20inaccurate=20state=20assumptions=20across?= =?UTF-8?q?=20flows=20-=20verified=20internal=20links=20and=20removed=20le?= =?UTF-8?q?gacy-domain=20references=20from=20the=20page?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- api-features/payment-detection.mdx | 62 +++++++++--------------------- 1 file changed, 19 insertions(+), 43 deletions(-) diff --git a/api-features/payment-detection.mdx b/api-features/payment-detection.mdx index b3dce21..4a9f477 100644 --- a/api-features/payment-detection.mdx +++ b/api-features/payment-detection.mdx @@ -3,13 +3,11 @@ title: "Payment Detection" description: "Automatic reference-based payment detection system for blockchain transactions" --- - -**AI-Generated Content** – This page was generated with AI assistance and may contain inaccuracies. While likely close to accurate, please verify critical details with the [stable documentation](https://docs.request.network) or [contact support](https://github.com/orgs/RequestNetwork/discussions). - - ## Overview -The Request Network 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 with zero configuration required. +The Request Network API uses a **reference-based payment detection system** that automatically monitors blockchain transactions to detect when payments are made to your requests. + +This works across supported blockchains and handles payment matching automatically. ## How It Works @@ -25,51 +23,40 @@ graph TD ### 1. Payment Reference Generation -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. +When you create a request, the API automatically generates a unique **payment reference** (16-character identifier). This reference is what links on-chain payment transactions to your request. **Example:** `0x1234567890abcdef` ### 2. Blockchain Monitoring -The API continuously monitors supported blockchains using subgraphs that scan for transactions containing payment references. This happens automatically in the background with no action required from you. +The API continuously monitors supported blockchains using subgraphs that scan for transactions containing payment references. This happens automatically in the background. **Monitoring includes:** -- Real-time transaction scanning -- Multi-network support -- Payment reference matching -- Amount and currency validation +- transaction scanning +- payment reference matching +- amount and currency validation ### 3. Automatic Detection When someone makes a payment and includes the payment reference in their transaction, the system: -- **Detects** the transaction within minutes +- **Detects** the transaction - **Validates** payment details (amount, currency, recipient) -- **Updates** request status (pending → partially paid → fully paid) +- **Updates** request status (for example partially paid or fully paid) - **Triggers** your configured webhooks ### 4. Real-time Status Updates -Once a payment is detected, your request status is immediately updated and you can get the latest information via: - -- **API Queries:** GET requests to check payment status using the request ID -- **Webhooks:** Automatically receive updates to your configured webhook endpoints - -## Supported Networks +Once a payment is detected, your request status is updated and you can retrieve the latest information via: -Payment detection works across all Request Network supported chains: +- **API Queries:** `GET /v2/request/{requestId}` +- **Webhooks:** receive updates on your configured endpoints -### Mainnet Networks -- Ethereum, Polygon (Matic), Arbitrum One, Optimism, Base -- Gnosis Chain, BSC, Fantom, Avalanche, Celo -- Tron (USDT TRC-20 only) - -### Testnet Networks -- Sepolia, Base Sepolia, Arbitrum Sepolia, Optimism Sepolia +For the latest chain and currency support, see [Supported Chains and Currencies](/resources/supported-chains-and-currencies). ## Crosschain Payment Detection -All crosschain payments using the Request Network API use the **ERC-20 Fee Proxy contract** as the final payment leg, ensuring payment detection works seamlessly across chains. +All crosschain payments using Request Network API use the **ERC-20 Fee Proxy contract** as the last payment leg, so payment detection works out of the box. **How it works:** 1. Payer initiates payment on source chain (e.g., Polygon) @@ -106,33 +93,22 @@ This allows your application to react immediately to payment events without cons - Payment detection happens automatically — no setup required + Payment detection happens automatically - Works across all 10+ supported EVM networks + Works across supported chains - Fast detection and status updates within minutes + Fast detection and status updates - Built on proven blockchain indexing infrastructure + Built on blockchain indexing infrastructure -## Payment States - -Requests progress through the following payment states: - -- **`created`** - Request created, awaiting payment -- **`pending`** - Payment transaction detected, awaiting confirmations -- **`partially_paid`** - Partial payment received -- **`paid`** - Full payment received and confirmed -- **`overpaid`** - Payment exceeds expected amount -- **`refunded`** - Payment was refunded - ## What's Next?