@spritz-finance/api-client 0.4.12 → 0.4.14

package/README.md

@@ -229,7 +229,11 @@ All users must undergo basic identity verification before they can engage with t
 
 ### How to Present Verification Flow to the User
 
-Here are some options on how you can present the `verificationUrl` to the user:
+Spritz offers two methods for integrating KYC verification:
+
+#### Method 1: Verification URL (Simple Integration)
+
+Use the `verificationUrl` for a straightforward integration where Spritz handles the entire verification flow:
 
 - **Browser**: Open the URL in a new browser tab.
 - **In-App**: Embed the URL in an iframe within your application.
@@ -245,6 +249,29 @@ const verifiedCountry = userData.verifiedCountry
 const canRetryVerification = userData.canRetryVerification
 ```
 
+#### Method 2: Verification Token (Advanced Integration)
+
+For more control over the verification experience, use the verification token approach with the Plaid Link SDK:
+
+```typescript
+// Get a verification token from Spritz
+const verificationToken = await client.user.getVerificationToken()
+
+// Use the token with Plaid Link SDK to create a custom verification flow
+// This allows you to:
+// - Customize the UI/UX of the verification process
+// - Handle callbacks and events directly
+// - Integrate verification seamlessly into your application flow
+```
+
+The verification token method is ideal when you want to:
+- Maintain full control over the user experience
+- Integrate verification directly into your app without redirects
+- Handle verification events and callbacks programmatically
+- Build a native mobile experience using Plaid's mobile SDKs
+
+See the [Plaid Link documentation](https://plaid.com/docs/link/) for detailed integration instructions with the verification token.
+
 ## Payment Flow
 
 ### Basic payment flow
@@ -844,6 +871,45 @@ const fees = await client.paymentRequest.transactionPrice(101)
 
 Payments represent a fiat payment that has been issued to the account. Once the status of the Payment Request has moved to `Confirmed` then the Payment will be created.
 
+### Transaction Details
+
+Payments now include transaction details about the blockchain transaction that fulfilled the payment. When a payment is completed, the `transaction` field contains:
+
+- **hash**: The blockchain transaction hash
+- **from**: The wallet address that sent the payment
+- **asset**: The token contract address used for payment
+- **value**: The amount transferred (in the token's smallest unit)
+- **network**: The blockchain network used (e.g., 'ethereum', 'polygon', etc.)
+
+This allows you to track the on-chain transaction that corresponds to each fiat payment.
+
+### Retrieve a payment by ID
+
+You can fetch a payment directly by its ID:
+
+```typescript
+const payment = await client.payment.fetchById('6368e3a3ec516e9572bbd23b');
+
+// Example response
+
+{
+  id: '6368e3a3ec516e9572bbd23b',
+  userId: '63d12d3B577fab6c6382136e',
+  status: 'COMPLETED',
+  accountId: '6322445f10d3f4d19c4d72fe',
+  amount: 100,
+  feeAmount: null,
+  createdAt: '2022-11-07T10:53:23.998Z',
+  transaction: {
+    hash: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+    from: '0xYourWalletAddress',
+    asset: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
+    value: 100000000,
+    network: 'ethereum'
+  }
+}
+```
+
 ### Retrieve the payment for a payment request
 
 ```typescript
@@ -866,7 +932,8 @@ const payment = await client.payment.getForPaymentRequest(paymentRequest.id);
   accountId: '6322445f10d3f4d19c4d72fe',
   amount: 100,
   feeAmount: null,
-  createdAt: '2022-11-07T10:53:23.998Z'
+  createdAt: '2022-11-07T10:53:23.998Z',
+  transaction: null // Will be populated once the payment is fulfilled
 }
 
 ```
@@ -882,11 +949,19 @@ const payments = await client.payment.listForAccount(account.id)
     {
         id: '6368e3a3ec516e9572bbd23b',
         userId: '63d12d3B577fab6c6382136e',
-        status: 'PENDING',
+        status: 'COMPLETED',
         accountId: '6322445f10d3f4d19c4d72fe',
         amount: 100,
         feeAmount: null,
         createdAt: '2022-11-07T10:53:23.998Z',
+        transaction: {
+            __typename: 'BlockchainTransaction',
+            hash: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+            from: '0xYourWalletAddress',
+            asset: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
+            value: 100000000,
+            network: 'ethereum'
+        }
     },
 ]
 ```