@cfxlabsinc/b2b-services
    Preparing search index...

    Type Alias Program

    A provider's program, keyed on the vendor that fronts it (PROGRAM_ROUTING.md § 3.1). Every id is an external id: vendorId is the vendor slug, bankAccountId the pool's bank_account id, bankId the slug of the bank fronting a pool-less program.

    type Program = {
        active: boolean;
        bankAccountId: string | null;
        bankId: BankId | null;
        beneficiaryName: string | null;
        createdAt: Date;
        deletedAt: Date | null;
        description: string | null;
        grantCount: number;
        id: string;
        name: string;
        providerProgramId: string | null;
        updatedAt: Date;
        vendorId: Vendor;
    }
    Index
    active bankAccountId bankId beneficiaryName createdAt deletedAt description grantCount id name providerProgramId updatedAt vendorId
    active: boolean
    bankAccountId: string | null
    bankId: BankId | null
    beneficiaryName: string | null

    Deposit-instruction beneficiary override; NULL falls back to the bank template.

    createdAt: Date
    deletedAt: Date | null
    description: string | null
    grantCount: number

    How many customers hold a grant on the program.

    id: string
    name: string
    providerProgramId: string | null

    The provider's own id. NULL for a CFX-side program (a memo pool).

    updatedAt: Date
    vendorId: Vendor

    Settings
    Member Visibility

    On This Page
    Properties