Skip to content
Open
Show file tree
Hide file tree
Changes from 13 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
56 changes: 56 additions & 0 deletions api-features/batch-payments.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: "Batch Payments"
description: "Process multiple payments in a single transaction for gas optimization"
---

## Overview

Batch payments allow you to process multiple direct or conversion payments in a single blockchain transaction, significantly reducing gas costs and simplifying payment operations.

Check warning on line 8 in api-features/batch-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/batch-payments.mdx#L8

Did you really mean 'blockchain'?

## How It Works

```mermaid
graph TD
A[Multiple Recipients] --> B[Single Transaction]
B --> C[Atomic Execution]
C --> D[All Succeed or All Fail]
```

**Benefits:**
- **Gas Savings:** Up to 60% reduction in total gas costs
- **Atomic Operations:** All payments succeed or fail together
- **Simplified Management:** One transaction to monitor

## Requirements

- All payments must be on the same network
- Supports Native, ERC20, and Conversion payments
- Maximum batch size limited by block gas limit

## Use Cases

<CardGroup cols={2}>
<Card title="Payroll Processing" icon="users">
Pay multiple employees simultaneously
</Card>

<Card title="Vendor Payments" icon="building">
Process multiple supplier invoices
</Card>
</CardGroup>

## Used In

<CardGroup cols={2}>
<Card title="Payroll" href="/use-cases/payroll">
Efficient employee payments
</Card>

<Card title="Payouts" href="/use-cases/payouts">
Bulk vendor payments
</Card>
</CardGroup>

## Implementation Details

See [API Reference - Batch Payments](/api-reference/batch-payments) for complete technical documentation.
54 changes: 54 additions & 0 deletions api-features/conversion-payments.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: "Conversion Payments"
description: "Fiat-denominated requests settled in cryptocurrency with real-time conversion"

Check warning on line 3 in api-features/conversion-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/conversion-payments.mdx#L3

Did you really mean 'cryptocurrency'?
---

## Overview

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.

Check warning on line 8 in api-features/conversion-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/conversion-payments.mdx#L8

Did you really mean 'cryptocurrency'?

## How It Works

```mermaid
graph LR
A[Request: $100 USD] --> B[Real-time Rate]
B --> C[Pay: 0.041 ETH]
C --> D[Receive: 0.041 ETH]
```

**Benefits:**
- Stable pricing in familiar currencies
- Automatic exchange rate handling
- No manual conversion required

## Supported Fiat Currencies

- **USD** - US Dollar
- **EUR** - Euro
- **GBP** - British Pound
- **CNY** - Chinese Yuan
- **JPY** - Japanese Yen

## Exchange Rate Sources

Real-time rates from multiple providers ensure accuracy and reliability.

## Used In

<CardGroup cols={3}>
<Card title="Invoicing" href="/use-cases/invoicing">
Professional invoices in fiat
</Card>

<Card title="Checkout" href="/use-cases/checkout">
E-commerce pricing
</Card>

<Card title="Subscriptions" href="/use-cases/subscriptions">
Predictable subscription pricing
</Card>
</CardGroup>

## Implementation Details

See [API Reference - Conversion Payments](/api-reference/conversion-payments) for complete technical documentation.
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.
67 changes: 67 additions & 0 deletions api-features/crosschain-payments.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: "Crosschain Payments"

Check warning on line 2 in api-features/crosschain-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/crosschain-payments.mdx#L2

Did you really mean 'Crosschain'?
description: "Multi-network payment routing with automatic bridging and optimization"
---

## Overview

Crosschain payments enable seamless transactions across different blockchain networks, allowing payers to send from their preferred chain while payees receive on their preferred network.

Check warning on line 8 in api-features/crosschain-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/crosschain-payments.mdx#L8

Did you really mean 'Crosschain'?

Check warning on line 8 in api-features/crosschain-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/crosschain-payments.mdx#L8

Did you really mean 'blockchain'?

## How It Works

```mermaid
graph LR
A[Payer: USDC on Polygon] --> B[Bridge Protocol]
B --> C[Payee: USDC on Base]
```

**Benefits:**
- Access to funds across multiple chains
- Automatic routing optimization
- No manual bridging required

## Samechain Payments

Check warning on line 23 in api-features/crosschain-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/crosschain-payments.mdx#L23

