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

    Type Alias EscrowTransfer

    Service-level projection of an escrow transfer row. Always carries the customer's external id (string) — never the internal numeric FK.

    The DB column legacyTransactionId is non-null only for rows backfilled from cfx-movemoney's escrow_transfer_transaction table.

    Party identifiers are exposed as senderId / recipientId (the API vocabulary). The underlying DB columns are still sender_external_id / recipient_external_id; the mapper below is the single translation point.

    type EscrowTransfer = {
        amount: BigNumber;
        claimShortUrlId: string | null;
        claimSmsSentAt: Date | null;
        claimUrl: string | null;
        createdAt: Date;
        customerId: string;
        expiresAt: Date;
        history: EscrowTransferHistoryEntry[];
        id: string;
        legacyTransactionId: string | null;
        message: string | null;
        metadata: EscrowTransferMetadata;
        recipient: ResolvedEscrowParty | null;
        recipientId: string | null;
        recipientPhone: string;
        sender: ResolvedEscrowParty;
        senderId: string;
        status: EscrowStatus;
        statusReason: EscrowStatusReason | null;
        terminalSmsSentAt: Date | null;
        tokenSymbol: string;
        updatedAt: Date;
    }
    Index
    amount claimShortUrlId claimSmsSentAt claimUrl createdAt customerId expiresAt history id legacyTransactionId message metadata recipient recipientId recipientPhone sender senderId status statusReason terminalSmsSentAt tokenSymbol updatedAt
    amount: BigNumber
    claimShortUrlId: string | null
    claimSmsSentAt: Date | null
    claimUrl: string | null
    createdAt: Date
    customerId: string
    expiresAt: Date
    history: EscrowTransferHistoryEntry[]
    id: string
    legacyTransactionId: string | null
    message: string | null
    metadata: EscrowTransferMetadata
    recipient: ResolvedEscrowParty | null
    recipientId: string | null
    recipientPhone: string
    sender: ResolvedEscrowParty

    Both sides carry the resolved party — the owner address plus the ledger account id it belongs to — rather than a bare wallet string, so no reader can see one without the other. See ResolvedEscrowParty.

    senderId: string
    status: EscrowStatus
    statusReason: EscrowStatusReason | null

    Why a CANCELLED or RETURNED escrow ended; null otherwise.

    terminalSmsSentAt: Date | null
    tokenSymbol: string
    updatedAt: Date

    Settings
    Member Visibility

    On This Page
    Properties