Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 0 additions & 83 deletions api-features/create-requests-query-status.mdx

This file was deleted.

91 changes: 91 additions & 0 deletions api-features/create-requests.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
title: "Create Requests"
description: "Request creation workflows and configuration for invoices and payment collection"
---

## Overview

Request creation forms the foundation of Request Network operations, enabling structured payment collection through invoice generation and payment request workflows.

## Request Types

<CardGroup cols={2}>
<Card title="Invoice Requests" icon="file-invoice">
Traditional invoicing with payee details
</Card>

<Card title="Payment Requests" icon="money-bill">
Direct payment collection workflows
</Card>
</CardGroup>

## How It Works

```mermaid
graph TD
A[Define Request] --> B[Select Payment Network]
B --> C[Configure Properties]
C --> D[Store on IPFS]
D --> E[Index on Blockchain]
E --> F[Generate Request ID]
```

**Creation Process:**
1. **Define:** Set payee, payer, amount, and currency details
2. **Configure:** Choose payment network and accepted tokens
3. **Store:** Decentralized storage on IPFS
4. **Index:** Blockchain indexing for discovery

Check warning on line 37 in api-features/create-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/create-requests.mdx#L37

Did you really mean 'Blockchain'?
5. **Track:** Real-time status monitoring

## Request Properties

### Core Information
- **Payee:** Request creator/recipient address
- **Payer:** Payment sender address (optional)
- **Amount:** Payment amount and currency
- **Due Date:** Payment deadline (optional)

### Payment Configuration
- **Payment Network:** ERC20, ETH, or specialized networks
- **Accepted Tokens:** Supported payment currencies
- **Conversion Settings:** Fiat-denominated crypto payments

Check warning on line 51 in api-features/create-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/create-requests.mdx#L51

Did you really mean 'crypto'?

## Payment Network Selection

<CardGroup cols={2}>
<Card title="ERC20 Networks" icon="coins">
USDC, USDT, DAI token payments
</Card>

<Card title="Native Networks" icon="ethereum">
ETH, MATIC, BNB direct payments
</Card>
</CardGroup>

### Supported Networks
- **Mainnet:** Ethereum, Polygon, Arbitrum, Optimism

Check warning on line 66 in api-features/create-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/create-requests.mdx#L66

Did you really mean 'Mainnet'?

Check warning on line 66 in api-features/create-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/create-requests.mdx#L66

Did you really mean 'Ethereum'?

Check warning on line 66 in api-features/create-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/create-requests.mdx#L66

Did you really mean 'Arbitrum'?
- **Sidechains:** BSC, Gnosis, Fantom, Avalanche

Check warning on line 67 in api-features/create-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/create-requests.mdx#L67

Did you really mean 'Sidechains'?
- **Testnets:** Sepolia, Mumbai for development

Check warning on line 68 in api-features/create-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/create-requests.mdx#L68

Did you really mean 'Testnets'?

Check warning on line 68 in api-features/create-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/create-requests.mdx#L68

Did you really mean 'Sepolia'?

## Content Data

Attach additional information to requests:
- **Invoice Details:** Line items, tax information
- **Business Information:** Company details, terms
- **Custom Metadata:** Application-specific data

## Used In

<CardGroup cols={2}>
<Card title="Invoicing" href="/use-cases/invoicing">
Business invoice generation
</Card>

<Card title="Payroll" href="/use-cases/payroll">
Employee payment requests
</Card>
</CardGroup>

## Implementation Details

See [API Reference - Create Requests](/api-reference/endpoints/create-request) for complete technical documentation.
101 changes: 101 additions & 0 deletions api-features/query-requests.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
title: "Query Requests"
description: "Request status monitoring, lifecycle management, and information retrieval"
---

## Overview

Query requests provides comprehensive request status monitoring and information retrieval, enabling real-time tracking of payment requests throughout their lifecycle.

## Request Status Lifecycle

<CardGroup cols={2}>
<Card title="Active States" icon="play">
Created, pending, partially paid
</Card>

<Card title="Final States" icon="check">
Paid, cancelled, expired
</Card>
</CardGroup>

## How It Works

```mermaid
graph LR
A[Request ID] --> B[Query Status]
B --> C[Retrieve Info]
C --> D[Check Payments]
D --> E[Update Status]
```

**Query Process:**
1. **Identify:** Use request ID for lookup
2. **Retrieve:** Get current request information
3. **Analyze:** Check payment status and history
4. **Update:** Reflect latest blockchain state

Check warning on line 36 in api-features/query-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/query-requests.mdx#L36

Did you really mean 'blockchain'?

## Status Types

### Request States
- `created` - Request initialized and stored
- `pending` - Awaiting payment completion
- `paid` - Full payment received and confirmed
- `cancelled` - Request cancelled by creator
- `expired` - Past due date without payment

### Payment States
- `no_payment` - No payment transactions detected
- `partially_paid` - Partial payment received
- `paid` - Full payment amount received
- `overpaid` - Payment exceeds requested amount

## Query Methods

<CardGroup cols={2}>
<Card title="Single Request" icon="magnifying-glass">
Detailed status for specific request
</Card>

<Card title="Batch Queries" icon="list">
Multiple request status in one call
</Card>
</CardGroup>

### Information Retrieved
- **Basic Details:** Amount, currency, participants
- **Payment History:** Transaction details and confirmations
- **Status Timeline:** Creation, updates, completion dates
- **Network Data:** Blockchain and transaction information

Check warning on line 69 in api-features/query-requests.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/query-requests.mdx#L69

Did you really mean 'Blockchain'?

## Real-time Monitoring

### Automatic Updates
Combine with [Payment Detection](/api-features/payment-detection) for automatic status updates

### Event Integration
Use [Webhooks & Events](/api-features/webhooks-events) for instant notifications

## Advanced Filtering

Filter requests by:
- **Date Range:** Creation or due date periods
- **Status:** Current request or payment state
- **Participants:** Payee or payer addresses
- **Amount Range:** Minimum and maximum values

## Used In

<CardGroup cols={2}>
<Card title="Dashboard Apps" icon="chart-line">
Real-time payment tracking
</Card>

<Card title="Accounting Systems" icon="calculator">
Invoice status reconciliation
</Card>
</CardGroup>

## Implementation Details

See [API Reference - Query Requests](/api-reference/endpoints/get-request) for complete technical documentation.
Loading
Loading