Did you really mean 'Samechain'?

A special case of crosschain infrastructure that converts currencies on the same network (e.g., ETH → USDC on Ethereum).

Check warning on line 25 in api-features/crosschain-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/crosschain-payments.mdx#L25

Did you really mean 'crosschain'?

Check warning on line 25 in api-features/crosschain-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/crosschain-payments.mdx#L25

Did you really mean 'Ethereum'?

## Supported Networks

<CardGroup cols={2}>
<Card title="Layer 1" icon="link">
Ethereum, BSC, Avalanche, Fantom

Check warning on line 31 in api-features/crosschain-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/crosschain-payments.mdx#L31

Did you really mean 'Ethereum'?
</Card>

<Card title="Layer 2" icon="layers">
Polygon, Arbitrum, Base, Optimism

Check warning on line 35 in api-features/crosschain-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/crosschain-payments.mdx#L35

Did you really mean 'Arbitrum'?
</Card>
</CardGroup>

## Bridge Protocols

- **LayerZero:** Ultra Light Node security
- **Stargate:** Liquidity-based bridging

Check warning on line 42 in api-features/crosschain-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/crosschain-payments.mdx#L42

Did you really mean 'Stargate'?
- **Automatic Selection:** Optimal route chosen

## Used In

<CardGroup cols={4}>
<Card title="Checkout" href="/use-cases/checkout">
Flexible payment options
</Card>

<Card title="Invoicing" href="/use-cases/invoicing">
Accept from any chain
</Card>

<Card title="Payouts" href="/use-cases/payouts">
Send to preferred networks
</Card>

<Card title="Payroll" href="/use-cases/payroll">
Multi-chain employee payments
</Card>
</CardGroup>

## Implementation Details

See [API Reference - Crosschain Payments](/api-reference/crosschain-payments) for complete technical documentation.
61 changes: 61 additions & 0 deletions api-features/crypto-to-fiat-payments.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: "Crypto-to-fiat Payments"
description: "USDC payments settled directly to bank accounts with automatic conversion"
---

## Overview

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.

Check warning on line 8 in api-features/crypto-to-fiat-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/crypto-to-fiat-payments.mdx#L8

Did you really mean 'cryptocurrency'?

Check warning on line 8 in api-features/crypto-to-fiat-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/crypto-to-fiat-payments.mdx#L8

Did you really mean 'crypto'?

## How It Works

```mermaid
graph LR
A[Payer: USDC] --> B[KYC Verification]
B --> C[Compliance Check]
C --> D[Bank Transfer]
D --> E[Payee: USD in Bank]
```

**Benefits:**
- **Fiat Settlement:** Receive traditional currency in bank accounts
- **Regulatory Compliance:** Built-in KYC and compliance workflows
- **Global Reach:** Support for multiple countries and currencies

## Requirements

<CardGroup cols={2}>
<Card title="Payer KYC" icon="shield-check">
Identity verification required for compliance
</Card>

<Card title="Bank Account" icon="building-columns">
Valid bank account for settlement
</Card>
</CardGroup>

## Supported Networks

- **Production:** USDC on Ethereum, Polygon, Arbitrum

Check warning on line 39 in api-features/crypto-to-fiat-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/crypto-to-fiat-payments.mdx#L39

Did you really mean 'Ethereum'?

Check warning on line 39 in api-features/crypto-to-fiat-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/crypto-to-fiat-payments.mdx#L39

Did you really mean 'Arbitrum'?
- **Sandbox:** USDC on Sepolia (testing)

Check warning on line 40 in api-features/crypto-to-fiat-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork) - vale-spellcheck

api-features/crypto-to-fiat-payments.mdx#L40

Did you really mean 'Sepolia'?

## Settlement Time

- **Processing:** 1-3 business days
- **Compliance:** Additional time for KYC verification

## Used In

<CardGroup cols={2}>
<Card title="Invoicing" href="/use-cases/invoicing">
Traditional business payments
</Card>

<Card title="Payroll" href="/use-cases/payroll">
Employee fiat compensation
</Card>
</CardGroup>

## Implementation Details

See [API Reference - Crypto-to-fiat Payments](/api-reference/crypto-to-fiat-payments) for complete technical documentation.
Loading
Loading