Skip to content

Commit 048b022

Browse files
MantisCloneMantisClone
committed
feat: scaffold new API Features pages
1 parent c08dcb6 commit 048b022

15 files changed

+1003
-1
lines changed

‎api-features/batch-payments.mdx‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: "Batch Payments"
3+
description: "Process multiple payments in a single transaction for gas optimization"
4+
---
5+
6+
## Overview
7+
8+
Batch payments allow you to process multiple direct or conversion payments in a single blockchain transaction, significantly reducing gas costs and simplifying payment operations.
9+
10+
## How It Works
11+
12+
```mermaid
13+
graph TD
14+
A[Multiple Recipients] --> B[Single Transaction]
15+
B --> C[Atomic Execution]
16+
C --> D[All Succeed or All Fail]
17+
```
18+
19+
**Benefits:**
20+
- **Gas Savings:** Up to 60% reduction in total gas costs
21+
- **Atomic Operations:** All payments succeed or fail together
22+
- **Simplified Management:** One transaction to monitor
23+
24+
## Requirements
25+
26+
- All payments must be on the same network
27+
- Supports Native, ERC20, and Conversion payments
28+
- Maximum batch size limited by block gas limit
29+
30+
## Use Cases
31+
32+
<CardGroup cols={2}>
33+
<Card title="Payroll Processing" icon="users">
34+
Pay multiple employees simultaneously
35+
</Card>
36+
37+
<Card title="Vendor Payments" icon="building">
38+
Process multiple supplier invoices
39+
</Card>
40+
</CardGroup>
41+
42+
## Used In
43+
44+
<CardGroup cols={2}>
45+
<Card title="Payroll" href="/use-cases/payroll">
46+
Efficient employee payments
47+
</Card>
48+
49+
<Card title="Payouts" href="/use-cases/payouts">
50+
Bulk vendor payments
51+
</Card>
52+
</CardGroup>
53+
54+
## Implementation Details
55+
56+
See [API Reference - Batch Payments](/api-reference/batch-payments) for complete technical documentation.

‎api-features/conversion-payments.mdx‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: "Conversion Payments"
3+
description: "Fiat-denominated requests settled in cryptocurrency with real-time conversion"
4+
---
5+
6+
## Overview
7+
8+
Conversion payments allow you to create requests denominated in fiat currencies (USD, EUR) while receiving settlement in cryptocurrency, with automatic exchange rate conversion at payment time.
9+
10+
## How It Works
11+
12+
```mermaid
13+
graph LR
14+
A[Request: $100 USD] --> B[Real-time Rate]
15+
B --> C[Pay: 0.041 ETH]
16+
C --> D[Receive: 0.041 ETH]
17+
```
18+
19+
**Benefits:**
20+
- Stable pricing in familiar currencies
21+
- Automatic exchange rate handling
22+
- No manual conversion required
23+
24+
## Supported Fiat Currencies
25+
26+
- **USD** - US Dollar
27+
- **EUR** - Euro
28+
- **GBP** - British Pound
29+
- **CNY** - Chinese Yuan
30+
- **JPY** - Japanese Yen
31+
32+
## Exchange Rate Sources
33+
34+
Real-time rates from multiple providers ensure accuracy and reliability.
35+
36+
## Used In
37+
38+
<CardGroup cols={3}>
39+
<Card title="Invoicing" href="/use-cases/invoicing">
40+
Professional invoices in fiat
41+
</Card>
42+
43+
<Card title="Checkout" href="/use-cases/checkout">
44+
E-commerce pricing
45+
</Card>
46+
47+
<Card title="Subscriptions" href="/use-cases/subscriptions">
48+
Predictable subscription pricing
49+
</Card>
50+
</CardGroup>
51+
52+
## Implementation Details
53+
54+
See [API Reference - Conversion Payments](/api-reference/conversion-payments) for complete technical documentation.

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

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
title: "Create Requests & Query Status"
3+
description: "Request creation, management, and real-time status monitoring"
4+
---
5+
6+
## Overview
7+
8+
Request creation and status querying form the foundation of Request Network operations, enabling invoice generation and payment tracking throughout the lifecycle.
9+
10+
## Request Creation
11+
12+
<CardGroup cols={2}>
13+
<Card title="Invoice Requests" icon="file-invoice">
14+
Traditional invoicing workflows
15+
</Card>
16+
17+
<Card title="Payment Requests" icon="money-bill">
18+
Direct payment collection
19+
</Card>
20+
</CardGroup>
21+
22+
## How It Works
23+
24+
```mermaid
25+
graph TD
26+
A[Create Request] --> B[Generate ID]
27+
B --> C[Store on IPFS]
28+
C --> D[Index on Blockchain]
29+
D --> E[Return Request]
30+
```
31+
32+
**Process:**
33+
1. **Create:** Submit request with payee, payer, and amount details
34+
2. **Store:** Decentralized storage on IPFS
35+
3. **Index:** Blockchain indexing for discovery
36+
4. **Track:** Real-time status monitoring
37+
38+
## Request Properties
39+
40+
### Core Information
41+
- **Payee:** Request creator/recipient
42+
- **Payer:** Payment sender (optional)
43+
- **Amount:** Payment amount and currency
44+
- **Due Date:** Payment deadline
45+
46+
### Payment Configuration
47+
- **Payment Network:** ERC20, ETH, or custom
48+
- **Accepted Tokens:** Supported payment currencies
49+
- **Conversion:** Fiat-denominated crypto payments
50+
51+
## Status Lifecycle
52+
53+
### Request States
54+
- `created` - Request initialized
55+
- `pending` - Awaiting payment
56+
- `paid` - Payment completed
57+
- `cancelled` - Request cancelled
58+
59+
### Payment States
60+
- `no_payment` - No payment detected
61+
- `partially_paid` - Partial payment received
62+
- `paid` - Full payment completed
63+
- `overpaid` - Payment exceeds requested amount
64+
65+
## Query Methods
66+
67+
<CardGroup cols={2}>
68+
<Card title="Single Request" icon="magnifying-glass">
69+
Get specific request by ID
70+
</Card>
71+
72+
<Card title="Batch Queries" icon="list">
73+
Multiple requests in one call
74+
</Card>
75+
</CardGroup>
76+
77+
## Real-time Updates
78+
79+
Combine with [Webhooks & Events](/api-features/webhooks-events) for instant status notifications.
80+
81+
## Implementation Details
82+
83+
See [API Reference - Requests](/api-reference/requests) for complete technical documentation.

