@rkfl/transact-server 1.0.7 → 1.0.9

package/README.md

@@ -77,24 +77,197 @@ checkTransaction('12345ABC');
 Use this function to verify that a webhook is valid and trusted before processing its contents. It prevents spoofed requests, data tampering, and unauthorized events.
 This function returns true if the signature is valid, otherwise false.
 
-```
-
+```ts
 function handleWebhook(req, res) {
   const isValid = client.verifyWebhookSignature(req.body);
-​
+
   if (!isValid) {
     console.warn('Webhook signature verification failed');
     return res.status(403).send('Invalid signature');
   }
-​
+
   const payload = JSON.parse(req.body.data.data);
   console.log('Verified Webhook Payload:', payload);
-​
+
   // Process your payload
   res.status(200).send('Webhook received');
 }
 ```
 
+## Payouts SDK (Fiat, Crypto & Admin)
+
+The payouts SDK lets you invite payees, manage KYC, allocate/administer balances, and send fiat or crypto payouts using a single high-level client.
+
+### Payout client setup
+
+```ts
+import { RocketfuelPayouts } from '@rkfl/transact-server';
+
+const payouts = new RocketfuelPayouts({
+  clientId: 'YOUR_ID',
+  clientSecret: 'YOUR_SECRET',
+  merchantId: 'YOUR_MERCHANT_ID',
+  environment: 'sandbox', // 'production' | 'qa' | 'preprod' | 'sandbox'
+});
+```
+
+The `RocketfuelPayouts` client exposes three scoped clients:
+
+- **Fiat payouts**: `payouts.fiat`
+- **Crypto payouts**: `payouts.crypto`
+- **Admin operations**: `payouts.admin`
+
+### Fiat payouts (bank payouts)
+
+```ts
+// Get bank configuration for a payee
+const bankConfig = await payouts.fiat.getBankConfiguration({
+  payeeId: 'payee-id',
+  country: 'US',
+  currency: 'USD',
+});
+
+// Save/update bank details
+await payouts.fiat.saveBankDetails('payee-id', {
+  currency: 'USD',
+  country: 'US',
+  // ...bank fields as required by bankConfig
+});
+
+// Get transfer fee quote
+const feeQuote = await payouts.fiat.getTransferFee(
+  { payeeId: 'payee-id', country: 'US', currency: 'USD' },
+  {
+    amount: '100.00',
+    currency: 'USD',
+    country: 'US',
+  },
+);
+
+// Send a fiat transfer
+const transferResult = await payouts.fiat.transfer(
+  { payeeId: 'payee-id', country: 'US', currency: 'USD' },
+  {
+    amount: '100.00',
+    currency: 'USD',
+    country: 'US',
+    // ...bank detail reference / additional payload
+  },
+);
+
+// Check transfer status (fiat or generic payout)
+const status = await payouts.fiat.getTransferStatus('order-id', 'payee-id');
+```
+
+### Crypto payouts
+
+```ts
+// Get payout currencies available for a payee
+const currencies = await payouts.crypto.getCurrencies('payee-id');
+
+// Optionally check address risk/compliance
+await payouts.crypto.checkAddress({
+  address: '0x...',
+  chain: 'ETH',
+  // ...other KYT fields
+});
+
+// Get crypto transfer fee quote
+const cryptoFee = await payouts.crypto.getTransferFee('payee-id', {
+  amount: '10',
+  currency: 'ETH',
+  chain: 'ETH',
+});
+
+// Prepare/validate transfer
+const check = await payouts.crypto.checkTransfer('payee-id', {
+  amount: '10',
+  currency: 'ETH',
+  chain: 'ETH',
+  toAddress: '0x...',
+});
+
+// Execute crypto transfer
+const tx = await payouts.crypto.transfer('payee-id', {
+  amount: '10',
+  currency: 'ETH',
+  chain: 'ETH',
+  toAddress: '0x...',
+});
+
+// Check transfer status (crypto or generic payout)
+const cryptoStatus = await payouts.crypto.getTransferStatus('order-id', 'payee-id');
+```
+
+### Payout admin operations
+
+```ts
+// Invite a new payee
+const newPayee = await payouts.admin.invitePayee({
+  email: 'user@example.com',
+  // ...other payee fields
+});
+
+// Submit KYC for a payee
+await payouts.admin.submitPayeeKyc({
+  payeeId: newPayee.id,
+  // ...KYC payload
+});
+
+// Get a payee's internal balance
+const payeeBalance = await payouts.admin.getPayeeBalance('payee-id');
+
+// Get overall payout admin balance and running balance
+const adminBalance = await payouts.admin.getBalance();
+const runningBalance = await payouts.admin.getRunningBalance();
+
+// Create an allocation transfer
+const allocation = await payouts.admin.createTransferAllocation({
+  payeeId: 'payee-id',
+  amount: '100.00',
+  currency: 'USD',
+  // ...other allocation fields
+});
+
+// Confirm / allocate a transfer
+await payouts.admin.allocateTransfer(allocation.id, {
+  action: 'CONFIRM', // or other allocation actions supported by backend
+});
+```
+
+### Payout webhook verification & events
+
+Use the payout webhook helper to validate webhook signatures and use typed event names:
+
+```ts
+import {
+  PayoutWebhookVerifier,
+  PAYOUT_WEBHOOK_EVENT_TYPE,
+  PAYOUT_WEBHOOK_EVENTS,
+} from '@rkfl/transact-server';
+
+function handlePayoutWebhook(req, res) {
+  const isValid = PayoutWebhookVerifier.verify(req.body);
+
+  if (!isValid) {
+    console.warn('Payout webhook signature verification failed');
+    return res.status(403).send('Invalid signature');
+  }
+
+  // Top-level event metadata
+  const { event, notificationType, timestamp } = req.body;
+
+  // Canonical payload string signed by Rocketfuel
+  const payload = JSON.parse(req.body.data);
+
+  if (event === PAYOUT_WEBHOOK_EVENTS.PayoutStatusChange) {
+    // handle payout status change
+  }
+
+  return res.status(200).send('OK');
+}
+```
+
 ## 📦 NPM Commands Documentation
 ### 1. npm:login
 

package/dist/index.d.ts

@@ -1,14 +1,2 @@
-import type { CartData, Environment } from './constants';
-export declare class Rocketfuel {
-    #private;
-    constructor({ clientId, clientSecret, merchantId, environment, }: {
-        clientId: string;
-        clientSecret: string;
-        merchantId: string;
-        environment: Environment;
-    });
-    createOrder(payload: CartData): Promise<any>;
-    transactionLookup(txId: string, type?: 'ORDERID' | 'TXID'): Promise<any>;
-    verifyAgeVerification(auditId: string): Promise<any>;
-    verifyWebhookSignature(body: any): boolean;
-}
+export * from './payins';
+export * from './payouts';

package/dist/index.js

@@ -1,2 +1,2 @@
-import t from"crypto-js";import*as e from"crypto";const s={production:"https://app.rocketfuel.inc/api",qa:"https://qa-app.rfdemo.co/api",preprod:"https://preprod-app.rocketdemo.net/api",sandbox:"https://app-sandbox.rocketfuel.inc/api"};class r{#t;#e;#s;#r;#n=null;#a=null;constructor({clientId:t,clientSecret:e,merchantId:r,environment:n}){this.#t=t,this.#e=e,this.#s=r,this.#r=s[n||"production"]}#i(){const e=JSON.stringify({merchantId:this.#s,totop:""});return t.AES.encrypt(e,this.#e).toString()}#o(){const t={"Content-Type":"application/json"};return this.#n&&(t.Authorization=`Bearer ${this.#n}`),t}async#c(){const t={clientId:this.#t,encryptedPayload:this.#i()},e=await fetch(`${this.#r}/auth/generate-auth-token`,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(t)});if(!e.ok)throw new Error(`Auth failed: ${e.status}`);const s=await e.json(),r=s?.result;if(!r?.access)throw new Error("Token missing in response");this.#n=r.access,this.#a=r.refresh}async#h(t,e,s=!0){const r=await fetch(t,e);if(403===r.status&&s){console.warn(`Received 403, refreshing token and retrying: ${t}`),await this.#c();const s={...e,headers:this.#o()};return this.#h(t,s,!1)}if(!r.ok){const t=new Error(r.statusText);throw t.status=r.status,t}return r.json()}async createOrder(t){this.#n||await this.#c();const e=await this.#h(`${this.#r}/hosted-page`,{method:"POST",headers:this.#o(),body:JSON.stringify(t)});return{uuid:e?.result?.uuid}}async transactionLookup(t,e="ORDERID"){this.#n||await this.#c();const s=await this.#h(`${this.#r}/purchase/transactionLookup`,{method:"POST",headers:this.#o(),body:JSON.stringify({txId:t,type:e})});return s?.result}async verifyAgeVerification(t){this.#n||await this.#c();const e=await this.#h(`${this.#r}/merchant/audit/${t}`,{method:"GET",headers:this.#o()});return e?.result}verifyWebhookSignature(t){try{const{data:{data:s},signature:r}=t,n=e.createVerify("RSA-SHA256");return n.update(s),n.verify("-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2e4stIYooUrKHVQmwztC\n/l0YktX6uz4bE1iDtA2qu4OaXx+IKkwBWa0hO2mzv6dAoawyzxa2jmN01vrpMkMj\nrB+Dxmoq7tRvRTx1hXzZWaKuv37BAYosOIKjom8S8axM1j6zPkX1zpMLE8ys3dUX\nFN5Dl/kBfeCTwGRV4PZjP4a+QwgFRzZVVfnpcRI/O6zhfkdlRah8MrAPWYSoGBpG\nCPiAjUeHO/4JA5zZ6IdfZuy/DKxbcOlt9H+z14iJwB7eVUByoeCE+Bkw+QE4msKs\naIn4xl9GBoyfDZKajTzL50W/oeoE1UcuvVfaULZ9DWnHOy6idCFH1WbYDxYYIWLi\nAQIDAQAB\n-----END PUBLIC KEY-----",r,"base64")}catch(t){return console.error("Signature verification failed:",t),!1}}}export{r as Rocketfuel};
+import e from"crypto-js";import*as t from"crypto";const s={production:"https://app.rocketfuel.inc/api",qa:"https://qa-app.rfdemo.co/api",preprod:"https://preprod-app.rocketdemo.net/api",sandbox:"https://app-sandbox.rocketfuel.inc/api"};class a{#e;#t;#s;#a;#r=null;#n=null;constructor({clientId:e,clientSecret:t,merchantId:a,environment:r}){this.#e=e,this.#t=t,this.#s=a,this.#a=s[r||"production"]}#i(){const t=JSON.stringify({merchantId:this.#s,totop:""});return e.AES.encrypt(t,this.#t).toString()}#o(){const e={"Content-Type":"application/json"};return this.#r&&(e.Authorization=`Bearer ${this.#r}`),e}async#c(){const e={clientId:this.#e,encryptedPayload:this.#i()},t=await fetch(`${this.#a}/auth/generate-auth-token`,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(e)});if(!t.ok)throw new Error(`Auth failed: ${t.status}`);const s=await t.json(),a=s?.result;if(!a?.access)throw new Error("Token missing in response");this.#r=a.access,this.#n=a.refresh}async#h(e,t,s=!0){const a=await fetch(e,t);if((401===a.status||403===a.status)&&s){await this.#c();const s={...t,headers:this.#o()};return this.#h(e,s,!1)}if(!a.ok){const e=new Error(a.statusText);throw e.status=a.status,e}return a.json()}async createOrder(e){this.#r||await this.#c();const t=await this.#h(`${this.#a}/hosted-page`,{method:"POST",headers:this.#o(),body:JSON.stringify(e)});return{uuid:t?.result?.uuid}}async transactionLookup(e,t="ORDERID"){this.#r||await this.#c();const s=await this.#h(`${this.#a}/purchase/transactionLookup`,{method:"POST",headers:this.#o(),body:JSON.stringify({txId:e,type:t})});return s?.result}async verifyAgeVerification(e){this.#r||await this.#c();const t=await this.#h(`${this.#a}/merchant/audit/${e}`,{method:"GET",headers:this.#o()});return t?.result}verifyWebhookSignature(e){try{const{data:{data:s},signature:a}=e,r=t.createVerify("RSA-SHA256");return r.update(s),r.verify("-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2e4stIYooUrKHVQmwztC\n/l0YktX6uz4bE1iDtA2qu4OaXx+IKkwBWa0hO2mzv6dAoawyzxa2jmN01vrpMkMj\nrB+Dxmoq7tRvRTx1hXzZWaKuv37BAYosOIKjom8S8axM1j6zPkX1zpMLE8ys3dUX\nFN5Dl/kBfeCTwGRV4PZjP4a+QwgFRzZVVfnpcRI/O6zhfkdlRah8MrAPWYSoGBpG\nCPiAjUeHO/4JA5zZ6IdfZuy/DKxbcOlt9H+z14iJwB7eVUByoeCE+Bkw+QE4msKs\naIn4xl9GBoyfDZKajTzL50W/oeoE1UcuvVfaULZ9DWnHOy6idCFH1WbYDxYYIWLi\nAQIDAQAB\n-----END PUBLIC KEY-----",a,"base64")}catch(e){return console.error("Signature verification failed:",e),!1}}}const r={production:"https://app.rocketfuel.inc/api",qa:"https://qa-app.rfdemo.co/api",preprod:"https://preprod-app.rocketdemo.net/api",sandbox:"https://app-sandbox.rocketfuel.inc/api"};class n{clientId;clientSecret;merchantId;domain;accessToken=null;refreshToken=null;constructor({clientId:e,clientSecret:t,merchantId:s,environment:a}){this.clientId=e,this.clientSecret=t,this.merchantId=s,this.domain=r[a||"production"]}getAuthPayload(){const t=JSON.stringify({merchantId:this.merchantId,totop:""});return e.AES.encrypt(t,this.clientSecret).toString()}getHeaders(){const e={"Content-Type":"application/json"};return this.accessToken&&(e.Authorization=`Bearer ${this.accessToken}`),e}async getAccessToken(){const e={clientId:this.clientId,encryptedPayload:this.getAuthPayload()},t=await fetch(`${this.domain}/auth/generate-auth-token`,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(e)});if(!t.ok)throw new Error(`Auth failed: ${t.status}`);const s=await t.json(),a=s?.result;if(!a?.access)throw new Error("Token missing in response");this.accessToken=a.access,this.refreshToken=a.refresh}async requestWithRetry(e,t,s=!0){const a=await fetch(e,t);if((401===a.status||403===a.status)&&s){await this.getAccessToken();const s={...t,headers:this.getHeaders()};return this.requestWithRetry(e,s,!1)}if(!a.ok){const e=new Error(a.statusText);throw e.status=a.status,e}return a.json()}}class i extends n{constructor(e){super(e)}async getBankConfiguration(e){this.accessToken||await this.getAccessToken();const t=new URLSearchParams({payeeId:e.payeeId,currency:e.currency,country:e.country});e.destinationRecordId&&t.set("destinationRecordId",e.destinationRecordId);const s=`${this.domain}/payout/fiat/bank-configuration?${t.toString()}`,a=await this.requestWithRetry(s,{method:"GET",headers:this.getHeaders()}),r=new URLSearchParams({payeeId:e.payeeId}),n=`${this.domain}/payout/fiat/personal-field-values?${r.toString()}`,i=await this.requestWithRetry(n,{method:"GET",headers:this.getHeaders()}),o=a?.result??a,c=i?.result?.fields;if(c&&o){const e=Object.keys(c),t={};return Object.keys(o).forEach(s=>{t[s]=o[s].map(t=>(e.indexOf(t.name)>-1&&(t.acceptedValues=c[t.name]),t))}),console.debug("fetched personal field values and appended it"),t}return console.debug("no personal field values found"),o}async getStatus(e){this.accessToken||await this.getAccessToken();const t=new URLSearchParams({payeeId:e.payeeId,country:e.country,currency:e.currency}),s=`${this.domain}/payout/services?${t.toString()}`,a=await this.requestWithRetry(s,{method:"GET",headers:this.getHeaders()});return a?.result??a}async shouldShowExternalPayeeForm(e){this.accessToken||await this.getAccessToken();const t=new URLSearchParams({payeeId:e}),s=`${this.domain}/payout/user/create/external/check?${t.toString()}`,a=await this.requestWithRetry(s,{method:"GET",headers:this.getHeaders()});return a?.result??a}async createPayeeUserExternal(e){this.accessToken||await this.getAccessToken();const t=`${this.domain}/payout/user/create/external?payeeId=${e.payeeId}`,s=await this.requestWithRetry(t,{method:"POST",headers:this.getHeaders(),body:JSON.stringify({fName:e.fName,lName:e.lName,email:e.email,country:e.country})});return s?.result??s}async getPublicCountries(e){const t=`${this.domain}/payout/countries?payeeId=${e}`,s=await this.requestWithRetry(t,{method:"GET",headers:this.getHeaders()});return s?.result??s}async getCountries(e){this.accessToken||await this.getAccessToken();const t=new URLSearchParams;e.payeeId&&t.set("payeeId",e.payeeId),e.currency&&t.set("currency",e.currency);const s=`${this.domain}/payout/fiat/country${t.toString()?`?${t.toString()}`:""}`,a=await this.requestWithRetry(s,{method:"GET",headers:this.getHeaders()});return a?.result??a}async getCurrencies(e){this.accessToken||await this.getAccessToken();const t=new URLSearchParams({payeeId:e.payeeId});e.country&&t.set("country",e.country);const s=`${this.domain}/payout/fiat/currency?${t.toString()}`,a=await this.requestWithRetry(s,{method:"GET",headers:this.getHeaders()});return a?.result??a}async saveBankDetails(e,t,s){this.accessToken||await this.getAccessToken();const a=new URLSearchParams({payeeId:e,currency:t.currency,country:t.country});s?.oldDestinationRecordId&&a.set("oldDestinationRecordId",s.oldDestinationRecordId);const r=`${this.domain}/payout/fiat/bank-configuration?${a.toString()}`,n=await this.requestWithRetry(r,{method:"POST",headers:this.getHeaders(),body:JSON.stringify(t)});return n?.result??n}async deleteBankDetails(e){this.accessToken||await this.getAccessToken();const t=new URLSearchParams({payeeId:e.payeeId}),s=`${this.domain}/payout/fiat/bank/${encodeURIComponent(e.bankId)}?${t.toString()}`,a=await this.requestWithRetry(s,{method:"DELETE",headers:this.getHeaders()});return a?.result??a}async listBankDetails(e){this.accessToken||await this.getAccessToken();const t=new URLSearchParams({payeeId:e.payeeId}),s=`${this.domain}/payout/fiat/bank-detail?${t.toString()}`,a=await this.requestWithRetry(s,{method:"GET",headers:this.getHeaders()});return a?.result??a}async getTransferFee(e,t){this.accessToken||await this.getAccessToken();const s=new URLSearchParams({payeeId:e.payeeId,country:e.country,currency:e.currency}),a=`${this.domain}/payout/fiat/fees?${s.toString()}`,r=await this.requestWithRetry(a,{method:"POST",headers:this.getHeaders(),body:JSON.stringify(t)});return r?.result??r}async transfer(e,t){this.accessToken||await this.getAccessToken();const s=new URLSearchParams({payeeId:e.payeeId,country:e.country,currency:e.currency}),a=`${this.domain}/payout/fiat/transfer?${s.toString()}`,r=await this.requestWithRetry(a,{method:"POST",headers:this.getHeaders(),body:JSON.stringify(t)});return r?.result??r}async getTransferStatus(e,t){this.accessToken||await this.getAccessToken();const s=new URLSearchParams({payeeId:t}),a=`${this.domain}/payout/order/${encodeURIComponent(e)}?${s.toString()}`,r=await this.requestWithRetry(a,{method:"GET",headers:this.getHeaders()});return r?.result??r}async getPaymentMethods(e){this.accessToken||await this.getAccessToken();const t=new URLSearchParams({amount:e.amount});e.payeeId&&t.set("payeeId",e.payeeId),e.country&&t.set("country",e.country),e.currency&&t.set("currency",e.currency);const s=`${this.domain}/payout/fiat/payment-methods?${t.toString()}`,a=await this.requestWithRetry(s,{method:"GET",headers:this.getHeaders()});return a?.result??a}async getFiatOptions(e){this.accessToken||await this.getAccessToken();const t=new URLSearchParams({country:e.country,amount:String(e.amount),type:e.type});e.payeeId&&t.set("payeeId",e.payeeId);const s=`${this.domain}/payout/fiat/options?${t.toString()}`,a=await this.requestWithRetry(s,{method:"GET",headers:this.getHeaders()});return a?.result??a}async getFileUploadUrl(e){this.accessToken||await this.getAccessToken();const t=new URLSearchParams({contentType:e.contentType});e.payeeId&&t.set("payeeId",e.payeeId);const s=`${this.domain}/payout/files/upload-url?${t.toString()}`,a=await this.requestWithRetry(s,{method:"GET",headers:this.getHeaders()});return a?.result??a}async getComplianceStatus(e){this.accessToken||await this.getAccessToken();const t=new URLSearchParams({country:e.country,service:e.service});e.destinationRecordId&&t.set("destinationRecordId",e.destinationRecordId),e.payeeId&&t.set("payeeId",e.payeeId);const s=`${this.domain}/payout/compliance-status?${t.toString()}`,a=await this.requestWithRetry(s,{method:"GET",headers:this.getHeaders()});return a?.result??a}}class o extends n{constructor(e){super(e)}async getCurrencies(e){this.accessToken||await this.getAccessToken();const t=`${this.domain}/payout/currencies?payeeId=${encodeURIComponent(e)}`,s=await this.requestWithRetry(t,{method:"GET",headers:this.getHeaders()});return s?.result}async checkAddress(e){this.accessToken||await this.getAccessToken();return await this.requestWithRetry(`${this.domain}/payout/know-your-address`,{method:"POST",headers:this.getHeaders(),body:JSON.stringify(e)})}async getTransferFee(e,t){this.accessToken||await this.getAccessToken();const s=`${this.domain}/payout/fee?payeeId=${encodeURIComponent(e)}`,a=await this.requestWithRetry(s,{method:"POST",headers:this.getHeaders(),body:JSON.stringify(t)});return a?.result}async checkTransfer(e,t){this.accessToken||await this.getAccessToken();const s=`${this.domain}/payout/withdraw-check?payeeId=${encodeURIComponent(e)}`,a=await this.requestWithRetry(s,{method:"POST",headers:this.getHeaders(),body:JSON.stringify(t)});return a?.result}async transfer(e,t){this.accessToken||await this.getAccessToken();const s=`${this.domain}/payout/withdraw?payeeId=${encodeURIComponent(e)}`,a=await this.requestWithRetry(s,{method:"POST",headers:this.getHeaders(),body:JSON.stringify(t)});return a?.result}async getTransferStatus(e,t){this.accessToken||await this.getAccessToken();const s=new URLSearchParams({payeeId:t}),a=`${this.domain}/payout/order/${encodeURIComponent(e)}?${s.toString()}`,r=await this.requestWithRetry(a,{method:"GET",headers:this.getHeaders()});return r?.result??r}}class c extends n{constructor(e){super(e)}async invitePayee(e){this.accessToken||await this.getAccessToken();const t=await this.requestWithRetry(`${this.domain}/payout/external/payee`,{method:"POST",headers:this.getHeaders(),body:JSON.stringify(e)});return t?.result}async submitPayeeKyc(e){this.accessToken||await this.getAccessToken();const t=await this.requestWithRetry(`${this.domain}/compliance/kyc`,{method:"POST",headers:this.getHeaders(),body:JSON.stringify(e)});return t?.result}async getPayeeBalance(e){this.accessToken||await this.getAccessToken();const t=await this.requestWithRetry(`${this.domain}/payout-admin/payee/${encodeURIComponent(e)}/balance`,{method:"GET",headers:this.getHeaders()});return t?.result}async getBalance(){this.accessToken||await this.getAccessToken();return await this.requestWithRetry(`${this.domain}/payout-admin/balance`,{method:"GET",headers:this.getHeaders()})}async getRunningBalance(){this.accessToken||await this.getAccessToken();return await this.requestWithRetry(`${this.domain}/payout-admin/running-balance`,{method:"GET",headers:this.getHeaders()})}async createTransferAllocation(e){this.accessToken||await this.getAccessToken();const t=await this.requestWithRetry(`${this.domain}/payout-admin/transfer`,{method:"POST",headers:this.getHeaders(),body:JSON.stringify(e)});return t?.result??t}async allocateTransfer(e,t){this.accessToken||await this.getAccessToken();const s=`${this.domain}/payout-admin/transfer/${encodeURIComponent(e)}/allocate`,a=await this.requestWithRetry(s,{method:"POST",headers:this.getHeaders(),body:JSON.stringify(t)});return a?.result??a}}class h{static verify(e){try{const{data:s,signature:a}=e||{};if(!s||!a)return!1;const r=t.createVerify("RSA-SHA256");return r.update(s),r.verify("-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2e4stIYooUrKHVQmwztC\n/l0YktX6uz4bE1iDtA2qu4OaXx+IKkwBWa0hO2mzv6dAoawyzxa2jmN01vrpMkMj\nrB+Dxmoq7tRvRTx1hXzZWaKuv37BAYosOIKjom8S8axM1j6zPkX1zpMLE8ys3dUX\nFN5Dl/kBfeCTwGRV4PZjP4a+QwgFRzZVVfnpcRI/O6zhfkdlRah8MrAPWYSoGBpG\nCPiAjUeHO/4JA5zZ6IdfZuy/DKxbcOlt9H+z14iJwB7eVUByoeCE+Bkw+QE4msKs\naIn4xl9GBoyfDZKajTzL50W/oeoE1UcuvVfaULZ9DWnHOy6idCFH1WbYDxYYIWLi\nAQIDAQAB\n-----END PUBLIC KEY-----",a,"base64")}catch(e){return console.error("Payout signature verification failed:",e),!1}}}const d="PAYOUT",u={PayeeAdded:"PayeeAdded",PayeeKycStarted:"PayeeKycStarted",PayeeKycStatusChange:"PayeeKycStatusChange",PayeeFundAllocated:"PayeeFundAllocated",PayoutStarted:"PayoutStarted",PayoutStatusChange:"PayoutStatusChange"};class y{fiat;crypto;admin;constructor(e){this.fiat=new i(e),this.crypto=new o(e),this.admin=new c(e)}}export{u as PAYOUT_WEBHOOK_EVENTS,d as PAYOUT_WEBHOOK_EVENT_TYPE,h as PayoutWebhookVerifier,a as Rocketfuel,y as RocketfuelPayouts};
 //# sourceMappingURL=index.js.map

package/dist/payins/index.d.ts

@@ -0,0 +1,14 @@
+import type { CartData, Environment } from './constants';
+export declare class Rocketfuel {
+    #private;
+    constructor({ clientId, clientSecret, merchantId, environment, }: {
+        clientId: string;
+        clientSecret: string;
+        merchantId: string;
+        environment: Environment;
+    });
+    createOrder(payload: CartData): Promise<any>;
+    transactionLookup(txId: string, type?: 'ORDERID' | 'TXID'): Promise<any>;
+    verifyAgeVerification(auditId: string): Promise<any>;
+    verifyWebhookSignature(body: any): boolean;
+}

package/dist/payouts/admin.d.ts

@@ -0,0 +1,40 @@
+import { type AdminTransferAllocationPayload, type AdminAllocateTransferPayload, type InvitePayeePayload, type PayeeKycPayload } from './constants';
+import { PayoutBase, type PayoutClientConfig } from './core';
+export declare class PayoutAdminClient extends PayoutBase {
+    constructor(config: PayoutClientConfig);
+    /**
+     * Invite a new payee.
+     * Maps to: POST /api/payout/external/payee
+     */
+    invitePayee(payload: InvitePayeePayload): Promise<any>;
+    /**
+     * Submit KYC for a payee.
+     * Maps to: POST /api/compliance/kyc
+     */
+    submitPayeeKyc(payload: PayeeKycPayload): Promise<any>;
+    /**
+     * Get the balance of a specific payee.
+     * Maps to: GET /api/payout-admin/payee/{payeeId}/balance
+     */
+    getPayeeBalance(payeeId: string): Promise<any>;
+    /**
+     * Get payout admin balance.
+     * Maps to: GET /api/payout-admin/balance
+     */
+    getBalance(): Promise<any>;
+    /**
+     * Get payout admin running balance.
+     * Maps to: GET /api/payout-admin/running-balance
+     */
+    getRunningBalance(): Promise<any>;
+    /**
+     * Create an allocation transfer for a payee.
+     * Maps to: POST /api/payout-admin/transfer
+     */
+    createTransferAllocation(payload: AdminTransferAllocationPayload): Promise<any>;
+    /**
+     * Allocate (confirm / retry) a transfer allocation.
+     * Maps to: POST /api/payout-admin/transfer/{allocationId}/allocate
+     */
+    allocateTransfer(allocationId: string, payload: AdminAllocateTransferPayload): Promise<any>;
+}

package/dist/payouts/constants.d.ts

@@ -0,0 +1,169 @@
+export declare const apiDomains: {
+    readonly production: "https://app.rocketfuel.inc/api";
+    readonly qa: "https://qa-app.rfdemo.co/api";
+    readonly preprod: "https://preprod-app.rocketdemo.net/api";
+    readonly sandbox: "https://app-sandbox.rocketfuel.inc/api";
+};
+export type Environment = keyof typeof apiDomains;
+export interface HttpError extends Error {
+    status: number;
+}
+export interface InvitePayeeExtra {
+    email: string;
+    refId: string;
+    [key: string]: any;
+}
+export interface InvitePayeePayload {
+    firstName: string;
+    lastName: string;
+    countryCode?: string;
+    extra: InvitePayeeExtra;
+    [key: string]: any;
+}
+export interface PayeeKycPayload {
+    referenceId: string;
+    type: 'payee' | string;
+    kycData: any;
+}
+export interface KnowYourAddressPayload {
+    walletAddress: string;
+    currency: string;
+}
+export interface CryptoTransferFeePayload {
+    amount: number;
+    cryptoCurrency: string;
+    cryptoNetwork: string;
+}
+export interface CryptoTransferCheckPayload {
+    amount: string;
+    currency: string;
+    cryptoCurrency: string;
+    cryptoNetwork: string;
+    walletAddress: string;
+}
+export interface CryptoTransferPayload {
+    amount: string;
+    currency: string;
+    cryptoCurrency: string;
+    cryptoNetwork: string;
+    walletAddress: string;
+    requireAllocation?: boolean;
+}
+export interface AdminTransferAllocationPayload {
+    payeeId: string;
+    amount: string;
+    currency: string;
+    descriptor: string;
+    label: string;
+}
+export interface AdminAllocateTransferPayload {
+    retryStatus: boolean;
+    payeeId: string;
+}
+export interface BankConfigurationQuery {
+    payeeId: string;
+    currency: string;
+    country: string;
+    destinationRecordId?: string;
+}
+export interface FiatCountryQuery {
+    payeeId?: string;
+    currency?: string;
+}
+export interface FiatCurrencyQuery {
+    payeeId: string;
+    country?: string;
+}
+export interface FiatStatusQuery {
+    payeeId: string;
+    country: string;
+    currency: string;
+}
+export interface SaveBankDetailsPayload {
+    bankDetail: {
+        bankAccountId: string;
+        bankId: string;
+        [key: string]: any;
+    };
+    personalDetail: {
+        firstName: string;
+        lastName: string;
+        address: string;
+        [key: string]: any;
+    };
+    currency: string;
+    country: string;
+    destinationRecordId?: string;
+    paymentMethod?: string;
+    attributes?: Record<string, any>;
+}
+export interface DeleteBankDetailsParams {
+    bankId: string;
+    payeeId: string;
+}
+export interface ListBankDetailsQuery {
+    payeeId: string;
+}
+export interface FiatTransferFeeQuery {
+    payeeId: string;
+    country: string;
+    currency: string;
+}
+export interface FiatTransferFeePayload {
+    currency: string;
+    accountToken: string;
+    amount: string;
+    destinationRecordId?: string;
+}
+export interface FiatTransferQuery {
+    payeeId: string;
+    country: string;
+    currency: string;
+}
+export interface FiatTransferPayload {
+    accountToken: string;
+    amount: string;
+    currency: string;
+    recordId: string;
+    requireAllocation?: boolean;
+    destinationRecordId?: string;
+}
+export interface FiatPaymentMethodsQuery {
+    amount: string;
+    country?: string;
+    currency?: string;
+    payeeId?: string;
+}
+/** Query for GET /payout/fiat/options (currency list / payers for a payout type). */
+export interface FiatOptionsQuery {
+    payeeId: string;
+    country: string;
+    amount: number;
+    type: string;
+}
+export interface FileUploadUrlQuery {
+    contentType: string;
+    payeeId?: string;
+}
+export interface ComplianceStatusQuery {
+    country: string;
+    service: string;
+    destinationRecordId?: string;
+    payeeId?: string;
+}
+export interface CreatePayeeUserExternalPayload {
+    payeeId: string;
+    fName: string;
+    lName: string;
+    email: string;
+    country: string;
+}
+export interface ShouldShowExternalPayeeFormResponse {
+    showForm: boolean;
+}
+export interface Country {
+    id: number;
+    name: string;
+    iso2: string;
+    iso3: string;
+}

package/dist/payouts/core.d.ts

@@ -0,0 +1,20 @@
+import { type Environment } from './constants';
+export interface PayoutClientConfig {
+    clientId: string;
+    clientSecret: string;
+    merchantId: string;
+    environment: Environment;
+}
+export declare abstract class PayoutBase {
+    protected clientId: string;
+    protected clientSecret: string;
+    protected merchantId: string;
+    protected domain: string;
+    protected accessToken: string | null;
+    protected refreshToken: string | null;
+    protected constructor({ clientId, clientSecret, merchantId, environment, }: PayoutClientConfig);
+    protected getAuthPayload(): string;
+    protected getHeaders(): Record<string, string>;
+    protected getAccessToken(): Promise<void>;
+    protected requestWithRetry(url: string, options: RequestInit, retry?: boolean): Promise<any>;
+}

package/dist/payouts/crypto.d.ts

@@ -0,0 +1,35 @@
+import { type KnowYourAddressPayload, type CryptoTransferFeePayload, type CryptoTransferCheckPayload, type CryptoTransferPayload } from './constants';
+import { PayoutBase, type PayoutClientConfig } from './core';
+export declare class CryptoPayoutClient extends PayoutBase {
+    constructor(config: PayoutClientConfig);
+    /**
+     * Get available payout currencies for a payee.
+     * Maps to: GET /api/payout/currencies?payeeId={payeeId}
+     */
+    getCurrencies(payeeId: string): Promise<any>;
+    /**
+     * Check risk / compliance for a wallet address.
+     * Maps to: POST /api/payout/know-your-address
+     */
+    checkAddress(payload: KnowYourAddressPayload): Promise<any>;
+    /**
+     * Get transfer fee quote for a payee.
+     * Maps to: POST /api/payout/crypto/fee?payeeId={payeeId}
+     */
+    getTransferFee(payeeId: string, payload: CryptoTransferFeePayload): Promise<any>;
+    /**
+     * Check and prepare a crypto transfer for a payee.
+     * Maps to: POST /api/payout/withdraw-check?payeeId={payeeId}
+     */
+    checkTransfer(payeeId: string, payload: CryptoTransferCheckPayload): Promise<any>;
+    /**
+     * Execute a crypto transfer for a payee.
+     * Maps to: POST /api/payout/withdraw?payeeId={payeeId}
+     */
+    transfer(payeeId: string, payload: CryptoTransferPayload): Promise<any>;
+    /**
+     * Get transfer status for a payout (crypto / generic).
+     * Maps to: GET /api/payout/order/{orderId}?payeeId={payeeId}
+     */
+    getTransferStatus(orderId: string, payeeId: string): Promise<any>;
+}

package/dist/payouts/fiat.d.ts

@@ -0,0 +1,119 @@
+import { type BankConfigurationQuery, type FiatCountryQuery, type FiatCurrencyQuery, type FiatStatusQuery, type SaveBankDetailsPayload, type DeleteBankDetailsParams, type ListBankDetailsQuery, type FiatTransferFeeQuery, type FiatTransferFeePayload, type FiatTransferQuery, type FiatTransferPayload, type FiatPaymentMethodsQuery, type FiatOptionsQuery, type FileUploadUrlQuery, type ComplianceStatusQuery, type CreatePayeeUserExternalPayload, type ShouldShowExternalPayeeFormResponse, type Country } from './constants';
+import { PayoutBase, type PayoutClientConfig } from './core';
+export declare class FiatPayoutClient extends PayoutBase {
+    constructor(config: PayoutClientConfig);
+    /**
+     * Get bank configuration (fields/schema) for a payee's fiat payout.
+     * Also fetches personal field values and merges them into the form data.
+     * Maps to: GET /api/payout/fiat/bank-configuration?payeeId={payeeId}&currency={currency}&country={country}
+     * and GET /api/payout/fiat/personal-field-values
+     */
+    getBankConfiguration(query: BankConfigurationQuery): Promise<any>;
+    /**
+     * Get payout service status (fees and availability).
+     * Maps to: GET /api/payout/services?payeeId={payeeId}&country={country}&currency={currency}
+     */
+    getStatus(query: FiatStatusQuery): Promise<any>;
+    /**
+     * Check if external payee form should be shown.
+     * Returns true if payee is external, individual, and doesn't have MassPay mapping yet.
+     * Maps to: GET /api/payout/user/create/external/check
+     */
+    shouldShowExternalPayeeForm(payeeId: string): Promise<ShouldShowExternalPayeeFormResponse>;
+    /**
+     * Create an external payee user.
+     * Maps to: POST /api/payout/user/create/external
+     *
+     * Required fields:
+     *   - fName: string (first name)
+     *   - lName: string (last name)
+     *   - email: string (valid email address)
+     *   - country: string (ISO3 code, 3 uppercase letters)
+     */
+    createPayeeUserExternal(payload: CreatePayeeUserExternalPayload): Promise<any>;
+    /**
+     * Get public list of all countries with id, name, iso2, and iso3 codes.
+     * This is a public endpoint that does not require authentication.
+     * Maps to: GET /api/payout/countries
+     */
+    getPublicCountries(payeeId: string): Promise<Country[]>;
+    /**
+     * Get list of supported payout countries.
+     * Maps to: GET /api/payout/fiat/country?[payeeId={payeeId}][&currency={currency}]
+     */
+    getCountries(query: FiatCountryQuery): Promise<any>;
+    /**
+     * Get list of supported payout currencies for a payee and country.
+     * Maps to: GET /api/payout/fiat/currency?payeeId={payeeId}[&country={country}]
+     */
+    getCurrencies(query: FiatCurrencyQuery): Promise<any>;
+    /**
+     * Save/update bank details for a payee.
+     * Maps to: POST /api/payout/fiat/bank-configuration?payeeId={payeeId}&currency={currency}&country={country}[&oldDestinationRecordId={oldDestinationRecordId}]
+     */
+    saveBankDetails(payeeId: string, payload: SaveBankDetailsPayload, options?: {
+        oldDestinationRecordId?: string;
+    }): Promise<any>;
+    /**
+     * Delete a specific bank detail for a payee.
+     * Maps to: DELETE /api/payout/fiat/bank/{bankId}?payeeId={payeeId}
+     */
+    deleteBankDetails(params: DeleteBankDetailsParams): Promise<any>;
+    /**
+     * List all bank details for a payee.
+     * Maps to: GET /api/payout/fiat/bank-detail?payeeId={payeeId}
+     */
+    listBankDetails(query: ListBankDetailsQuery): Promise<any>;
+    /**
+     * Get transfer fee quote.
+     * Maps to: POST /api/payout/fiat/fees?payeeId={payeeId}&country={country}&currency={currency}
+     */
+    getTransferFee(query: FiatTransferFeeQuery, payload: FiatTransferFeePayload): Promise<any>;
+    /**
+     * Initiate transfer to a bank account.
+     *
+     * Maps to: POST /api/payout/fiat/transfer?payeeId={payeeId}&country={country}&currency={currency}
+     *
+     * If payload.requireAllocation === true, the backend will first create a CREDIT
+     * allocation entry and then perform the transfer atomically.
+     */
+    transfer(query: FiatTransferQuery, payload: FiatTransferPayload): Promise<any>;
+    /**
+     * Get transfer status for a payout.
+     * Maps to: GET /api/payout/order/{orderId}?payeeId={payeeId}
+     */
+    getTransferStatus(orderId: string, payeeId: string): Promise<any>;
+    /**
+     * Get fiat payment methods (options) for a given amount/country/currency.
+     * Maps to: GET /api/payout/fiat/payment-methods
+     *
+     * Backend route query:
+     *   - amount: string (required)
+     *   - country: string (optional, ISO2)
+     *   - currency: string (optional, ISO3)
+     */
+    getPaymentMethods(query: FiatPaymentMethodsQuery): Promise<any>;
+    /**
+     * Get fiat payout options (currency list / payers) for a payee.
+     * Maps to: GET /api/payout/fiat/options?country={country}&amount={amount}&type={type}
+     * Same as payout-app getCurrencyListFiat(amount, country, type).
+     * Returns either { payers: [...] } (list of options with destinationRecordId) or { currencySymbols, destinationRecordId }.
+     */
+    getFiatOptions(query: FiatOptionsQuery): Promise<any>;
+    /**
+     * Get presigned S3 upload URL for file uploads.
+     * Maps to: GET /api/payout/files/upload-url
+     *
+     * Backend route query:
+     *   - contentType: string (required) - The content type of the file to upload
+     *   - payeeId: string (optional) - The payee ID (if not provided, uses authenticated payee)
+     *
+     * Returns: { uploadUrl: string, fileKey: string }
+     */
+    getFileUploadUrl(query: FileUploadUrlQuery): Promise<any>;
+    /**
+     * Get the compliance status of payee.
+     * Maps to: GET /api/payout/compliance-status?country={country}&service={service}&destinationRecordId={destinationRecordId}
+     */
+    getComplianceStatus(query: ComplianceStatusQuery): Promise<any>;
+}

package/dist/payouts/index.d.ts

@@ -0,0 +1,20 @@
+import type { PayoutClientConfig } from './core';
+import { FiatPayoutClient } from './fiat';
+import { CryptoPayoutClient } from './crypto';
+import { PayoutAdminClient } from './admin';
+export { PayoutWebhookVerifier, PAYOUT_WEBHOOK_EVENT_TYPE, PAYOUT_WEBHOOK_EVENTS, } from './webhook';
+/**
+ * High‑level Rocketfuel payouts client that groups all payout operations.
+ *
+ * Usage:
+ *   const client = new RocketfuelPayouts(config);
+ *   await client.fiat.transfer(...);
+ *   await client.crypto.transfer(...);
+ *   await client.admin.getBalance();
+ */
+export declare class RocketfuelPayouts {
+    readonly fiat: FiatPayoutClient;
+    readonly crypto: CryptoPayoutClient;
+    readonly admin: PayoutAdminClient;
+    constructor(config: PayoutClientConfig);
+}

package/dist/payouts/webhook.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Helper for verifying payout webhook signatures.
+ */
+export declare class PayoutWebhookVerifier {
+    /**
+     * Verify the signature of a payout webhook.
+     *
+     * The payout webhook sender signs the canonical JSON payload and sends:
+     *   {
+     *     ...otherFields,
+     *     data: "<canonical-json-string>",
+     *     signature: "<base64-signature>"
+     *   }
+     *
+     * This method recomputes the signature using Rocketfuel's public key.
+     */
+    static verify(body: any): boolean;
+}
+/**
+ * Webhook event type for payout webhooks.
+ * Matches the `WEBHOOK_EVENT_TYPES.PAYOUT` value in backend models.
+ */
+export declare const PAYOUT_WEBHOOK_EVENT_TYPE: "PAYOUT";
+/**
+ * Payout webhook event names exposed for SDK consumers.
+ * Mirrors the payout-related entries from backend `WEBHOOK_EVENTS`.
+ */
+export declare const PAYOUT_WEBHOOK_EVENTS: {
+    readonly PayeeAdded: "PayeeAdded";
+    readonly PayeeKycStarted: "PayeeKycStarted";
+    readonly PayeeKycStatusChange: "PayeeKycStatusChange";
+    readonly PayeeFundAllocated: "PayeeFundAllocated";
+    readonly PayoutStarted: "PayoutStarted";
+    readonly PayoutStatusChange: "PayoutStatusChange";
+};
+export type PayoutWebhookEvent = (typeof PAYOUT_WEBHOOK_EVENTS)[keyof typeof PAYOUT_WEBHOOK_EVENTS];

package/package.json

@@ -2,15 +2,20 @@
   "name": "@rkfl/transact-server",
   "main": "./dist/index.js",
   "type": "module",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "scripts": {
     "build": "rollup -c",
     "npm:login": "npm login",
     "npm:publish": "npm run build && npm publish --access public",
+    "npm:publish:alpha": "npm run build && npm publish --access public --tag alpha",
     "npm:patch": "npm version patch",
     "npm:minor": "npm version minor",
     "npm:major": "npm version major",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "npm:alpha": "npm version prerelease --preid=alpha",
+    "npm:alpha:patch": "npm version prepatch --preid=alpha",
+    "npm:alpha:minor": "npm version preminor --preid=alpha",
+    "npm:alpha:major": "npm version premajor --preid=alpha",
+    "test": "jest"
   },
   "types": "./dist/index.d.ts",
   "exports": {
@@ -31,13 +36,17 @@
     "rocketfuel",
     "server",
     "crypto",
-    "payments"
+    "payments",
+    "payouts"
   ],
   "devDependencies": {
     "@types/crypto-js": "^4.2.2",
+    "@types/jest": "^29.5.14",
+    "jest": "^29.7.0",
     "rollup": "^2.79.2",
     "rollup-plugin-terser": "^7.0.2",
     "rollup-plugin-typescript2": "^0.36.0",
+    "ts-jest": "^29.4.6",
     "typescript": "^5.8.3"
   },
   "dependencies": {