@siglume/direct-request-payment 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -2
- package/docs/announcement-ja.md +13 -1
- package/docs/api-reference.md +4 -0
- package/docs/merchant-quickstart.md +6 -0
- package/docs/pricing.md +22 -2
- package/docs/security.md +5 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -64,11 +64,29 @@ Current HTTP endpoints live under Siglume's market/API Store route namespace for
|
|
|
64
64
|
compatibility with the existing platform contract. That does not make this SDK an
|
|
65
65
|
API Store publishing SDK.
|
|
66
66
|
|
|
67
|
-
##
|
|
67
|
+
## SDRP Payment Menu Boundary
|
|
68
|
+
|
|
69
|
+
SDRP is the overall protocol name. This SDK covers **Standard Payment** for
|
|
70
|
+
external merchants: checkout, subscription, and scheduled-autopay flows that
|
|
71
|
+
settle through the ordinary DirectPaymentHub wallet-payment rail.
|
|
72
|
+
|
|
73
|
+
The new API Store small-payment menus are separate from this SDK:
|
|
74
|
+
|
|
75
|
+
| SDRP menu | Amount band | Settlement behavior | SDK boundary |
|
|
76
|
+
| --- | --- | --- | --- |
|
|
77
|
+
| Standard Payment | Over JPY 500 / over USD 3.00, or immediate finality required | Buyer confirms payment; DirectPaymentHub settles on-chain immediately | Covered by `@siglume/direct-request-payment` |
|
|
78
|
+
| Micro Payment | JPY 50-500 / about USD 0.30-3.00 | API Store meter gate before provider execution; weekly delayed settlement | Use the API Store flow, not this merchant checkout SDK |
|
|
79
|
+
| Nano Payment | Under JPY 1 to JPY 49 / under USD 0.01 to about USD 0.30 | API Store meter gate before provider execution; monthly delayed settlement | Use the API Store flow, not this merchant checkout SDK |
|
|
80
|
+
|
|
81
|
+
Micro Payment and Nano Payment do not execute an on-chain payment during the
|
|
82
|
+
provider API call. If the buyer has no valid metered budget, scope, or remaining
|
|
83
|
+
limit, Siglume records `rejected_no_charge` and does not call the provider API.
|
|
84
|
+
|
|
85
|
+
## Standard Payment Merchant Pricing
|
|
68
86
|
|
|
69
87
|
Siglume Direct Request Payment is currently offered with trial-phase merchant
|
|
70
88
|
pricing designed for small EC sites, booking services, membership services, paid
|
|
71
|
-
APIs, and
|
|
89
|
+
APIs, and external scheduled-payment experiments.
|
|
72
90
|
|
|
73
91
|
Both launch settlement currencies are first-class: JPY settled in JPYC, and USD
|
|
74
92
|
settled in USDC. A merchant settles in one currency, chosen at onboarding. The
|
package/docs/announcement-ja.md
CHANGED
|
@@ -6,7 +6,7 @@ Siglume Direct Request Payment 向けの外部事業者用SDKを公開しまし
|
|
|
6
6
|
- PyPI: https://pypi.org/project/siglume-direct-request-payment/
|
|
7
7
|
- GitHub: https://github.com/taihei-05/siglume-direct-request-payment
|
|
8
8
|
|
|
9
|
-
このSDKは、外部EC
|
|
9
|
+
このSDKは、外部EC、予約サービス、会員制サービス、有料API、scheduled autopay などで、SDRP の Standard Payment / 通常決済を自社プロダクトに組み込むためのSDKです。
|
|
10
10
|
|
|
11
11
|
## できること
|
|
12
12
|
|
|
@@ -23,6 +23,18 @@ Siglume Direct Request Payment 向けの外部事業者用SDKを公開しまし
|
|
|
23
23
|
|
|
24
24
|
Developer Portal の `cli_` API key を使うSDKではありません。導入設定は merchant の Siglume JWT、支払い作成は buyer の Siglume JWT で行います。
|
|
25
25
|
|
|
26
|
+
## SDRP内の位置づけ
|
|
27
|
+
|
|
28
|
+
SDRP は全体プロトコル名です。このSDKは外部merchant向けの Standard Payment / 通常決済を扱います。
|
|
29
|
+
|
|
30
|
+
| SDRPメニュー | 金額帯 | 精算 |
|
|
31
|
+
| --- | --- | --- |
|
|
32
|
+
| Standard Payment / 通常決済 | JPY 500超 / USD 3.00超、または即時finalityが必要な決済 | DirectPaymentHubで即時オンチェーン分配 |
|
|
33
|
+
| Micro Payment / マイクロペイメント | JPY 50-500 / 約USD 0.30-3.00 | API Storeのmeter gate後、週次後精算 |
|
|
34
|
+
| Nano Payment / ナノペイメント | JPY 1未満-49 / USD 0.01未満-約USD 0.30 | API Storeのmeter gate後、月次後精算 |
|
|
35
|
+
|
|
36
|
+
Micro Payment / Nano Payment はこのMerchant SDKのcheckout flowではありません。API実行前にAPI Store側のmeter gateを通し、予算やscopeに失敗した場合は `rejected_no_charge` として記録され、provider APIは呼ばれません。
|
|
37
|
+
|
|
26
38
|
## 最短導入
|
|
27
39
|
|
|
28
40
|
```ts
|
package/docs/api-reference.md
CHANGED
|
@@ -228,6 +228,10 @@ Thin wrapper around the current Siglume Direct Request Payment HTTP contract.
|
|
|
228
228
|
Use it with the authenticated buyer's Siglume bearer token. Developer Portal
|
|
229
229
|
`cli_` API keys are not accepted by these buyer-authenticated routes.
|
|
230
230
|
|
|
231
|
+
This client creates SDRP Standard Payment requirements for external merchant
|
|
232
|
+
checkout flows. API Store Micro Payment and Nano Payment use the API Store meter
|
|
233
|
+
gate and are not created through this merchant checkout client.
|
|
234
|
+
|
|
231
235
|
Payment requirements include `fee_bps` from the Siglume platform. The SDK does
|
|
232
236
|
not calculate merchant plan fees locally; see [Pricing](./pricing.md).
|
|
233
237
|
|
|
@@ -14,6 +14,12 @@ external merchant.
|
|
|
14
14
|
The merchant server must not create charges with a customer wallet. It signs the
|
|
15
15
|
order challenge; the buyer-facing Siglume payment flow pays it.
|
|
16
16
|
|
|
17
|
+
This quickstart is for SDRP Standard Payment in an external merchant product. If
|
|
18
|
+
you are publishing a Siglume API Store listing that should use Micro Payment or
|
|
19
|
+
Nano Payment, use the API Store flow instead. Micro/Nano run a server-side meter
|
|
20
|
+
gate before provider execution and settle later; they are not browser checkout
|
|
21
|
+
requirements created by this merchant SDK.
|
|
22
|
+
|
|
17
23
|
## 1. Run Merchant Setup
|
|
18
24
|
|
|
19
25
|
Run setup from the merchant server, CI, or an integration agent with the
|
package/docs/pricing.md
CHANGED
|
@@ -1,10 +1,14 @@
|
|
|
1
1
|
# Pricing
|
|
2
2
|
|
|
3
3
|
This page documents the trial-phase merchant pricing for Siglume Direct Request
|
|
4
|
-
Payment as of 2026-06-
|
|
4
|
+
Payment as of 2026-06-18. Pricing can change by agreement or future product
|
|
5
5
|
release; the Siglume platform response is the source of truth for per-payment
|
|
6
6
|
fee data returned at runtime.
|
|
7
7
|
|
|
8
|
+
These prices apply to **SDRP Standard Payment** through the external merchant
|
|
9
|
+
Direct Request Payment SDK. They do not apply to API Store Micro Payment or Nano
|
|
10
|
+
Payment usage events.
|
|
11
|
+
|
|
8
12
|
## Settlement Currencies
|
|
9
13
|
|
|
10
14
|
Siglume Direct Request Payment launches in the US and Japan, and both settlement
|
|
@@ -18,6 +22,22 @@ percentage (the payment fee column below) is identical in both currencies. Only
|
|
|
18
22
|
the flat amounts — the monthly base fee and the per-payment minimum fee — are
|
|
19
23
|
quoted per currency.
|
|
20
24
|
|
|
25
|
+
## SDRP Menu Boundary
|
|
26
|
+
|
|
27
|
+
SDRP is the protocol family. This SDK is for external-merchant Standard Payment:
|
|
28
|
+
one buyer-approved payment, subscription charge, or scheduled-autopay occurrence
|
|
29
|
+
settles through DirectPaymentHub.
|
|
30
|
+
|
|
31
|
+
| SDRP menu | Amount band | Fee model | Settlement cadence |
|
|
32
|
+
| --- | --- | --- | --- |
|
|
33
|
+
| Standard Payment | Over JPY 500 / over USD 3.00, or immediate finality required | Merchant plan percentage with JPY 30 / USD 0.20 minimum | Immediate ordinary wallet settlement |
|
|
34
|
+
| Micro Payment | JPY 50-500 / about USD 0.30-3.00 | USD 0.01 / accepted Tx, about JPY 2 | API Store internal meter, weekly delayed settlement |
|
|
35
|
+
| Nano Payment | Under JPY 1 to JPY 49 / under USD 0.01 to about USD 0.30 | USD 0.001 / accepted usage, about JPY 0.2 | API Store internal meter, monthly delayed settlement |
|
|
36
|
+
|
|
37
|
+
For Micro Payment and Nano Payment, the API Store meter gate runs before provider
|
|
38
|
+
execution. Budget or scope failures are recorded as `rejected_no_charge`; the
|
|
39
|
+
provider API is not called and no pending provider revenue is created.
|
|
40
|
+
|
|
21
41
|
## Trial Plans
|
|
22
42
|
|
|
23
43
|
| Plan | Monthly fee (JPY) | Monthly fee (USD) | Payment fee | Intended starting point |
|
|
@@ -70,4 +90,4 @@ The trial pricing is intended for:
|
|
|
70
90
|
- Booking and reservation services
|
|
71
91
|
- Membership services
|
|
72
92
|
- Paid API access
|
|
73
|
-
-
|
|
93
|
+
- Scheduled autopay for external merchant workflows
|
package/docs/security.md
CHANGED
|
@@ -106,5 +106,9 @@ Direct Request Payment is not:
|
|
|
106
106
|
- escrow
|
|
107
107
|
- a platform balance
|
|
108
108
|
- a card payment fallback
|
|
109
|
+
- the API Store Micro Payment or Nano Payment meter
|
|
109
110
|
|
|
110
|
-
It is a
|
|
111
|
+
It is a Standard Payment wallet gate backed by an on-chain receipt. API Store
|
|
112
|
+
Micro Payment and Nano Payment are separate internal-meter, delayed-settlement
|
|
113
|
+
menus; they must fail closed before provider API execution when the buyer's
|
|
114
|
+
metered budget, scope, or amount band is invalid.
|