Class LedgerAccountTransferService

Transfers funds (currently only MOVEUSD) between ledger accounts

Hierarchy (View Summary)

LedgerAccountTransferQueryService
- LedgerAccountTransferService

Index

Constructors

constructor

Properties

Methods

create get search

Constructors

constructor

new LedgerAccountTransferService(
    args: {
        ablyRestClient: Rest | null;
        db: B2bDatabase;
        eventPublisher: CustomerEventPublisher;
        ledgerAccountService: LedgerAccountService;
        productQuoteService: ProductQuoteService;
        solanaTokenService: SolanaTokenQueryService;
        valkeyClient: ValkeyClient | null;
        workflowService: LedgerAccountTransferWorkflowService;
    },
): LedgerAccountTransferService
Parameters
- args: {
      ablyRestClient: Rest | null;
      db: B2bDatabase;
      eventPublisher: CustomerEventPublisher;
      ledgerAccountService: LedgerAccountService;
      productQuoteService: ProductQuoteService;
      solanaTokenService: SolanaTokenQueryService;
      valkeyClient: ValkeyClient | null;
      workflowService: LedgerAccountTransferWorkflowService;
  }
Returns LedgerAccountTransferService
Overrides LedgerAccountTransferQueryService.constructor
- Defined in packages/ledger-account-services/src/transfer/LedgerAccountTransferService.ts:275

Properties

`Protected` `Readonly`db

db: B2bDatabase

Methods

create

create(
    __namedParameters: Pick<
        LedgerAccountTransfer,
        "sourceLedgerAccountId"
        | "targetLedgerAccountId"
        | "sourceAmount",
    > & {
        customerId: string;
        entityId: string;
        idempotencyKey: string;
        senderMessage?: string;
        targetCustomerId?: string;
    },
): Promise<
    | { ok: true; value: LedgerAccountTransfer }
    | { error: LedgerAccountTransferCreateError; ok: false },
>
Parameters
- __namedParameters: Pick<
      LedgerAccountTransfer,
      "sourceLedgerAccountId"
      | "targetLedgerAccountId"
      | "sourceAmount",
  > & {
      customerId: string;
      entityId: string;
      idempotencyKey: string;
      senderMessage?: string;
      targetCustomerId?: string;
  }
  - customerId: string
    
    Source wallet customer ID
  - entityId: string
    
    Entity is checked for product activation, fees and limits
  - idempotencyKey: string
    
    Caller-supplied dedupe token (required — the service never mints its own; the caller owns idempotency). A repeat returns the existing transfer; it also threads into the audit quote and seeds the on-chain Mintfx PDA (hashed, so length/charset are unconstrained).
  - OptionalsenderMessage?: string
  - OptionaltargetCustomerId?: string
    
    Owner of target wallet, for cross-customer transfers. Defaults to source customer ID.
Returns Promise<
| { ok: true; value: LedgerAccountTransfer }
| { error: LedgerAccountTransferCreateError; ok: false },
>
- Defined in packages/ledger-account-services/src/transfer/LedgerAccountTransferService.ts:337

get

get(
__namedParameters: { customerId: string; id: string },
): Promise<{ ok: true; value: LedgerAccountTransfer | null }>
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<{ ok: true; value: LedgerAccountTransfer | null }>
Inherited from LedgerAccountTransferQueryService.get
- Defined in packages/ledger-account-services/src/transfer/LedgerAccountTransferService.ts:109

search

