Class EscrowService

Index

Constructors

constructor

Methods

createVendorSubaccount getEscrowStats initializeEscrow processAutoRelease refundEscrow releaseEscrow

Constructors

constructor

new EscrowService(
    prisma: PrismaService,
    configService: ConfigService,
    emailService: EmailService,
): EscrowService
Parameters
- prisma: PrismaService
- configService: ConfigService
- emailService: EmailService
Returns EscrowService
- Defined in Documents/wekesa/customs/urembodev/backend/urembo-backend/src/escrow/escrow.service.ts:43

Methods

createVendorSubaccount

createVendorSubaccount(
    vendorData: {
        accountNumber: string;
        bankCode: string;
        businessName: string;
        contactName: string;
        email: string;
        percentageCharge?: number;
        phone: string;
    },
): Promise<PaystackSubaccount>
Create a Paystack subaccount for a vendor
Parameters
- vendorData: {
      accountNumber: string;
      bankCode: string;
      businessName: string;
      contactName: string;
      email: string;
      percentageCharge?: number;
      phone: string;
  }
Returns Promise<PaystackSubaccount>
- Defined in Documents/wekesa/customs/urembodev/backend/urembo-backend/src/escrow/escrow.service.ts:57

getEscrowStats

getEscrowStats(): Promise<
    {
        pendingOrders: number;
        totalHeld: number;
        totalRefunded: number;
        totalReleased: number;
    },
>
Get escrow statistics

Returns Promise<
    {
        pendingOrders: number;
        totalHeld: number;
        totalRefunded: number;
        totalReleased: number;
    },
>
- Defined in Documents/wekesa/customs/urembodev/backend/urembo-backend/src/escrow/escrow.service.ts:333

initializeEscrow

initializeEscrow(
orderId: string,
paymentReference: string,
): Promise<EscrowTransaction>
Initialize escrow for an order
Parameters
- orderId: string
- paymentReference: string
Returns Promise<EscrowTransaction>
- Defined in Documents/wekesa/customs/urembodev/backend/urembo-backend/src/escrow/escrow.service.ts:108

processAutoRelease

processAutoRelease(): Promise<void>
Process automatic escrow release for completed orders

Returns Promise<void>
- Defined in Documents/wekesa/customs/urembodev/backend/urembo-backend/src/escrow/escrow.service.ts:303

refundEscrow

refundEscrow(orderId: string, reason: string): Promise<boolean>
Refund escrow funds to customer
Parameters
- orderId: string
- reason: string
Returns Promise<boolean>
- Defined in Documents/wekesa/customs/urembodev/backend/urembo-backend/src/escrow/escrow.service.ts:258

releaseEscrow

releaseEscrow(orderId: string, reason?: string): Promise<boolean>
Release escrow funds to vendor
Parameters
- orderId: string
- Optionalreason: string
Returns Promise<boolean>
- Defined in Documents/wekesa/customs/urembodev/backend/urembo-backend/src/escrow/escrow.service.ts:191

Class EscrowService

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns EscrowService

Methods

createVendorSubaccount

Parameters

Returns Promise<PaystackSubaccount>

getEscrowStats

Returns Promise<
    {
        pendingOrders: number;
        totalHeld: number;
        totalRefunded: number;
        totalReleased: number;
    },
>

initializeEscrow

Parameters

Returns Promise<EscrowTransaction>

processAutoRelease

Returns Promise<void>

refundEscrow

Parameters

Returns Promise<boolean>

releaseEscrow

Parameters

Returns Promise<boolean>

Settings

On This Page

Class EscrowService

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns EscrowService

Methods

createVendorSubaccount

Parameters

Returns Promise<PaystackSubaccount>

getEscrowStats

Returns Promise< { pendingOrders: number; totalHeld: number; totalRefunded: number; totalReleased: number; },>

initializeEscrow

Parameters

Returns Promise<EscrowTransaction>

processAutoRelease

Returns Promise<void>

refundEscrow

Parameters

Returns Promise<boolean>

releaseEscrow

Parameters

Returns Promise<boolean>

Settings

On This Page

Returns Promise<
{
pendingOrders: number;
totalHeld: number;
totalRefunded: number;
totalReleased: number;
},
>