@spritz-finance/api-client 0.4.23 → 0.4.24
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 +15 -0
- package/dist/spritz-api-client.cjs +71 -65
- package/dist/spritz-api-client.d.ts +18 -1
- package/dist/spritz-api-client.mjs +77 -71
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -112,6 +112,7 @@ const transactionData = await client.paymentRequest.getWeb3PaymentParams({
|
|
|
112
112
|
- [Payments](#payments)
|
|
113
113
|
- [Retrieve the payment for a payment request](#retrieve-the-payment-for-a-payment-request)
|
|
114
114
|
- [Retrieve all payments for an account](#retrieve-all-payments-for-an-account)
|
|
115
|
+
- [Get payment limits for an account](#get-payment-limits-for-an-account)
|
|
115
116
|
- [Onramp Payments](#onramp-payments)
|
|
116
117
|
- [Create an onramp payment](#create-onramp-payment)
|
|
117
118
|
- [Retrieve all onramp payments for an account](#retrieve-all-onramp-payments-for-an-account)
|
|
@@ -1078,6 +1079,20 @@ const payments = await client.payment.listForAccount(account.id)
|
|
|
1078
1079
|
]
|
|
1079
1080
|
```
|
|
1080
1081
|
|
|
1082
|
+
### Get payment limits for an account
|
|
1083
|
+
|
|
1084
|
+
Retrieve the payment limits for a specific account, including the per-transaction limit and the remaining daily volume.
|
|
1085
|
+
|
|
1086
|
+
```typescript
|
|
1087
|
+
const limits = await client.payment.getPaymentLimits(account.id)
|
|
1088
|
+
|
|
1089
|
+
// Example response
|
|
1090
|
+
{
|
|
1091
|
+
perTransaction: 20000,
|
|
1092
|
+
dailyRemainingVolume: 150000,
|
|
1093
|
+
}
|
|
1094
|
+
```
|
|
1095
|
+
|
|
1081
1096
|
## Onramp Payments
|
|
1082
1097
|
|
|
1083
1098
|
Onramp Payments are orders to buy crypto stablecoins with a bank transfer. Upon creating an onramp payment, you will receive deposit instructions to fulfill that order. When the bank transfer has been received and disbursed, the status of that onramp payment will change.
|