search(
    __namedParameters: {
        createdAt?: DbTimestampCriteria;
        customerId: string;
        entityIds?: string[];
        ids?: string[];
        orderBy?: DbOrderByCriterion<
            Omit<
                PgTableWithColumns<
                    {
                        columns: {
                            createdAt: PgBuildColumn<
                                "ledger_account_transfer",
                                SetHasDefault<SetNotNull<(...)>>,
                                {
                                    data: Date;
                                    dataType: "object date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ledger_account_transfer";
                                },
                            >;
                            customerId: PgBuildColumn<
                                "ledger_account_transfer",
                                SetNotNull<PgIntegerBuilder>,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...) | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ledger_account_transfer";
                                },
                            >;
                            data: PgBuildColumn<
                                "ledger_account_transfer",
                                Set$Type<
                                    SetNotNull<(...)>,
                                    {
                                        fees: ...;
                                        senderMessage?: ...;
                                        sourceAmount: ...;
                                        targetAmount: ...;
                                        totalFees: ...;
                                    },
                                >,
                                {
                                    data: {
                                        fees: ...;
                                        senderMessage?: ...;
                                        sourceAmount: ...;
                                        targetAmount: ...;
                                        totalFees: ...;
                                    };
                                    dataType: "object json";
                                    driverParam: unknown;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ledger_account_transfer";
                                },
                            >;
                            externalId: PgBuildColumn<
                                "ledger_account_transfer",
                                SetHasRuntimeDefault<SetNotNull<(...)>>,
                                {
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ledger_account_transfer";
                                },
                            >;
                            id: PgBuildColumn<
                                "ledger_account_transfer",
                                HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...) | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: "byDefault";
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ledger_account_transfer";
                                },
                            >;
                            idempotencyKey: PgBuildColumn<
                                "ledger_account_transfer",
                                SetNotNull<PgTextBuilder<(...)>>,
                                {
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ledger_account_transfer";
                                },
                            >;
                            identityId: PgBuildColumn<
                                "ledger_account_transfer",
                                PgIntegerBuilder,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...)
                                    | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "ledger_account_transfer";
                                },
                            >;
                            organizationId: PgBuildColumn<
                                "ledger_account_transfer",
                                PgIntegerBuilder,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...)
                                    | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "ledger_account_transfer";
                                },
                            >;
                            productQuoteId: PgBuildColumn<
                                "ledger_account_transfer",
                                SetNotNull<PgIntegerBuilder>,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...) | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ledger_account_transfer";
                                },
                            >;
                            receipt: PgBuildColumn<
                                "ledger_account_transfer",
                                Set$Type<PgJsonbBuilder, { id: ...; type: ... }>,
                                {
                                    data: { id: ...; type: ... };
                                    dataType: "object json";
                                    driverParam: unknown;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "ledger_account_transfer";
                                },
                            >;
                            sourceLedgerAccountId: PgBuildColumn<
                                "ledger_account_transfer",
                                SetNotNull<PgIntegerBuilder>,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...) | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ledger_account_transfer";
                                },
                            >;
                            status: PgBuildColumn<
                                "ledger_account_transfer",
                                Set$Type<SetNotNull<(...)>, (...) | (...) | (...) | (...)>,
                                {
                                    data: (...) | (...) | (...) | (...);
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ledger_account_transfer";
                                },
                            >;
                            targetLedgerAccountId: PgBuildColumn<
                                "ledger_account_transfer",
                                SetNotNull<PgIntegerBuilder>,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...) | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ledger_account_transfer";
                                },
                            >;
                            updatedAt: PgBuildColumn<
                                "ledger_account_transfer",
                                SetHasDefault<SetHasDefault<(...)>>,
                                {
                                    data: Date;
                                    dataType: "object date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ledger_account_transfer";
                                },
                            >;
                        };
                        dialect: "pg";
                        name: "ledger_account_transfer";
                        schema: "b2b";
                    },
                >,
                "enableRLS",
            >,
            "createdAt"
            | "updatedAt",
        >[];
        page?: number;
        pageSize?: number;
        sourceLedgerAccountIds?: string[];
        statuses?: ("PENDING" | "FAILED" | "CANCELLED" | "SUCCEEDED")[];
        targetLedgerAccountIds?: string[];
        updatedAt?: DbTimestampCriteria;
    },
): Promise<
    {
        ok: true;
        value: (
            Omit<
                {
                    createdAt: Date;
                    customerId: number;
                    data: {
                        fees: Fees;
                        senderMessage?: string;
                        sourceAmount: Amount;
                        targetAmount: Amount;
                        totalFees: Amount;
                    };
                    externalId: string;
                    id: number;
                    idempotencyKey: string;
                    identityId: number
                    | null;
                    organizationId: number | null;
                    productQuoteId: number;
                    receipt: { id: string; type: "SOLANA_TRANSACTION_SIGNATURE" } | null;
                    sourceLedgerAccountId: number;
                    status: "PENDING" | "FAILED" | "CANCELLED" | "SUCCEEDED";
                    targetLedgerAccountId: number;
                    updatedAt: Date;
                },
                | "id"
                | "externalId"
                | "customerId"
                | "identityId"
                | "organizationId"
                | "data"
                | "productQuoteId"
                | "sourceLedgerAccountId"
                | "targetLedgerAccountId",
            > & {
                fees: (
                    {
                        amount: BigNumber;
                        receiver: "PROVIDER"
                        | "CFX"
                        | "CUSTOMER";
                        type: "FIXED" | "VARIABLE";
                    } & { currency: "MOVEUSD" }
                )[];
                id: string;
                idempotencyKey: string;
                productQuoteId: string;
                senderMessage?: string;
                sourceAmount: LedgerAccountTransferAmount;
                sourceLedgerAccountId: string;
                targetAmount: LedgerAccountTransferAmount;
                targetLedgerAccountId: string;
                totalFees: LedgerAccountTransferAmount;
            } & { entityId: string }
        )[];
    },
