@spritz-finance/api-client 0.3.1 → 0.4.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 +27 -0
- package/dist/spritz-api-client.d.ts +265 -148
- package/dist/spritz-api-client.js +107 -53
- package/dist/spritz-api-client.mjs +107 -53
- package/package.json +36 -24
package/README.md
CHANGED
|
@@ -49,6 +49,7 @@ A Typescript library for interacting with the Spritz Finance API
|
|
|
49
49
|
- [Fetch a users virtual card](#fetch-a-users-virtual-card)
|
|
50
50
|
- [Create a US virtual debit card](#create-a-us-virtual-debit-card)
|
|
51
51
|
- [Displaying sensitive card details](#displaying-sensitive-card-details)
|
|
52
|
+
- [Address Book](#address-book)
|
|
52
53
|
- [Renaming accounts](#renaming-accounts)
|
|
53
54
|
- [Rename a bank account](#rename-a-bank-account)
|
|
54
55
|
- [Rename a bill](#rename-a-bill)
|
|
@@ -498,6 +499,32 @@ We currently support and maintain the following packages for the card rendering
|
|
|
498
499
|
- [React Library](https://www.npmjs.com/package/@spritz-finance/react-secure-elements)
|
|
499
500
|
- [React Native Library](https://www.npmjs.com/package/@spritz-finance/react-native-secure-elements)
|
|
500
501
|
|
|
502
|
+
## Address Book
|
|
503
|
+
|
|
504
|
+
Each account created in Spritz is allocated a unique on-chain payment address for each network. Tokens transferred to this address will be picked up and credited to the account. A list of the addresses, one per network, is available under the `paymentAddresses` property. Refer to the Spritz UI for which tokens are accepted for these addresses -- generally, we accept at least USDC and USDT on all networks which we integrate with.
|
|
505
|
+
|
|
506
|
+
```typescript
|
|
507
|
+
[
|
|
508
|
+
{
|
|
509
|
+
id: '62d17d3b377dab6c1342136e',
|
|
510
|
+
name: 'Precious Credit Card',
|
|
511
|
+
type: 'Bill',
|
|
512
|
+
billType: 'CreditCard',
|
|
513
|
+
...
|
|
514
|
+
paymentAddresses: [
|
|
515
|
+
{
|
|
516
|
+
network: 'ethereum',
|
|
517
|
+
address: '0xc0ffee254729296a45a3885639AC7E10F9d54979',
|
|
518
|
+
},
|
|
519
|
+
{
|
|
520
|
+
network: 'polygon',
|
|
521
|
+
address: '0xc0ffee254729296a45a3885639AC7E10F9d54979',
|
|
522
|
+
},
|
|
523
|
+
],
|
|
524
|
+
},
|
|
525
|
+
]
|
|
526
|
+
```
|
|
527
|
+
|
|
501
528
|
## Renaming accounts
|
|
502
529
|
|
|
503
530
|
### Rename a bank account
|