Skip to content

Commit 9264da3

Browse files
MantisCloneMantisClone
committed
refactor: split requests page into create requests and query requests
1 parent a96598a commit 9264da3

File tree

4 files changed

+194
-84
lines changed

4 files changed

+194
-84
lines changed

‎api-features/create-requests-query-status.mdx‎

Lines changed: 0 additions & 83 deletions
This file was deleted.

‎api-features/create-requests.mdx‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
title: "Create Requests"
3+
description: "Request creation workflows and configuration for invoices and payment collection"
4+
---
5+
6+
## Overview
7+
8+
Request creation forms the foundation of Request Network operations, enabling structured payment collection through invoice generation and payment request workflows.
9+
10+
## Request Types
11+
12+
<CardGroup cols={2}>
13+
<Card title="Invoice Requests" icon="file-invoice">
14+
Traditional invoicing with payee details
15+
</Card>
16+
17+
<Card title="Payment Requests" icon="money-bill">
18+
Direct payment collection workflows
19+
</Card>
20+
</CardGroup>
21+
22+
## How It Works
23+
24+
```mermaid
25+
graph TD
26+
A[Define Request] --> B[Select Payment Network]
27+
B --> C[Configure Properties]
28+
C --> D[Store on IPFS]
29+
D --> E[Index on Blockchain]
30+
E --> F[Generate Request ID]
31+
```
32+
33+
**Creation Process:**
34+
1. **Define:** Set payee, payer, amount, and currency details
35+
2. **Configure:** Choose payment network and accepted tokens
36+
3. **Store:** Decentralized storage on IPFS
37+
4. **Index:** Blockchain indexing for discovery
38+
5. **Track:** Real-time status monitoring
39+
40+
## Request Properties
41+
42+
### Core Information
43+
- **Payee:** Request creator/recipient address
44+
- **Payer:** Payment sender address (optional)
45+
- **Amount:** Payment amount and currency
46+
- **Due Date:** Payment deadline (optional)
47+
48+
### Payment Configuration
49+
- **Payment Network:** ERC20, ETH, or specialized networks
50+
- **Accepted Tokens:** Supported payment currencies
51+
- **Conversion Settings:** Fiat-denominated crypto payments
52+
53+
## Payment Network Selection
54+
55+
<CardGroup cols={2}>
56+
<Card title="ERC20 Networks" icon="coins">
57+
USDC, USDT, DAI token payments
58+
</Card>
59+
60+
<Card title="Native Networks" icon="ethereum">
61+
ETH, MATIC, BNB direct payments
62+
</Card>
63+
</CardGroup>
64+
65+
### Supported Networks
66+
- **Mainnet:** Ethereum, Polygon, Arbitrum, Optimism
67+
- **Sidechains:** BSC, Gnosis, Fantom, Avalanche
68+
- **Testnets:** Sepolia, Mumbai for development
69+
70+
## Content Data
71+
72+
Attach additional information to requests:
73+
- **Invoice Details:** Line items, tax information
74+
- **Business Information:** Company details, terms
75+
- **Custom Metadata:** Application-specific data
76+
77+
## Used In
78+
79+
<CardGroup cols={2}>
80+
<Card title="Invoicing" href="/use-cases/invoicing">
81+
Business invoice generation
82+
</Card>
83+
84+
<Card title="Payroll" href="/use-cases/payroll">
85+
Employee payment requests
86+
</Card>
87+
</CardGroup>
88+
89+
## Implementation Details
90+
91+
See [API Reference - Create Requests](/api-reference/endpoints/create-request) for complete technical documentation.

‎api-features/query-requests.mdx‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
title: "Query Requests"
3+
description: "Request status monitoring, lifecycle management, and information retrieval"
4+
---
5+
6+
## Overview
7+
8+
Query requests provides comprehensive request status monitoring and information retrieval, enabling real-time tracking of payment requests throughout their lifecycle.
9+
10+
## Request Status Lifecycle
11+
12+
<CardGroup cols={2}>
13+
<Card title="Active States" icon="play">
14+
Created, pending, partially paid
15+
</Card>
16+
17+
<Card title="Final States" icon="check">
18+
Paid, cancelled, expired
19+
</Card>
20+
</CardGroup>
21+
22+
## How It Works
23+
24+
```mermaid
25+
graph LR
26+
A[Request ID] --> B[Query Status]
27+
B --> C[Retrieve Info]
28+
C --> D[Check Payments]
29+
D --> E[Update Status]
30+
```
31+
32+
**Query Process:**
33+
1. **Identify:** Use request ID for lookup
34+
2. **Retrieve:** Get current request information
35+
3. **Analyze:** Check payment status and history
36+
4. **Update:** Reflect latest blockchain state
37+
38+
## Status Types
39+
40+
### Request States
41+
- `created` - Request initialized and stored
42+
- `pending` - Awaiting payment completion
43+
- `paid` - Full payment received and confirmed
44+
- `cancelled` - Request cancelled by creator
45+
- `expired` - Past due date without payment
46+
47+
### Payment States
48+
- `no_payment` - No payment transactions detected
49+
- `partially_paid` - Partial payment received
50+
- `paid` - Full payment amount received
51+
- `overpaid` - Payment exceeds requested amount
52+
53+
## Query Methods
54+
55+
<CardGroup cols={2}>
56+
<Card title="Single Request" icon="magnifying-glass">
57+
Detailed status for specific request
58+
</Card>
59+
60+
<Card title="Batch Queries" icon="list">
61+
Multiple request status in one call
62+
</Card>
63+
</CardGroup>
64+
65+
### Information Retrieved
66+
- **Basic Details:** Amount, currency, participants
67+
- **Payment History:** Transaction details and confirmations
68+
- **Status Timeline:** Creation, updates, completion dates
69+
- **Network Data:** Blockchain and transaction information
70+
71+
## Real-time Monitoring
72+
73+
### Automatic Updates
74+
Combine with [Payment Detection](/api-features/payment-detection) for automatic status updates
75+
76+
### Event Integration
77+
Use [Webhooks & Events](/api-features/webhooks-events) for instant notifications
78+
79+
## Advanced Filtering
80+
81+
Filter requests by:
82+
- **Date Range:** Creation or due date periods
83+
- **Status:** Current request or payment state
84+
- **Participants:** Payee or payer addresses
85+
- **Amount Range:** Minimum and maximum values
86+
87+
## Used In
88+
89+
<CardGroup cols={2}>
90+
<Card title="Dashboard Apps" icon="chart-line">
91+
Real-time payment tracking
92+
</Card>
93+
94+
<Card title="Accounting Systems" icon="calculator">
95+
Invoice status reconciliation
96+
</Card>
97+
</CardGroup>
98+
99+
## Implementation Details
100+
101+
See [API Reference - Query Requests](/api-reference/endpoints/get-request) for complete technical documentation.

‎docs.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
{
7272
"group": "Requests",
7373
"pages": [
74-
"api-features/create-requests-query-status"
74+
"api-features/create-requests"
7575
]
7676
},
7777
{
@@ -91,6 +91,7 @@
9191
"group": "Reconciliation",
9292
"pages": [
9393
"api-features/payment-detection",
94+
"api-features/query-requests",
9495
"api-features/query-payments",
9596
"api-features/webhooks-events"
9697
]

0 commit comments

Comments
 (0)