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
12 changes: 9 additions & 3 deletions api-features/crosschain-payments.mdx
Original file line number Diff line number Diff line change
@@ -1,42 +1,42 @@
---
title: "Crosschain Payments"

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L2

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

<Warning>
**Breaking change (March 2026):** The crosschain payment flow has been redesigned. The old payment-intent signing flow (`POST /v2/request/payment-intents/:paymentIntentId`) has been removed. Crosschain payments now return executable transaction calldata directly. See updated steps below.

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L7

Did you really mean 'crosschain'?

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L7

Did you really mean 'Crosschain'?

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L7

Did you really mean 'calldata'?
</Warning>

## Overview

Crosschain payments allow users to pay a request using a stablecoin from a different blockchain network than the one specified on the request. For example, a payer can pay a request for USDC on Base using USDT from their Optimism wallet. Crosschain routing is powered by [LiFi](https://li.fi/), which aggregates bridges and DEXs to find optimal routes.

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L12

Did you really mean 'Crosschain'?

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L12

Did you really mean 'stablecoin'?

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L12

Did you really mean 'blockchain'?

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L12

Did you really mean 'Crosschain'?

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L12

Did you really mean 'DEXs'?

## Benefits

- **Flexibility:** Payers can pay with their preferred stablecoin on any supported chain.

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L16

Did you really mean 'stablecoin'?
- **Cost-Effective:** Automated routing balances cost and speed.
- **Time-Saving:** Payers don't need to swap or bridge tokens manually.
- **Simplified UX:** Payment settlement requires only 1 or 2 transactions from the payer.

## Crosschain Payments Supported Chains and Currencies

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L21

Did you really mean 'Crosschain'?

For crosschain (and samechain) payments, the Request Network API supports USDC and USDT on 4 chains.

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L23

Did you really mean 'crosschain'?

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L23

Did you really mean 'samechain'?

<Info>
Bridged USDC (USDC.e) is **not** supported for crosschain payments. Only native USDC is supported.

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L26

Did you really mean 'crosschain'?
</Info>

### Supported Chains

- Ethereum

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L31

Did you really mean 'Ethereum'?
- Arbitrum One

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L32

Did you really mean 'Arbitrum'?
- Base
- OP Mainnet

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L34

Did you really mean 'Mainnet'?

### Supported Currencies

<Warning>
Crosschain payments work only with mainnet funds (real money). Test networks are not supported.

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L39

Did you really mean 'Crosschain'?

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L39

Did you really mean 'mainnet'?
</Warning>

- USDC
Expand All @@ -46,7 +46,7 @@

<Steps>
<Step title="Create the request">
Create a request with a `paymentCurrency` in the supported stablecoins and networks, and `amount` greater than 1 (crosschain execution under 1 stablecoin is not allowed).
Create a request with a `paymentCurrency` in the supported stablecoins and networks. The `amount` must be greater than 1 USD equivalent (e.g., at least 1.01 USDC) — crosschain routes are not available for amounts under $1 due to bridge minimums.

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L49

Did you really mean 'stablecoins'?

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L49

Did you really mean 'crosschain'?
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Boundary condition inconsistency: "greater than 1" vs "under $1"

The sentence contains a subtle but meaningful contradiction for developers who test edge cases:

  • First clause: "The amount must be greater than 1 USD equivalent" → strictly > 1.00, so exactly 1.00 USDC is rejected
  • Second clause: "crosschain routes are not available for amounts under $1" → strictly < 1.00, which would imply exactly 1.00 USDC is allowed

A developer who reads both halves could reasonably conclude that 1.00 USDC is a valid amount, only to get a rejection at runtime. The first half is correct; the second half should be aligned with it.

Suggested change
Create a request with a `paymentCurrency` in the supported stablecoins and networks. The `amount` must be greater than 1 USD equivalent (e.g., at least 1.01 USDC) — crosschain routes are not available for amounts under $1 due to bridge minimums.
Create a request with a `paymentCurrency` in the supported stablecoins and networks. The `amount` must be greater than 1 USD equivalent (e.g., at least 1.01 USDC) — crosschain routes are not available for amounts of $1 or less due to bridge minimums.


Create the request via [POST /v2/request](https://api.request.network/open-api/#tag/v2request/POST/v2/request).
</Step>
Expand All @@ -64,10 +64,10 @@

- `chain` and `token` — the source chain and token
- `fee` — total fee as a decimal
- `feeBreakdown[]` — detailed fee components (gas, crosschain, platform)

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L67

Did you really mean 'crosschain'?
- `speed` — `"FAST"` for same-chain, seconds estimate for crosschain

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L68

Did you really mean 'crosschain'?

The API may also return samechain routes when the payer has funds on the same chain as `paymentCurrency`.

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L70

Did you really mean 'samechain'?

```json Example routes response
{
Expand Down Expand Up @@ -137,7 +137,8 @@
"paymentTransactionIndex": 1,
"routeType": "crosschain",
"quoteExpiresAt": 1742205771,
"hasEnoughBalance": true
"hasEnoughBalance": true,
"sourceAmount": "10.02"
}
}
```
Expand All @@ -145,11 +146,16 @@
**Metadata fields:**
- `stepsRequired` — number of transactions to execute (1 or 2)
- `needsApproval` — whether a token approval transaction is needed first
- `approvalTransactionIndex` — index of the approval tx in the array (or `null`)

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L149

Did you really mean 'tx'?
- `paymentTransactionIndex` — index of the payment/bridge tx

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L150

Did you really mean 'tx'?
- `routeType` — `"crosschain"` or `"samechain"`
- `quoteExpiresAt` — unix timestamp when the route quote expires
- `hasEnoughBalance` — whether the payer has sufficient funds
- `sourceAmount` — the amount the payer needs to send on the source chain (includes bridge fees)

<Info>
The API always includes approval transactions in crosschain calldata responses, even if the payer already has sufficient token allowance. This ensures USDT-style tokens (which require resetting allowance to zero before setting a new one) work correctly.

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L157

Did you really mean 'crosschain'?

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/crosschain-payments.mdx#L157

Did you really mean 'calldata'?
</Info>
</Step>

<Step title="Execute the transactions">
Expand All @@ -167,7 +173,7 @@
const [account] = await walletClient.getAddresses();

// Step 1: Send approval transaction (if needed)
if (metadata.needsApproval) {
if (metadata.needsApproval && metadata.approvalTransactionIndex != null) {
const approvalTx = transactions[metadata.approvalTransactionIndex];
const approvalHash = await walletClient.sendTransaction({
account,
Expand Down
7 changes: 7 additions & 0 deletions api-features/payee-destinations.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: "Payee Destinations"
description: "Register and manage receiving routes using ERC-7828 interop addresses"

Check warning on line 3 in api-features/payee-destinations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/payee-destinations.mdx#L3

Did you really mean 'interop'?
---

## Overview

Payee destinations define where payments are received. Each destination encodes a wallet address, chain, and token into a single **ERC-7828 interop address**, creating a unique receiving route.

Check warning on line 8 in api-features/payee-destinations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/payee-destinations.mdx#L8

Did you really mean 'interop'?

Destinations are used by:
- **Secure payments** — to resolve the payee, chain, and token from a `destinationId`
Expand All @@ -13,7 +13,7 @@

## ERC-7828 Address Format

A destination ID combines the interop address with the token address:

Check warning on line 16 in api-features/payee-destinations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/payee-destinations.mdx#L16

Did you really mean 'interop'?

```
{walletAddress}@eip155:{chainId}#{checksum}:{tokenAddress}
Expand All @@ -27,8 +27,13 @@
This encodes:
- **Wallet:** `0x6923831ACf5c327260D7ac7C9DfF5b1c3cB3C7D7`
- **Chain:** Base (chainId `8453`)
- **Checksum:** `ABCD1234` (auto-generated by the API for address verification)
- **Token:** USDC (`0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913`)

<Info>
The checksum portion (`#ABCD1234`) is generated automatically by the API when you create a destination. You do not need to compute it yourself.
</Info>

## How It Works

<Steps>
Expand Down Expand Up @@ -100,6 +105,8 @@
New chain ID.
</ParamField>

Returns the updated destination object (same format as POST response).

### GET /v1/payee-destination

Returns the active payee destination for the authenticated wallet, or `null` if none exists.
Expand Down
15 changes: 13 additions & 2 deletions api-features/payouts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

## Overview

Payouts let you initiate payments without a separate request creation step. The API creates the request and returns executable transaction calldata in a single call.

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

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/payouts.mdx#L8

Did you really mean 'calldata'?

**Three payout modes:**
- **Single** — Pay one recipient
Expand All @@ -14,7 +14,7 @@

## Single Payout

Create a payment request and get transaction calldata in one call.

Check warning on line 17 in api-features/payouts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/payouts.mdx#L17

Did you really mean 'calldata'?

```bash
curl -X POST "https://api.request.network/v2/payouts" \
Expand All @@ -41,11 +41,11 @@
- `customerInfo` — Payer information (name, email, address)
- `payer` — Payer wallet address (required for recurring)

The response includes `requestId` and a `transactions` array with executable calldata.

Check warning on line 44 in api-features/payouts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/payouts.mdx#L44

Did you really mean 'calldata'?

## Batch Payout

Pay multiple recipients in a single blockchain transaction. All payments must be on the same network.

Check warning on line 48 in api-features/payouts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/payouts.mdx#L48

Did you really mean 'blockchain'?

```bash
curl -X POST "https://api.request.network/v2/payouts/batch" \
Expand All @@ -55,13 +55,13 @@
"requests": [
{
"amount": "50",
"invoiceCurrency": "USDC-base",
"invoiceCurrency": "USD",
"paymentCurrency": "USDC-base",
"payee": "0xb07d2398d2004378cad234da0ef14f1c94a530e4"
},
{
"amount": "25",
"invoiceCurrency": "USDC-base",
"invoiceCurrency": "USD",
"paymentCurrency": "USDC-base",
"payee": "0x6923831ACf5c327260D7ac7C9DfF5b1c3cB3C7D7"
}
Expand All @@ -82,8 +82,19 @@
- `POST /v2/payouts` with `recurrence` object — Create a recurring schedule
- `POST /v2/payouts/recurring/:id` — Submit the payer's permit signature to activate
- `GET /v2/payouts/recurring/:id` — Check status and next payment date
- `PATCH /v2/payouts/recurring/:id` — Cancel or unpause

Check warning on line 85 in api-features/payouts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-features/payouts.mdx#L85

Did you really mean 'unpause'?

## Error Handling

| Status | Meaning |
|--------|---------|
| `400` | Invalid request body — check required fields and currency IDs |
| `401` | Authentication failed — verify your `x-api-key` header |
| `404` | Request or recurring payment not found |
| `429` | Rate limited — back off and retry |

For batch payouts, a `400` may indicate that payments span multiple networks (all must be on the same chain).
Comment on lines +88 to +96
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Missing 500 status code in error table

The error table covers client-side errors (400, 401, 404, 429) but omits 500 Internal Server Error. Per the AGENTS.md style guide, API documentation should "Explain all HTTP status codes and error handling." Users hitting a 500 (e.g., during a transient upstream failure) may be confused about whether to retry, and omitting it can lead to silent failures in production integrations.

Consider adding a row:

Status Meaning
500 Server error — safe to retry with exponential backoff

Context Used: AGENTS.md (source)


## Endpoint Reference

<CardGroup cols={2}>
Expand Down
14 changes: 9 additions & 5 deletions api-reference/secure-payments.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Secure Payments API Reference"
description: "Generate secure payment URLs, retrieve payment metadata, and get executable calldata."

Check warning on line 3 in api-reference/secure-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-reference/secure-payments.mdx#L3

Did you really mean 'calldata'?
---

## Endpoints
Expand All @@ -8,8 +8,8 @@
- `POST /v2/secure-payments` — Create a secure payment
- `GET /v2/secure-payments` — Lookup by request ID
- `GET /v2/secure-payments/:token` — Get payment metadata
- `GET /v2/secure-payments/:token/pay` — Get payment calldata

Check warning on line 11 in api-reference/secure-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-reference/secure-payments.mdx#L11

Did you really mean 'calldata'?
- `POST /v2/secure-payments/:token/intent` — Record crosschain payment intent

Check warning on line 12 in api-reference/secure-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-reference/secure-payments.mdx#L12

Did you really mean 'crosschain'?

## Authentication

Expand Down Expand Up @@ -41,11 +41,11 @@
Human-readable payment amount (e.g., `"10.50"`). Must be greater than 0.
</ParamField>

<ParamField body="feePercentage" type="string">

Check warning on line 44 in api-reference/secure-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-reference/secure-payments.mdx#L44

Did you really mean 'feePercentage'?
Optional fee percentage from `0` to `100` (e.g., `"2.5"` for 2.5%).
</ParamField>

<ParamField body="feeAddress" type="string">

Check warning on line 48 in api-reference/secure-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-reference/secure-payments.mdx#L48

Did you really mean 'feeAddress'?
Optional fee recipient address. Required when `feePercentage` is set.
</ParamField>

Expand Down Expand Up @@ -127,7 +127,7 @@

## GET /v2/secure-payments/:token

Retrieve payment metadata and display information. Returns amounts, destination info, status, and optionally crosschain payment options — but **not** executable transaction calldata. Use `/pay` for calldata.

Check warning on line 130 in api-reference/secure-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-reference/secure-payments.mdx#L130

Did you really mean 'crosschain'?

Check warning on line 130 in api-reference/secure-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-reference/secure-payments.mdx#L130

Did you really mean 'calldata'?

Check warning on line 130 in api-reference/secure-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-reference/secure-payments.mdx#L130

Did you really mean 'calldata'?

### Path parameters

Expand All @@ -138,7 +138,7 @@
### Query parameters

<ParamField query="wallet" type="string">
Payer wallet address. When provided, the response includes `paymentOptions` with balance information across supported chains.
Payer wallet address. When provided, the response includes `paymentOptions` with balance information across supported chains. Optional for Tron payments (the API uses a fallback address if omitted).
</ParamField>

<RequestExample>
Expand Down Expand Up @@ -166,7 +166,7 @@
"network": "base"
},
"reference": "ORDER-2024-001",
"paymentOptions": {

Check warning on line 169 in api-reference/secure-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-reference/secure-payments.mdx#L169

Did you really mean 'paymentOptions'?
"BASE": {
"USDC": {
"balance": "150.00",
Expand Down Expand Up @@ -224,26 +224,30 @@

## GET /v2/secure-payments/:token/pay

Retrieve executable transaction calldata for the secure payment. For crosschain payments, provide `chain` and `token` query parameters to select the source route.

Check warning on line 227 in api-reference/secure-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-reference/secure-payments.mdx#L227

Did you really mean 'calldata'?

Check warning on line 227 in api-reference/secure-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-reference/secure-payments.mdx#L227

Did you really mean 'crosschain'?

<Info>
The `:token` in the URL path is the secure payment token (a ULID identifier). The `token` query parameter is the source currency symbol (`USDC` or `USDT`) for crosschain route selection. These are different values.

Check warning on line 230 in api-reference/secure-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-reference/secure-payments.mdx#L230

Did you really mean 'crosschain'?
</Info>

### Path parameters

<ParamField path="token" type="string" required>
Secure payment token.
Secure payment token (ULID returned from `POST /v2/secure-payments`).
</ParamField>

### Query parameters

<ParamField query="wallet" type="string">
Payer wallet address. Used for approval and balance checks.
Payer wallet address. Used for approval and balance checks. Optional for Tron payments (the API uses a fallback address if omitted).
</ParamField>

<ParamField query="chain" type="string">
Source chain for crosschain payments. Values: `BASE`, `OPTIMISM`, `ARBITRUM`, `ETHEREUM`. Must be provided together with `token`.
Source chain for crosschain payments. Values: `BASE`, `OPTIMISM`, `ARBITRUM`, `ETHEREUM`. Must be provided together with the `token` query parameter.

Check warning on line 246 in api-reference/secure-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-reference/secure-payments.mdx#L246

Did you really mean 'crosschain'?
</ParamField>

<ParamField query="token" type="string">
Source token for crosschain payments. Values: `USDC`, `USDT`. Must be provided together with `chain`.
Source currency for crosschain payments. Values: `USDC`, `USDT`. Must be provided together with `chain`.

Check warning on line 250 in api-reference/secure-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-reference/secure-payments.mdx#L250

Did you really mean 'crosschain'?
</ParamField>

<RequestExample>
Expand Down Expand Up @@ -327,7 +331,7 @@

### Error responses

- `400`: invalid calldata request or unsupported crosschain configuration

Check warning on line 334 in api-reference/secure-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-reference/secure-payments.mdx#L334

Did you really mean 'calldata'?

Check warning on line 334 in api-reference/secure-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-reference/secure-payments.mdx#L334

Did you really mean 'crosschain'?
- `403`: token expired or not payable
- `404`: token not found
- `409`: secure payment already completed
Expand All @@ -337,7 +341,7 @@

## POST /v2/secure-payments/:token/intent

Record a crosschain payment intent after the payer broadcasts the source-chain LiFi transaction. This allows the system to track the bridge execution and trigger payment detection on the destination chain.

Check warning on line 344 in api-reference/secure-payments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

api-reference/secure-payments.mdx#L344

Did you really mean 'crosschain'?

### Path parameters

Expand Down
2 changes: 1 addition & 1 deletion resources/supported-chains-and-currencies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@

EVM chains supported for core payment flows include:

**Mainnet:**

Check warning on line 14 in resources/supported-chains-and-currencies.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

resources/supported-chains-and-currencies.mdx#L14

Did you really mean 'Mainnet'?
- Ethereum

Check warning on line 15 in resources/supported-chains-and-currencies.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

resources/supported-chains-and-currencies.mdx#L15

Did you really mean 'Ethereum'?
- Arbitrum One

Check warning on line 16 in resources/supported-chains-and-currencies.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

resources/supported-chains-and-currencies.mdx#L16

Did you really mean 'Arbitrum'?
- OP Mainnet

Check warning on line 17 in resources/supported-chains-and-currencies.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

resources/supported-chains-and-currencies.mdx#L17

Did you really mean 'Mainnet'?
- Base
- Polygon
- BSC
Expand All @@ -22,10 +22,10 @@
- Fantom
- Gnosis
- Mantle
- zkSync Era

Check warning on line 25 in resources/supported-chains-and-currencies.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

resources/supported-chains-and-currencies.mdx#L25

Did you really mean 'zkSync'?

**Testnet:**

Check warning on line 27 in resources/supported-chains-and-currencies.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

resources/supported-chains-and-currencies.mdx#L27

Did you really mean 'Testnet'?
- Sepolia

Check warning on line 28 in resources/supported-chains-and-currencies.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

resources/supported-chains-and-currencies.mdx#L28

Did you really mean 'Sepolia'?

For non-EVM support, Request Network API also supports Tron for USDT TRC-20 payments.

Expand All @@ -38,7 +38,7 @@
</Card>

<Info>
The token list is a superset and may include tokens on chains outside your current payment flow. Cross-reference token entries with supported chains.

Check warning on line 41 in resources/supported-chains-and-currencies.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

resources/supported-chains-and-currencies.mdx#L41

Did you really mean 'superset'?
</Info>

## Conversion Payments Supported Currencies
Expand All @@ -56,12 +56,12 @@
- USDC
- USDT
- DAI
- FAU (Sepolia)

Check warning on line 59 in resources/supported-chains-and-currencies.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

resources/supported-chains-and-currencies.mdx#L59

Did you really mean 'Sepolia'?

## Tron Supported Network and Currency

<Card title="Tron" icon="bolt">
- **Availability:** Mainnet only

Check warning on line 64 in resources/supported-chains-and-currencies.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

resources/supported-chains-and-currencies.mdx#L64

Did you really mean 'Mainnet'?
- **Native Token:** TRX
- **Supported Token:** USDT (TRC-20)
- **Network ID:** `tron`
Expand All @@ -69,7 +69,7 @@
</Card>

<Warning>
Tron uses TRC-20 (not ERC-20). Wallet addresses use the `T...` format.
Tron uses TRC-20 (not ERC-20). Wallet addresses use the `T...` format. The `wallet` parameter is optional for Tron payments — the API uses a fallback address when omitted.
</Warning>

To fetch supported payment currencies for an invoice currency:
Expand All @@ -78,10 +78,10 @@
Get payment currency options available for a given invoice currency.
</Card>

## Crosschain Payments Supported Currencies

Check warning on line 81 in resources/supported-chains-and-currencies.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

resources/supported-chains-and-currencies.mdx#L81

Did you really mean 'Crosschain'?

<Card title="Crosschain Payments" href="/api-features/crosschain-payments#crosschain-payments-supported-chains-and-currencies" icon="shuffle">
View the supported chain/currency matrix for crosschain payments.

Check warning on line 84 in resources/supported-chains-and-currencies.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

resources/supported-chains-and-currencies.mdx#L84

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

## Crypto-to-fiat Payments Supported Currencies
Expand Down
20 changes: 10 additions & 10 deletions use-cases/checkout.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: "Checkout"
icon: "cart-shopping"
description: "Accept crypto payments at point of purchase with automatic payment attribution and instant confirmation"

Check warning on line 4 in use-cases/checkout.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/checkout.mdx#L4

Did you really mean 'crypto'?
---

## Overview

Accept crypto payments at the point of purchase with instant attribution and confirmation. Whether you're running an online store, selling digital goods, or processing event tickets, Request Network enables immediate crypto payments with automatic reconciliation at scale.

Check warning on line 9 in use-cases/checkout.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/checkout.mdx#L9

Did you really mean 'crypto'?

Check warning on line 9 in use-cases/checkout.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/checkout.mdx#L9

Did you really mean 'crypto'?

Unlike traditional crypto payments where customers send funds and you manually match transactions to orders, Request IDs automatically connect each payment to its specific order with cryptographic certainty.

Check warning on line 11 in use-cases/checkout.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/checkout.mdx#L11

Did you really mean 'crypto'?

**What you get:**
- **Instant attribution** - Every payment automatically linked to the correct order via Request ID
Expand Down Expand Up @@ -123,19 +123,19 @@

## Developer Tools

<Card
title="Payment Widget Button"
<Card
title="Payment Widget Button"
icon="credit-card"
href="#"
href="https://checkout.request.network"
>
**Pre-built React checkout component**

Drop-in component for crypto payments—works with Easy Invoice Client IDs or direct API integration.

Check warning on line 133 in use-cases/checkout.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/checkout.mdx#L133

Did you really mean 'crypto'?

- Wallet connection and payment processing included
- Fully customizable styling
- Compatible with all integration options above

[View demo →](https://checkout.request.network)
</Card>

Expand All @@ -155,7 +155,7 @@
</Card>

<Card title="Conversion Payments" icon="exchange">
You price in fiat but want customers to pay in crypto at current exchange rates

Check warning on line 158 in use-cases/checkout.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/checkout.mdx#L158

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

Expand All @@ -164,12 +164,12 @@
### Online Store Checkout
Retailer processes thousands of daily orders with automatic payment attribution.

**Example:** Customers pay in crypto at checkout, each order gets a unique Request ID for automatic matching to the correct order.

Check warning on line 167 in use-cases/checkout.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/checkout.mdx#L167

Did you really mean 'crypto'?

### Digital Goods & Services
Marketplace sells design templates and fonts with instant delivery upon payment.

**Example:** Customer pays in USDC and instantly receives download links. For recurring billing, see [Subscriptions](/use-cases/subscriptions).
**Example:** Customer pays in USDC and instantly receives download links. For recurring billing, see [Recurring Payments](/api-features/recurring-payments).

### Event Ticketing
Venue sells thousands of tickets with automatic NFT ticket delivery.
Expand All @@ -192,9 +192,9 @@
Recommended for checkout - bundles request creation with payment transaction generation
</Card>

<Card
title="Payment Widget Button"
href="#"
<Card
title="Payment Widget Button"
href="https://checkout.request.network"
icon="credit-card"
>
Pre-built React component with wallet connection and payment processing
Expand Down
22 changes: 11 additions & 11 deletions use-cases/invoicing.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: "Invoicing"
icon: "file-invoice"
description: "Create crypto invoices with automatic payment detection and reconciliation"

Check warning on line 4 in use-cases/invoicing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/invoicing.mdx#L4

Did you really mean 'crypto'?
---

## Overview

Bring instant, verifiable payments to your invoicing flow. Generate invoices in fiat or crypto, let customers pay in their preferred token across [10+ EVM chains and Tron](/resources/supported-chains-and-currencies) in 500+ currencies, and receive automatic reconciliation with on-chain payment detection - no manual tracking, no infrastructure overhead.

Check warning on line 9 in use-cases/invoicing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/invoicing.mdx#L9

Did you really mean 'crypto'?

**What you get:**
- **Permanent records** - Invoices stored on <Tooltip tip="InterPlanetary File System - a distributed storage network for permanent data">IPFS</Tooltip> create a tamper-proof audit trail
- **Multi-currency flexibility** - Invoice in USD, get paid in crypto with automatic conversion

Check warning on line 13 in use-cases/invoicing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/invoicing.mdx#L13

Did you really mean 'crypto'?
- **Instant reconciliation** - Every invoice automatically linked to its <Tooltip tip="Blockchain-recorded transaction verified by network validators">on-chain</Tooltip> payment
- **Cross-chain support** - Accept payments across [10+ EVM chains and Tron](/resources/supported-chains-and-currencies) in 500+ currencies
- **Webhook automation** - Real-time payment confirmations for backend integration
Expand Down Expand Up @@ -38,7 +38,7 @@
href="https://easyinvoice.request.network"
icon="external-link"
>
Create invoices, accept crypto payments, and track payment status - all powered by Request Network API

Check warning on line 41 in use-cases/invoicing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/invoicing.mdx#L41

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

**What you'll see:**
Expand Down Expand Up @@ -74,20 +74,20 @@
[Try it now →](https://easyinvoice.request.network)
</Card>

<Card
title="Fork EasyInvoice"
<Card
title="Fork EasyInvoice"
icon="code-fork"
href="#"
href="https://github.com/RequestNetwork/easy-invoice"
>
**Customize for your brand**

Clone and modify the open-source application to match your needs.

- Full source code access
- Custom branding
- Add your own features
[Forking guide →](#)

[View repository →](https://github.com/RequestNetwork/easy-invoice)
</Card>
</CardGroup>

Expand Down Expand Up @@ -171,12 +171,12 @@
Set up your account and get API credentials
</Card>

<Card
title="View Invoicing Examples"
href="#"
<Card
title="View Integration Guide"
href="/api-features/secure-payment-integration-guide"
icon="code"
>
See code examples for common invoicing workflows
See integration examples for payment workflows
</Card>

<Card
Expand Down
2 changes: 1 addition & 1 deletion use-cases/payment-detection.mdx
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
title: "Payment Detection"
icon: "credit-card"
description: "Automatically detect and verify crypto payments with real-time blockchain monitoring and webhooks"

Check warning on line 4 in use-cases/payment-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/payment-detection.mdx#L4

Did you really mean 'crypto'?

Check warning on line 4 in use-cases/payment-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/payment-detection.mdx#L4

Did you really mean 'blockchain'?
---

## Overview

Traditional crypto payments lack business context. You receive a <Tooltip tip="Unique identifier of a transaction recorded on the blockchain">transaction hash,</Tooltip> but don't know which customer, invoice, or order it's for. Manual reconciliation is error-prone and doesn't scale.

Check warning on line 9 in use-cases/payment-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/payment-detection.mdx#L9

Did you really mean 'crypto'?

Request IDs solve this by attaching business context to every payment. Each request gets a unique Request ID that connects payments back to your specific invoice, order, or subscription with cryptographic certainty.

**What you get:**
- **Automatic attribution** - Every payment linked to its request via Request ID
- **Multi-chain monitoring** - Track payments across 9 EVM chains in 150+ currencies
- **Multi-chain monitoring** - Track payments across [10+ EVM chains and Tron](/resources/supported-chains-and-currencies) in 500+ currencies
- **Real-time notifications** - <Tooltip tip="HTTP callbacks that notify your server when payment events occur">Webhooks</Tooltip> for instant payment confirmations
- **Zero manual work** - No spreadsheets, no guessing, no payment collisions

Expand All @@ -26,7 +26,7 @@
</Card>

<Card title="High Payment Volume" icon="chart-line">
Processing hundreds or thousands of crypto payments where manual tracking doesn't scale

Check warning on line 29 in use-cases/payment-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/payment-detection.mdx#L29

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

<Card title="Wallet Management Overhead" icon="key">
Expand All @@ -34,26 +34,26 @@
</Card>

<Card title="Cross-chain Payments" icon="link">
Accepting payments across multiple blockchains and need unified detection without managing multiple APIs

Check warning on line 37 in use-cases/payment-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/payment-detection.mdx#L37

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

## Common Scenarios

### E-commerce Checkout
Accept crypto payments at scale without generating unique addresses for each customer.

Check warning on line 44 in use-cases/payment-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/payment-detection.mdx#L44

Did you really mean 'crypto'?

**Example:** An e-commerce platform processes 10,000+ crypto orders per day. Each order gets a unique Request ID - customers pay to a single wallet address, and every payment is automatically attributed to the correct order.

Check warning on line 46 in use-cases/payment-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/payment-detection.mdx#L46

Did you really mean 'crypto'?

### SaaS Subscriptions
Add crypto as a payment option for recurring billing alongside traditional payment methods.

Check warning on line 49 in use-cases/payment-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/payment-detection.mdx#L49

Did you really mean 'crypto'?

**Example:** A SaaS company uses Stripe for card payments but offers USDC for monthly subscriptions. Payment Detection automatically confirms renewals and updates subscription status without manual tracking.

### Manual Invoices with Crypto Settlement

Check warning on line 53 in use-cases/payment-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/payment-detection.mdx#L53

Did you really mean 'Crypto'?
Send invoices through existing channels (email, PDF) and accept crypto payments with automatic reconciliation.

Check warning on line 54 in use-cases/payment-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/payment-detection.mdx#L54

Did you really mean 'crypto'?

**Example:** A freelancer emails invoices as PDFs with a Request ID. When clients pay in crypto, the accounting software automatically marks invoices as paid via <Tooltip tip="HTTP callbacks that notify your server when payment events occur">webhook</Tooltip> - no manual checking required.

Check warning on line 56 in use-cases/payment-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/payment-detection.mdx#L56

Did you really mean 'PDFs'?

Check warning on line 56 in use-cases/payment-detection.mdx

View check run for this annotation

Mintlify / Mintlify Validation (requestnetwork-docs-add-missing-feature-docs) - vale-spellcheck

use-cases/payment-detection.mdx#L56

Did you really mean 'crypto'?

<Info>
These scenarios all use automatic payment detection. [See technical details on detection methods and configuration →](/api-features/payment-detection)
Expand Down