@siglume/direct-request-payment 0.4.16 → 0.4.17
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/CHANGELOG.md +16 -0
- package/README.md +10 -9
- package/dist/index.cjs +59 -17
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +67 -11
- package/dist/index.d.ts +67 -11
- package/dist/index.js +59 -17
- package/dist/index.js.map +1 -1
- package/docs/merchant-quickstart.md +7 -4
- package/docs/metered-statements.md +2 -2
- package/docs/pricing.md +25 -23
- package/examples/express-checkout.ts +3 -1
- package/package.json +1 -1
package/docs/pricing.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Pricing
|
|
2
2
|
|
|
3
3
|
This page documents the trial-phase merchant pricing for Siglume Direct Request
|
|
4
|
-
Payment as of
|
|
4
|
+
Payment as of SDK v0.4.17. 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
|
|
|
@@ -14,12 +14,13 @@ delayed aggregated settlement whenever they offer amounts in those bands.
|
|
|
14
14
|
## Settlement Currencies
|
|
15
15
|
|
|
16
16
|
Siglume Direct Request Payment launches in the US and Japan, and both settlement
|
|
17
|
-
currencies are first-class:
|
|
17
|
+
currencies are first-class where enabled:
|
|
18
18
|
|
|
19
19
|
- **JPY**, settled on-chain in **JPYC**
|
|
20
20
|
- **USD**, settled on-chain in **USDC**
|
|
21
21
|
|
|
22
|
-
A merchant settles in a single currency, chosen at onboarding.
|
|
22
|
+
A merchant settles in a single currency, chosen at onboarding. Some accounts may
|
|
23
|
+
require agreed USD/USDC terms before USD is enabled. The settlement fee
|
|
23
24
|
percentage (the payment fee column below) is identical in both currencies. Only
|
|
24
25
|
the flat amounts — the monthly base fee and the per-payment minimum fee — are
|
|
25
26
|
quoted per currency.
|
|
@@ -34,8 +35,8 @@ charging.
|
|
|
34
35
|
| Public one-time payment amount | Applied automatically | What you select | Fee | Settlement |
|
|
35
36
|
| --- | --- | --- | --- | --- |
|
|
36
37
|
| JPY 501+ / USD 3.01+ | Standard Payment | Select one Standard plan: Launch, Starter, Growth, or Pro | Launch: JPY 0 / USD 0 monthly, 1.8%; Starter: JPY 980 / USD 6 monthly, 1.0%; Growth: JPY 2,980 / USD 18 monthly, 0.7%; Pro: JPY 9,800 / USD 60 monthly, 0.5%. Minimum JPY 30 / USD 0.20 per payment. | Settled on-chain immediately after the payment confirms |
|
|
37
|
-
| JPY 50-500 / USD 0.31-3.00 | Micro Payment | Applied automatically by amount | JPY 2 / USD 0.01 per SDRP Tx | Aggregated and settled **weekly**, or earlier once the buyer/
|
|
38
|
-
| JPY 1-49 / USD 0.01-0.30 | Nano Payment | Applied automatically by amount | JPY 0.2 / USD 0.001 per SDRP Tx | Aggregated and settled **monthly**, or earlier once the buyer/
|
|
38
|
+
| JPY 50-500 / USD 0.31-3.00 | Micro Payment | Applied automatically by amount | JPY 2 / USD 0.01 per SDRP Tx | Aggregated and settled **weekly**, or earlier once the same buyer / provider / token / pricing band reaches JPY 10,000 / USD 100.00 (see [Settlement schedule](#settlement-schedule)) |
|
|
39
|
+
| JPY 1-49 / USD 0.01-0.30 | Nano Payment | Applied automatically by amount | JPY 0.2 / USD 0.001 per SDRP Tx | Aggregated and settled **monthly**, or earlier once the same buyer / provider / token / pricing band reaches JPY 10,000 / USD 100.00 (see [Settlement schedule](#settlement-schedule)) |
|
|
39
40
|
|
|
40
41
|
In this table, `Tx` means one accepted SDRP payment, not an on-chain settlement
|
|
41
42
|
transaction. Micro / Nano settlement batches are aggregated on-chain after the
|
|
@@ -43,8 +44,8 @@ weekly or monthly close, or earlier when the fixed amount threshold is reached.
|
|
|
43
44
|
|
|
44
45
|
Standard Payment settles per payment. Micro Payment and Nano Payment are
|
|
45
46
|
aggregated and settled in account-assigned weekly / monthly slots, with early
|
|
46
|
-
settlement when the same buyer/
|
|
47
|
-
USD 100.00. See [Settlement schedule](#settlement-schedule) for how each band
|
|
47
|
+
settlement when the same buyer / provider / token / pricing band reaches JPY
|
|
48
|
+
10,000 or USD 100.00. See [Settlement schedule](#settlement-schedule) for how each band
|
|
48
49
|
closes, when the pre-debit notice window elapses, when revenue becomes settled,
|
|
49
50
|
and how rejected requests behave.
|
|
50
51
|
|
|
@@ -65,8 +66,9 @@ field-by-field meaning of `scheduled_debit_at`, `not_before_attempt_at`,
|
|
|
65
66
|
`execution_status`, and `buyer_period_ref`, see
|
|
66
67
|
[Micro / Nano Statements and Notices](./metered-statements.md).
|
|
67
68
|
|
|
68
|
-
USD
|
|
69
|
-
|
|
69
|
+
USD plan prices are set as separate public price points. The JPY 10,000 and USD
|
|
70
|
+
100.00 Micro / Nano early-settlement thresholds are fixed market thresholds,
|
|
71
|
+
not FX conversions of one another.
|
|
70
72
|
|
|
71
73
|
If no paid plan is selected during merchant setup, the merchant account uses the
|
|
72
74
|
Launch plan. A merchant billing mandate is still required before accepting
|
|
@@ -95,25 +97,25 @@ confirmed payment turns into money in your settlement wallet.
|
|
|
95
97
|
| Band | Cadence | Period | You are paid |
|
|
96
98
|
| --- | --- | --- | --- |
|
|
97
99
|
| Standard Payment | Per payment | n/a | On-chain, immediately after each payment confirms |
|
|
98
|
-
| Micro Payment | Weekly, with early threshold settlement | Account-assigned fixed weekly slot in the buyer settlement timezone; the assigned close time is visible through the statement APIs. If
|
|
99
|
-
| Nano Payment | Monthly, with early threshold settlement | Account-assigned fixed monthly slot in the buyer settlement timezone; the assigned close time is visible through the statement APIs. If
|
|
100
|
+
| Micro Payment | Weekly, with early threshold settlement | Account-assigned fixed weekly slot in the buyer settlement timezone; the assigned close time is visible through the statement APIs. If the same buyer / provider / token / pricing band reaches JPY 10,000 or USD 100.00 first, Siglume can close that batch early. | After the period closes or the fixed amount threshold is reached, and the roughly 3-day pre-debit notice window has elapsed, in aggregated on-chain settlement(s) grouped per buyer, provider, token, pricing band, and period |
|
|
101
|
+
| Nano Payment | Monthly, with early threshold settlement | Account-assigned fixed monthly slot in the buyer settlement timezone; the assigned close time is visible through the statement APIs. If the same buyer / provider / token / pricing band reaches JPY 10,000 or USD 100.00 first, Siglume can close that batch early. | After the period closes or the fixed amount threshold is reached, and the roughly 3-day pre-debit notice window has elapsed, in aggregated on-chain settlement(s) grouped per buyer, provider, token, pricing band, and period |
|
|
100
102
|
|
|
101
103
|
### Micro weekly settlement
|
|
102
104
|
|
|
103
105
|
- **Closing period.** Micro-band payments accrue across one weekly period. The
|
|
104
106
|
specific closing weekday and time are assigned as a fixed slot per account to
|
|
105
107
|
spread settlement load.
|
|
106
|
-
- **Early threshold settlement.** If
|
|
107
|
-
10,000 or USD 100.00 before the weekly close,
|
|
108
|
-
early and start the same final-notice and
|
|
109
|
-
100.00 are market-specific fixed
|
|
110
|
-
another.
|
|
108
|
+
- **Early threshold settlement.** If the same buyer / provider / token /
|
|
109
|
+
pricing band reaches JPY 10,000 or USD 100.00 before the weekly close,
|
|
110
|
+
Siglume can close that batch early and start the same final-notice and
|
|
111
|
+
settlement flow. JPY 10,000 and USD 100.00 are market-specific fixed
|
|
112
|
+
thresholds, not FX conversions of one another.
|
|
111
113
|
- **Timezone.** Period boundaries are evaluated in the buyer's configured
|
|
112
114
|
settlement timezone, defaulting to UTC. Assigned slots are persisted and are
|
|
113
115
|
not recalculated on the fly.
|
|
114
116
|
- **Settlement.** After the week closes or the early threshold is reached,
|
|
115
117
|
Siglume aggregates the Micro
|
|
116
|
-
payments — grouped per buyer,
|
|
118
|
+
payments — grouped per buyer, provider, token, pricing band, and period — into on-chain
|
|
117
119
|
settlement(s). Siglume sends the final debit notice first; the on-chain debit
|
|
118
120
|
is not attempted until the scheduled attempt time after an approximately
|
|
119
121
|
3-day pre-debit notice window (`not_before_attempt_at`).
|
|
@@ -125,17 +127,17 @@ confirmed payment turns into money in your settlement wallet.
|
|
|
125
127
|
- **Closing period.** Nano-band payments accrue across one monthly period. The
|
|
126
128
|
specific closing day and time are assigned as a fixed slot per account to
|
|
127
129
|
spread settlement load.
|
|
128
|
-
- **Early threshold settlement.** If
|
|
129
|
-
10,000 or USD 100.00 before the monthly close,
|
|
130
|
-
early and start the same final-notice and
|
|
131
|
-
100.00 are market-specific fixed
|
|
132
|
-
another.
|
|
130
|
+
- **Early threshold settlement.** If the same buyer / provider / token /
|
|
131
|
+
pricing band reaches JPY 10,000 or USD 100.00 before the monthly close,
|
|
132
|
+
Siglume can close that batch early and start the same final-notice and
|
|
133
|
+
settlement flow. JPY 10,000 and USD 100.00 are market-specific fixed
|
|
134
|
+
thresholds, not FX conversions of one another.
|
|
133
135
|
- **Timezone.** As with Micro, period boundaries use the buyer's configured
|
|
134
136
|
settlement timezone, defaulting to UTC. Assigned slots are persisted and are
|
|
135
137
|
not recalculated on the fly.
|
|
136
138
|
- **Settlement.** After the month closes or the early threshold is reached,
|
|
137
139
|
Siglume aggregates the Nano
|
|
138
|
-
payments — grouped per buyer,
|
|
140
|
+
payments — grouped per buyer, provider, token, pricing band, and period — into on-chain
|
|
139
141
|
settlement(s). Siglume sends the final debit notice first; the on-chain debit
|
|
140
142
|
is not attempted until the scheduled attempt time after an approximately
|
|
141
143
|
3-day pre-debit notice window (`not_before_attempt_at`).
|
|
@@ -130,7 +130,9 @@ app.post("/siglume/webhook", express.raw({ type: "application/json" }), asyncRou
|
|
|
130
130
|
app.use((error: unknown, _req: express.Request, res: express.Response, _next: express.NextFunction) => {
|
|
131
131
|
// Log the detail server-side; never return raw error messages to the client —
|
|
132
132
|
// a payment error can otherwise leak internal API details or configuration.
|
|
133
|
-
console.error("checkout error:",
|
|
133
|
+
console.error("checkout error:", {
|
|
134
|
+
name: error instanceof Error ? error.name : "Error",
|
|
135
|
+
});
|
|
134
136
|
res.status(500).json({ error: "internal_error" });
|
|
135
137
|
});
|
|
136
138
|
|