>
Parameters
- __namedParameters: {
      createdAt?: DbTimestampCriteria;
      customerId: string;
      entityIds?: string[];
      ids?: string[];
      orderBy?: DbOrderByCriterion<
          Omit<
              PgTableWithColumns<
                  {
                      columns: {
                          createdAt: PgBuildColumn<
                              "ledger_account_transfer",
                              SetHasDefault<SetNotNull<(...)>>,
                              {
                                  data: Date;
                                  dataType: "object date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ledger_account_transfer";
                              },
                          >;
                          customerId: PgBuildColumn<
                              "ledger_account_transfer",
                              SetNotNull<PgIntegerBuilder>,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...) | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ledger_account_transfer";
                              },
                          >;
                          data: PgBuildColumn<
                              "ledger_account_transfer",
                              Set$Type<
                                  SetNotNull<(...)>,
                                  {
                                      fees: ...;
                                      senderMessage?: ...;
                                      sourceAmount: ...;
                                      targetAmount: ...;
                                      totalFees: ...;
                                  },
                              >,
                              {
                                  data: {
                                      fees: ...;
                                      senderMessage?: ...;
                                      sourceAmount: ...;
                                      targetAmount: ...;
                                      totalFees: ...;
                                  };
                                  dataType: "object json";
                                  driverParam: unknown;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ledger_account_transfer";
                              },
                          >;
                          externalId: PgBuildColumn<
                              "ledger_account_transfer",
                              SetHasRuntimeDefault<SetNotNull<(...)>>,
                              {
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ledger_account_transfer";
                              },
                          >;
                          id: PgBuildColumn<
                              "ledger_account_transfer",
                              HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...) | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: "byDefault";
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ledger_account_transfer";
                              },
                          >;
                          idempotencyKey: PgBuildColumn<
                              "ledger_account_transfer",
                              SetNotNull<PgTextBuilder<(...)>>,
                              {
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ledger_account_transfer";
                              },
                          >;
                          identityId: PgBuildColumn<
                              "ledger_account_transfer",
                              PgIntegerBuilder,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...)
                                  | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "ledger_account_transfer";
                              },
                          >;
                          organizationId: PgBuildColumn<
                              "ledger_account_transfer",
                              PgIntegerBuilder,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...)
                                  | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "ledger_account_transfer";
                              },
                          >;
                          productQuoteId: PgBuildColumn<
                              "ledger_account_transfer",
                              SetNotNull<PgIntegerBuilder>,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...) | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ledger_account_transfer";
                              },
                          >;
                          receipt: PgBuildColumn<
                              "ledger_account_transfer",
                              Set$Type<PgJsonbBuilder, { id: ...; type: ... }>,
                              {
                                  data: { id: ...; type: ... };
                                  dataType: "object json";
                                  driverParam: unknown;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "ledger_account_transfer";
                              },
                          >;
                          sourceLedgerAccountId: PgBuildColumn<
                              "ledger_account_transfer",
                              SetNotNull<PgIntegerBuilder>,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...) | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ledger_account_transfer";
                              },
                          >;
                          status: PgBuildColumn<
                              "ledger_account_transfer",
                              Set$Type<SetNotNull<(...)>, (...) | (...) | (...) | (...)>,
                              {
                                  data: (...) | (...) | (...) | (...);
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ledger_account_transfer";
                              },
                          >;
                          targetLedgerAccountId: PgBuildColumn<
                              "ledger_account_transfer",
                              SetNotNull<PgIntegerBuilder>,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...) | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ledger_account_transfer";
                              },
                          >;
                          updatedAt: PgBuildColumn<
                              "ledger_account_transfer",
                              SetHasDefault<SetHasDefault<(...)>>,
                              {
                                  data: Date;
                                  dataType: "object date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ledger_account_transfer";
                              },
                          >;
                      };
                      dialect: "pg";
                      name: "ledger_account_transfer";
                      schema: "b2b";
                  },
              >,
              "enableRLS",
          >,
          "createdAt"
          | "updatedAt",
      >[];
      page?: number;
      pageSize?: number;
      sourceLedgerAccountIds?: string[];
      statuses?: ("PENDING" | "FAILED" | "CANCELLED" | "SUCCEEDED")[];
      targetLedgerAccountIds?: string[];
      updatedAt?: DbTimestampCriteria;
  }
  - OptionalcreatedAt?: DbTimestampCriteria
  - customerId: string
  - OptionalentityIds?: string[]
  - Optionalids?: string[]
  - OptionalorderBy?: DbOrderByCriterion<
        Omit<
            PgTableWithColumns<
                {
                    columns: {
                        createdAt: PgBuildColumn<
                            "ledger_account_transfer",
                            SetHasDefault<SetNotNull<(...)>>,
                            {
                                data: Date;
                                dataType: "object date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "ledger_account_transfer";
                            },
                        >;
                        customerId: PgBuildColumn<
                            "ledger_account_transfer",
                            SetNotNull<PgIntegerBuilder>,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...) | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "ledger_account_transfer";
                            },
                        >;
                        data: PgBuildColumn<
                            "ledger_account_transfer",
                            Set$Type<
                                SetNotNull<(...)>,
                                {
                                    fees: ...;
                                    senderMessage?: ...;
                                    sourceAmount: ...;
                                    targetAmount: ...;
                                    totalFees: ...;
                                },
                            >,
                            {
                                data: {
                                    fees: ...;
                                    senderMessage?: ...;
                                    sourceAmount: ...;
                                    targetAmount: ...;
                                    totalFees: ...;
                                };
                                dataType: "object json";
                                driverParam: unknown;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "ledger_account_transfer";
                            },
                        >;
                        externalId: PgBuildColumn<
                            "ledger_account_transfer",
                            SetHasRuntimeDefault<SetNotNull<(...)>>,
                            {
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "ledger_account_transfer";
                            },
                        >;
                        id: PgBuildColumn<
                            "ledger_account_transfer",
                            HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...) | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: "byDefault";
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "ledger_account_transfer";
                            },
                        >;
                        idempotencyKey: PgBuildColumn<
                            "ledger_account_transfer",
                            SetNotNull<PgTextBuilder<(...)>>,
                            {
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "ledger_account_transfer";
                            },
                        >;
                        identityId: PgBuildColumn<
                            "ledger_account_transfer",
                            PgIntegerBuilder,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...)
                                | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "ledger_account_transfer";
                            },
                        >;
                        organizationId: PgBuildColumn<
                            "ledger_account_transfer",
                            PgIntegerBuilder,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...)
                                | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "ledger_account_transfer";
                            },
                        >;
                        productQuoteId: PgBuildColumn<
                            "ledger_account_transfer",
                            SetNotNull<PgIntegerBuilder>,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...) | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "ledger_account_transfer";
                            },
                        >;
                        receipt: PgBuildColumn<
                            "ledger_account_transfer",
                            Set$Type<PgJsonbBuilder, { id: ...; type: ... }>,
                            {
                                data: { id: ...; type: ... };
                                dataType: "object json";
                                driverParam: unknown;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: false;
                                tableName: "ledger_account_transfer";
                            },
                        >;
                        sourceLedgerAccountId: PgBuildColumn<
                            "ledger_account_transfer",
                            SetNotNull<PgIntegerBuilder>,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...) | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "ledger_account_transfer";
                            },
                        >;
                        status: PgBuildColumn<
                            "ledger_account_transfer",
                            Set$Type<SetNotNull<(...)>, (...) | (...) | (...) | (...)>,
                            {
                                data: (...) | (...) | (...) | (...);
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "ledger_account_transfer";
                            },
                        >;
                        targetLedgerAccountId: PgBuildColumn<
                            "ledger_account_transfer",
                            SetNotNull<PgIntegerBuilder>,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...) | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "ledger_account_transfer";
                            },
                        >;
                        updatedAt: PgBuildColumn<
                            "ledger_account_transfer",
                            SetHasDefault<SetHasDefault<(...)>>,
                            {
                                data: Date;
                                dataType: "object date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "ledger_account_transfer";
                            },
                        >;
                    };
                    dialect: "pg";
                    name: "ledger_account_transfer";
                    schema: "b2b";
                },
            >,
            "enableRLS",
        >,
        "createdAt"
        | "updatedAt",
    >[]
  - Optionalpage?: number
    
    Defaults to 1
  - OptionalpageSize?: number
    
    Defaults to 10
  - OptionalsourceLedgerAccountIds?: string[]
  - Optionalstatuses?: ("PENDING" | "FAILED" | "CANCELLED" | "SUCCEEDED")[]
  - OptionaltargetLedgerAccountIds?: string[]
  - OptionalupdatedAt?: DbTimestampCriteria