‎api-features/crosschain-payments.mdx‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: "Crosschain Payments"
3+
description: "Multi-network payment routing with automatic bridging and optimization"
4+
---
5+
6+
## Overview
7+
8+
Crosschain payments enable seamless transactions across different blockchain networks, allowing payers to send from their preferred chain while payees receive on their preferred network.
9+
10+
## How It Works
11+
12+
```mermaid
13+
graph LR
14+
A[Payer: USDC on Polygon] --> B[Bridge Protocol]
15+
B --> C[Payee: USDC on Base]
16+
```
17+
18+
**Benefits:**
19+
- Access to funds across multiple chains
20+
- Automatic routing optimization
21+
- No manual bridging required
22+
23+
## Samechain Payments
24+
25+
A special case of crosschain infrastructure that converts currencies on the same network (e.g., ETH → USDC on Ethereum).
26+
27+
## Supported Networks
28+
29+
<CardGroup cols={2}>
30+
<Card title="Layer 1" icon="link">
31+
Ethereum, BSC, Avalanche, Fantom
32+
</Card>
33+
34+
<Card title="Layer 2" icon="layers">
35+
Polygon, Arbitrum, Base, Optimism
36+
</Card>
37+
</CardGroup>
38+
39+
## Bridge Protocols
40+
41+
- **LayerZero:** Ultra Light Node security
42+
- **Stargate:** Liquidity-based bridging
43+
- **Automatic Selection:** Optimal route chosen
44+
45+
## Used In
46+
47+
<CardGroup cols={4}>
48+
<Card title="Checkout" href="/use-cases/checkout">
49+
Flexible payment options
50+
</Card>
51+
52+
<Card title="Invoicing" href="/use-cases/invoicing">
53+
Accept from any chain
54+
</Card>
55+
56+
<Card title="Payouts" href="/use-cases/payouts">
57+
Send to preferred networks
58+
</Card>
59+
60+
<Card title="Payroll" href="/use-cases/payroll">
61+
Multi-chain employee payments
62+
</Card>
63+
</CardGroup>
64+
65+
## Implementation Details
66+
67+
See [API Reference - Crosschain Payments](/api-reference/crosschain-payments) for complete technical documentation.

‎api-features/crypto-to-fiat-payments.mdx‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: "Crypto-to-fiat Payments"
3+
description: "USDC payments settled directly to bank accounts with automatic conversion"
4+
---
5+
6+
## Overview
7+
8+
Crypto-to-fiat payments enable seamless conversion from cryptocurrency to traditional bank account deposits, combining the speed of crypto with the familiarity of fiat settlement.
9+
10+
## How It Works
11+
12+
```mermaid
13+
graph LR
14+
A[Payer: USDC] --> B[KYC Verification]
15+
B --> C[Compliance Check]
16+
C --> D[Bank Transfer]
17+
D --> E[Payee: USD in Bank]
18+
```
19+
20+
**Benefits:**
21+
- **Fiat Settlement:** Receive traditional currency in bank accounts
22+
- **Regulatory Compliance:** Built-in KYC and compliance workflows
23+
- **Global Reach:** Support for multiple countries and currencies
24+
25+
## Requirements
26+
27+
<CardGroup cols={2}>
28+
<Card title="Payer KYC" icon="shield-check">
29+
Identity verification required for compliance
30+
</Card>
31+
32+
<Card title="Bank Account" icon="building-columns">
33+
Valid bank account for settlement
34+
</Card>
35+
</CardGroup>
36+
37+
## Supported Networks
38+
39+
- **Production:** USDC on Ethereum, Polygon, Arbitrum
40+
- **Sandbox:** USDC on Sepolia (testing)
41+
42+
## Settlement Time
43+
44+
- **Processing:** 1-3 business days
45+
- **Compliance:** Additional time for KYC verification
46+
47+
## Used In
48+
49+
<CardGroup cols={2}>
50+
<Card title="Invoicing" href="/use-cases/invoicing">
51+
Traditional business payments
52+
</Card>
53+
54+
<Card title="Payroll" href="/use-cases/payroll">
55+
Employee fiat compensation
56+
</Card>
57+
</CardGroup>
58+
59+
## Implementation Details
60+
61+
See [API Reference - Crypto-to-fiat Payments](/api-reference/crypto-to-fiat-payments) for complete technical documentation.

0 commit comments

Comments
 (0)