@spritz-finance/api-client 0.4.28 → 0.6.0
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 +38 -0
- package/dist/spritz-api-client.cjs +71 -85
- package/dist/spritz-api-client.d.ts +13786 -7167
- package/dist/spritz-api-client.mjs +72 -86
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -88,6 +88,9 @@ const transactionData = await client.paymentRequest.getWeb3PaymentParams({
|
|
|
88
88
|
- [Activation Steps](#activation-steps)
|
|
89
89
|
- [Virtual Accounts](#virtual-accounts)
|
|
90
90
|
- [Supported Tokens](#supported-tokens)
|
|
91
|
+
- [ACH Onramp (Direct Debit)](#ach-onramp-direct-debit)
|
|
92
|
+
- [Sandbox](#sandbox)
|
|
93
|
+
- [Bypassing KYC](#bypassing-kyc)
|
|
91
94
|
- [Webhooks](#webhooks)
|
|
92
95
|
- [Events](#events)
|
|
93
96
|
- [Setup](#setup)
|
|
@@ -812,6 +815,41 @@ const accounts = await client.virtualAccounts.list()
|
|
|
812
815
|
| Solana | USDC, PYUSD |
|
|
813
816
|
| Tron | USDT |
|
|
814
817
|
|
|
818
|
+
## ACH Onramp (Direct Debit)
|
|
819
|
+
|
|
820
|
+
ACH onramp lets users convert USD from their bank account into USDC delivered to a Solana wallet. The flow is:
|
|
821
|
+
|
|
822
|
+
1. **Link bank account** via Plaid → funding source created automatically
|
|
823
|
+
2. **Prepare deposit** — quote and ACH authorization message for the user to review
|
|
824
|
+
3. **Create deposit** — confirm to debit the bank and release USDC to the wallet
|
|
825
|
+
|
|
826
|
+
Authorization is derived from the verified ACH funding source — no wallet signature is required.
|
|
827
|
+
|
|
828
|
+
For a complete walkthrough with code examples, request/response schemas, and deposit lifecycle documentation, see the **[ACH Onramp Integration Guide](docs/ach-onramp-guide.md)**.
|
|
829
|
+
|
|
830
|
+
A standalone sandbox demo is available at `scripts/sandbox/ach-onramp.html` — open it in a browser to walk through the full flow interactively.
|
|
831
|
+
|
|
832
|
+
## Sandbox
|
|
833
|
+
|
|
834
|
+
Use `Environment.Sandbox` for development and testing. The sandbox environment is available at `https://sandbox.spritz.finance`.
|
|
835
|
+
|
|
836
|
+
### Bypassing KYC
|
|
837
|
+
|
|
838
|
+
In sandbox, you can skip identity verification to speed up testing:
|
|
839
|
+
|
|
840
|
+
```typescript
|
|
841
|
+
// Simulate successful US KYC verification
|
|
842
|
+
await client.sandbox.bypassKyc()
|
|
843
|
+
|
|
844
|
+
// Simulate KYC for a specific country
|
|
845
|
+
await client.sandbox.bypassKyc({ country: 'CA' })
|
|
846
|
+
|
|
847
|
+
// Simulate a failed KYC check
|
|
848
|
+
await client.sandbox.bypassKyc({ failed: true })
|
|
849
|
+
```
|
|
850
|
+
|
|
851
|
+
This endpoint returns 403 in production.
|
|
852
|
+
|
|
815
853
|
## Webhooks
|
|
816
854
|
|
|
817
855
|
### Events
|