Returns Promise<
    {
        ok: true;
        value: (
            Omit<
                {
                    createdAt: Date;
                    customerId: number;
                    data: {
                        fees: Fees;
                        senderMessage?: string;
                        sourceAmount: Amount;
                        targetAmount: Amount;
                        totalFees: Amount;
                    };
                    externalId: string;
                    id: number;
                    idempotencyKey: string;
                    identityId: number
                    | null;
                    organizationId: number | null;
                    productQuoteId: number;
                    receipt: { id: string; type: "SOLANA_TRANSACTION_SIGNATURE" } | null;
                    sourceLedgerAccountId: number;
                    status: "PENDING" | "FAILED" | "CANCELLED" | "SUCCEEDED";
                    targetLedgerAccountId: number;
                    updatedAt: Date;
                },
                | "id"
                | "externalId"
                | "customerId"
                | "identityId"
                | "organizationId"
                | "data"
                | "productQuoteId"
                | "sourceLedgerAccountId"
                | "targetLedgerAccountId",
            > & {
                fees: (
                    {
                        amount: BigNumber;
                        receiver: "PROVIDER"
                        | "CFX"
                        | "CUSTOMER";
                        type: "FIXED" | "VARIABLE";
                    } & { currency: "MOVEUSD" }
                )[];
                id: string;
                idempotencyKey: string;
                productQuoteId: string;
                senderMessage?: string;
                sourceAmount: LedgerAccountTransferAmount;
                sourceLedgerAccountId: string;
                targetAmount: LedgerAccountTransferAmount;
                targetLedgerAccountId: string;
                totalFees: LedgerAccountTransferAmount;
            } & { entityId: string }
        )[];
    },
