Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit d20b15c

Browse files
Aimen Sahnoungitbook-bot
authored andcommitted
GITBOOK-161: feat: partial payments documentation
1 parent 7b64b29 commit d20b15c

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

docs/request-network-api/create-and-pay-requests.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,35 @@ At its core, the Request Network API empowers you to:
2020
* **Facilitate Payments:** Return transaction calldata, ready to be signed by end-users and sent to the blockchain for secure and transparent value transfer.
2121
* **Deliver Webhook Notifications:** Receive instant updates on payment status changes, enabling your application to react dynamically to completed transactions.
2222
* **Fee Collection:** When paying a request, you can specify a fee percentage (between 0 and 100) and a fee address, which will add the fee on top of the payment amount - meaning the payer will pay the original amount plus the fee percentage, with the fee portion being sent to the specified fee address.
23+
* **Partial Payment Support:** Pay a portion of a request instead of the full amount at once. This unlocks powerful use cases such as:
24+
25+
* **Split payment**: split a payment 50% USDC on Base and 50% with USDT on Optimism.
26+
* **Gradual payment plans:** Allow users to pay large invoices in smaller chunks.
27+
* **Risk mitigation:** Test with small amounts before completing large payments.
28+
29+
The API automatically tracks payment progress, showing `partially_paid` status until the request is fully paid, and prevents overpayment by capping amounts to the remaining balance.\
30+
2331

2432
{% openapi-operation spec="request-api" path="/v2/request" method="post" %}
25-
[Broken link](broken-reference)
33+
[OpenAPI request-api](https://api.request.network/open-api/openapi.json)
2634
{% endopenapi-operation %}
2735

36+
37+
2838
{% openapi-operation spec="request-api" path="/v2/request/{requestId}" method="get" %}
29-
[Broken link](broken-reference)
39+
[OpenAPI request-api](https://api.request.network/open-api/openapi.json)
3040
{% endopenapi-operation %}
3141

3242
{% openapi-operation spec="request-api" path="/v2/request/{requestId}" method="patch" %}
33-
[Broken link](broken-reference)
43+
[OpenAPI request-api](https://api.request.network/open-api/openapi.json)
3444
{% endopenapi-operation %}
3545

3646
{% openapi-operation spec="request-api" path="/v2/request/{requestId}/pay" method="get" %}
37-
[Broken link](broken-reference)
47+
[OpenAPI request-api](https://api.request.network/open-api/openapi.json)
3848
{% endopenapi-operation %}
3949

4050
{% openapi-operation spec="request-api" path="/v2/payouts" method="post" %}
41-
[Broken link](broken-reference)
51+
[OpenAPI request-api](https://api.request.network/open-api/openapi.json)
4252
{% endopenapi-operation %}
4353

4454
For detailed information on all available endpoints and their parameters, please refer to the full [Request Network API Reference](https://api.request.network/open-api)

0 commit comments

Comments
 (0)