@spritz-finance/api-client 0.4.5 → 0.4.6

package/README.md

@@ -105,6 +105,7 @@ const transactionData = await client.paymentRequest.getWeb3PaymentParams({
 - [Payment Requests](#payment-requests)
   - [Create a payment request](#create-a-payment-request)
   - [Fulfil a payment request (EVM transactions)](#fulfil-a-payment-request--evm-transactions-)
+  - [Fulfil a payment request (Solana transactions)](#fulfil-a-payment-request--solana-transactions-)
   - [Transaction fees](#transaction-fees)
 - [Payments](#payments)
   - [Retrieve the payment for a payment request](#retrieve-the-payment-for-a-payment-request)
@@ -708,6 +709,35 @@ const transactionData = await client.paymentRequest.getWeb3PaymentParams({
 
 The contract address (to), calldata (data), and value are the primary components used to execute the blockchain transaction. You can use the `requiredTokenInput` to verify that the user's wallet has sufficient funds to complete the payment before initiating the transaction.
 
+### Fulfil a payment request (Solana transactions)
+
+For Solana payments, you need to obtain a versioned transaction that can be signed and submitted to the Solana network.
+
+```typescript
+import {PaymentNetwork} from '@spritz-finance/api-client';
+
+const paymentRequest = await client.paymentRequest.create({
+	amount: 100,
+	accountId: account.id,
+	network: PaymentNetwork.Solana,
+});
+
+const transactionData = await client.paymentRequest.getSolanaPaymentParams({
+	paymentRequest,
+	paymentTokenAddress: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v', // USDC on Solana
+	signer: 'YourSolanaWalletAddress...',
+})
+
+// Example response
+
+{
+  versionedTransaction: VersionedTransaction, // Deserialized transaction ready to sign
+  transactionSerialized: 'base64EncodedTransaction...' // Base64 encoded transaction
+}
+```
+
+The `versionedTransaction` is a deserialized Solana transaction that can be signed with your wallet and submitted to the network. The `transactionSerialized` contains the same transaction in base64 encoded format if needed for your implementation.
+
 ### Transaction fees
 
 Transaction fees are applied once the monthly transaction volume exceeds $100. To determine the fee amount for a specific payment value, you can use the following endpoint.

package/dist/spritz-api-client.cjs

@@ -505,4 +505,4 @@ By default, this is deactivated due to the potential risk of exposing your confi
 If you're aware of these risks and have taken necessary security measures, you can enable the \`dangerouslyAllowBrowser\` option, e.g.,
 
 SpritzApiClient.initialize({ apiKey, dangerouslyAllowBrowser: true });
-`)}static initialize({environment:n=or.Sandbox,apiKey:t,integrationKey:i,dangerouslyAllowBrowser:u=!1}){const r=new Bs(n,t,i,u);return r.init(),r}init(){this.client=new Qp({environment:this.environment,apiKey:this.apiKey,integrationKey:this.integrationKey}),this.user=new vb(this.client),this.bankAccount=new W3(this.client),this.paymentRequest=new rb(this.client),this.payment=new A1(this.client),this.onrampPayment=new g1(this.client),this.virtualCard=new Db(this.client),this.bill=new r1(this.client),this.institution=new d1(this.client),this.webhook=new Bb(this.client)}setApiKey(n){return this.apiKey=n,this.init(),this}}var rv=(e=>(e.Ethereum="ethereum",e.Polygon="polygon",e.Optimism="optimism",e.Arbitrum="arbitrum",e.Binance="binance-smart-chain",e.Avalanche="avalanche",e.Bitcoin="bitcoin",e.BitcoinTestnet="bitcoin-testnet",e.Dash="dash",e.DashTestnet="dash-testnet",e))(rv||{});exports.BankAccountSubType=Gf,exports.BankAccountType=et,exports.BillType=Jf,exports.Environment=or,exports.PayableAccountType=Kf,exports.PaymentNetwork=rv,exports.PaymentRequestStatus=Hf,exports.PaymentStatus=Qf,exports.SpritzApiClient=Bs,exports.VirtualCardType=bo;
+`)}static initialize({environment:n=or.Sandbox,apiKey:t,integrationKey:i,dangerouslyAllowBrowser:u=!1}){const r=new Bs(n,t,i,u);return r.init(),r}init(){this.client=new Qp({environment:this.environment,apiKey:this.apiKey,integrationKey:this.integrationKey}),this.user=new vb(this.client),this.bankAccount=new W3(this.client),this.paymentRequest=new rb(this.client),this.payment=new A1(this.client),this.onrampPayment=new g1(this.client),this.virtualCard=new Db(this.client),this.bill=new r1(this.client),this.institution=new d1(this.client),this.webhook=new Bb(this.client)}setApiKey(n){return this.apiKey=n,this.init(),this}}var rv=(e=>(e.Ethereum="ethereum",e.Polygon="polygon",e.Optimism="optimism",e.Arbitrum="arbitrum",e.Binance="binance-smart-chain",e.Avalanche="avalanche",e.Base="base",e.Bitcoin="bitcoin",e.Dash="dash",e.Tron="tron",e.Solana="solana",e.Sui="sui",e))(rv||{});exports.BankAccountSubType=Gf,exports.BankAccountType=et,exports.BillType=Jf,exports.Environment=or,exports.PayableAccountType=Kf,exports.PaymentNetwork=rv,exports.PaymentRequestStatus=Hf,exports.PaymentStatus=Qf,exports.SpritzApiClient=Bs,exports.VirtualCardType=bo;

package/dist/spritz-api-client.d.ts

@@ -1440,10 +1440,12 @@ declare enum PaymentNetwork {
     Arbitrum = "arbitrum",
     Binance = "binance-smart-chain",
     Avalanche = "avalanche",
+    Base = "base",
     Bitcoin = "bitcoin",
-    BitcoinTestnet = "bitcoin-testnet",
     Dash = "dash",
-    DashTestnet = "dash-testnet"
+    Tron = "tron",
+    Solana = "solana",
+    Sui = "sui"
 }
 interface CreatePaymentRequestInput {
     accountId: string;

package/dist/spritz-api-client.mjs

@@ -505,4 +505,4 @@ By default, this is deactivated due to the potential risk of exposing your confi
 If you're aware of these risks and have taken necessary security measures, you can enable the \`dangerouslyAllowBrowser\` option, e.g.,
 
 SpritzApiClient.initialize({ apiKey, dangerouslyAllowBrowser: true });
-`)}static initialize({environment:n=or.Sandbox,apiKey:t,integrationKey:i,dangerouslyAllowBrowser:u=!1}){const r=new Bs(n,t,i,u);return r.init(),r}init(){this.client=new Wp({environment:this.environment,apiKey:this.apiKey,integrationKey:this.integrationKey}),this.user=new pb(this.client),this.bankAccount=new Y3(this.client),this.paymentRequest=new ab(this.client),this.payment=new S1(this.client),this.onrampPayment=new E1(this.client),this.virtualCard=new Bb(this.client),this.bill=new a1(this.client),this.institution=new f1(this.client),this.webhook=new _b(this.client)}setApiKey(n){return this.apiKey=n,this.init(),this}}var iv=(e=>(e.Ethereum="ethereum",e.Polygon="polygon",e.Optimism="optimism",e.Arbitrum="arbitrum",e.Binance="binance-smart-chain",e.Avalanche="avalanche",e.Bitcoin="bitcoin",e.BitcoinTestnet="bitcoin-testnet",e.Dash="dash",e.DashTestnet="dash-testnet",e))(iv||{});export{Mf as BankAccountSubType,et as BankAccountType,Gf as BillType,or as Environment,Hf as PayableAccountType,iv as PaymentNetwork,Jf as PaymentRequestStatus,Kf as PaymentStatus,Bs as SpritzApiClient,bo as VirtualCardType};
+`)}static initialize({environment:n=or.Sandbox,apiKey:t,integrationKey:i,dangerouslyAllowBrowser:u=!1}){const r=new Bs(n,t,i,u);return r.init(),r}init(){this.client=new Wp({environment:this.environment,apiKey:this.apiKey,integrationKey:this.integrationKey}),this.user=new pb(this.client),this.bankAccount=new Y3(this.client),this.paymentRequest=new ab(this.client),this.payment=new S1(this.client),this.onrampPayment=new E1(this.client),this.virtualCard=new Bb(this.client),this.bill=new a1(this.client),this.institution=new f1(this.client),this.webhook=new _b(this.client)}setApiKey(n){return this.apiKey=n,this.init(),this}}var iv=(e=>(e.Ethereum="ethereum",e.Polygon="polygon",e.Optimism="optimism",e.Arbitrum="arbitrum",e.Binance="binance-smart-chain",e.Avalanche="avalanche",e.Base="base",e.Bitcoin="bitcoin",e.Dash="dash",e.Tron="tron",e.Solana="solana",e.Sui="sui",e))(iv||{});export{Mf as BankAccountSubType,et as BankAccountType,Gf as BillType,or as Environment,Hf as PayableAccountType,iv as PaymentNetwork,Jf as PaymentRequestStatus,Kf as PaymentStatus,Bs as SpritzApiClient,bo as VirtualCardType};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spritz-finance/api-client",
-    "version": "0.4.5",
+    "version": "0.4.6",
     "description": "Typescript library for interacting with the Spritz Finance API",
     "type": "module",
     "main": "dist/spritz-api-client.cjs",