>
Inherited from LedgerAccountTransferQueryService.search
- Defined in packages/ledger-account-services/src/transfer/LedgerAccountTransferService.ts:127

Class LedgerAccountTransferService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LedgerAccountTransferService

Properties

`Protected` `Readonly`db

Methods

create

Parameters

customerId: string

entityId: string

idempotencyKey: string

`Optional`senderMessage?: string

`Optional`targetCustomerId?: string

Returns Promise<
| { ok: true; value: LedgerAccountTransfer }
| { error: LedgerAccountTransferCreateError; ok: false },
>

get

Parameters

Returns Promise<{ ok: true; value: LedgerAccountTransfer | null }>

search

Parameters

`Optional`createdAt?: DbTimestampCriteria

customerId: string

`Optional`entityIds?: string[]

`Optional`ids?: string[]

`Optional`page?: number

`Optional`pageSize?: number

`Optional`sourceLedgerAccountIds?: string[]

`Optional`statuses?: ("PENDING" | "FAILED" | "CANCELLED" | "SUCCEEDED")[]

`Optional`targetLedgerAccountIds?: string[]

`Optional`updatedAt?: DbTimestampCriteria

Settings

On This Page

Class LedgerAccountTransferService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LedgerAccountTransferService

Properties

Protected Readonlydb

Methods

create

Parameters

customerId: string

entityId: string

idempotencyKey: string

OptionalsenderMessage?: string

OptionaltargetCustomerId?: string

Returns Promise< | { ok: true; value: LedgerAccountTransfer } | { error: LedgerAccountTransferCreateError; ok: false },>

get

Parameters

Returns Promise<{ ok: true; value: LedgerAccountTransfer | null }>

search

Parameters

OptionalcreatedAt?: DbTimestampCriteria

customerId: string

OptionalentityIds?: string[]

Optionalids?: string[]

Optionalpage?: number

OptionalpageSize?: number

OptionalsourceLedgerAccountIds?: string[]

Optionalstatuses?: ("PENDING" | "FAILED" | "CANCELLED" | "SUCCEEDED")[]

OptionaltargetLedgerAccountIds?: string[]

OptionalupdatedAt?: DbTimestampCriteria

Settings

On This Page

`Protected` `Readonly`db

`Optional`senderMessage?: string

`Optional`targetCustomerId?: string

Returns Promise<
| { ok: true; value: LedgerAccountTransfer }
| { error: LedgerAccountTransferCreateError; ok: false },
>

`Optional`createdAt?: DbTimestampCriteria

`Optional`entityIds?: string[]

`Optional`ids?: string[]

`Optional`page?: number

`Optional`pageSize?: number

`Optional`sourceLedgerAccountIds?: string[]

`Optional`statuses?: ("PENDING" | "FAILED" | "CANCELLED" | "SUCCEEDED")[]

`Optional`targetLedgerAccountIds?: string[]

`Optional`updatedAt?: DbTimestampCriteria