From bd5f8c5d48ec08eb580f07da925705095de91b1f Mon Sep 17 00:00:00 2001 From: Aimen Sahnoun Date: Mon, 2 Mar 2026 02:09:48 +0400 Subject: [PATCH] docs(api-features): rewrite partial-payments with endpoint-driven guidance Refactor `api-features/partial-payments.mdx` from AI-generated placeholder content into accurate, implementation-oriented documentation aligned with current Request API behavior. - removed AI warning banner and generic placeholder descriptions - replaced abstract flow with concrete step-based implementation using: - POST /v2/request - GET /v2/request/{requestId}/pay (with `amount` query for partial settlement) - GET /v2/request/{requestId} for status and breakdown tracking - clarified partial payment behavior as incremental settlement on the same request - added guidance on progress/status visibility and conversion breakdown handling - removed hidden/unsupported use-case references (e.g. subscriptions) - kept use-case links only to active pages (invoicing, checkout) - replaced old internal API reference pattern with canonical OpenAPI link: https://api.request.network/open-api --- api-features/partial-payments.mdx | 65 +++++++++++++++++-------------- 1 file changed, 36 insertions(+), 29 deletions(-) diff --git a/api-features/partial-payments.mdx b/api-features/partial-payments.mdx index 2c44750..f74a1e8 100644 --- a/api-features/partial-payments.mdx +++ b/api-features/partial-payments.mdx @@ -3,30 +3,39 @@ title: "Partial Payments" description: "Split payments across multiple transactions and funding sources" --- - -**AI-Generated Content** – This page was generated with AI assistance and may contain inaccuracies. While likely close to accurate, please verify critical details with the [stable documentation](https://docs.request.network) or [contact support](https://github.com/orgs/RequestNetwork/discussions). - - ## Overview -Partial payments allow requests to be fulfilled through multiple transactions, enabling split payments, installment plans, and flexible funding approaches. +Partial payments let you settle a request over multiple transactions instead of one full payment. + +This is useful for installments, split settlement, and staged collections. ## How It Works -```mermaid -graph TD - A[Request: $1000] --> B[Payment 1: $400] - A --> C[Payment 2: $300] - A --> D[Payment 3: $300] - B --> E[Request Fulfilled] - C --> E - D --> E -``` - -**Benefits:** -- **Flexible Payment Plans:** Installments and split payments -- **Multiple Funding Sources:** Different wallets, chains, or currencies -- **Risk Management:** Partial fulfillment tracking + + +Create a request with [POST /v2/request](https://api.request.network/open-api/#tag/v2request/POST/v2/request). + + + +Fetch payment payload with [GET /v2/request/{requestId}/pay](https://api.request.network/open-api/#tag/v2request/GET/v2/request/{requestId}/pay) and pass `amount` in query parameters to pay only part of the request. + +The `amount` query parameter is human-readable and must be greater than 0. + + + +Execute additional partial payments as needed until the request reaches full settlement. + + + +Check [GET /v2/request/{requestId}](https://api.request.network/open-api/#tag/v2request/GET/v2/request/{requestId}) for status and conversion/payment breakdown fields. + + + +## Key Behavior + +- Partial payments are applied incrementally against the same request +- Request status reflects progress until full settlement +- For conversion flows, breakdown fields expose paid vs remaining values ## Use Cases @@ -42,15 +51,17 @@ graph TD ## Supported Payment Types -Works with all payment types except Crypto-to-fiat payments: +Partial settlement can be used in request-based payment flows where payment payloads are fetched via `GET /v2/request/{requestId}/pay`. + +Commonly used with: + - Native & ERC20 payments -- Conversion payments +- Conversion payments - Crosschain payments -- Batch payments ## Used In - + Large invoice installments @@ -58,12 +69,8 @@ Works with all payment types except Crypto-to-fiat payments: Flexible payment options - - - Partial subscription payments - -## Implementation Details +## API Reference -See [API Reference - Partial Payments](/api-reference/partial-payments) for complete technical documentation. \ No newline at end of file +For full endpoint schemas and examples, see [Request Network API Reference](https://api.request.network/open-api).