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

    Class VictorTransactionClient

    Hierarchy

    • VictorBaseClient
      • VictorTransactionClient
    Index
    constructor
    client
    createAchCreditWithdrawal createAchDebitDeposit createBookExternalTransfer createBookTransfer createInstantWithdrawal createUsWireWithdrawal getToken getTransaction getTransactions
    client: Client<VictorAuthPaths>

    • Parameters

      • args: {
            amount: string;
            clientReferenceId: string;
            companyEntryDescription?: string;
            companyId?: string;
            companyName?: string;
            counterpartyReference: string;
            idempotencyKey: string;
            originatingAccountNumber: string;
            schedule: "same-day" | "next-day";
            secCode: "ccd" | "ppd" | "web";
        }

      Returns Promise<
          {
              addenda?: string;
              amount?: string;
              client_reference_id?: string;
              company_discretionary_data?: string;
              company_entry_description?: string;
              company_id?: string;
              created_at?: number;
              effective_entry_date?: string;
              individual_name?: string;
              originator_name?: string;
              settlement_date?: string;
              status?: | "DECLINED"
              | "FAILED"
              | "PENDING"
              | "CANCELLED"
              | "SUCCESS"
              | "ONHOLD"
              | "PENDING_APPROVAL"
              | "PROCESSING"
              | "SENT";
              type?: | "BOOK_INTERNAL"
              | "BOOK_EXTERNAL"
              | "ACH_TRANSFER"
              | "WIRE_TRANSFER"
              | "IAT_ACH_TRANSFER"
              | "INSTANT_PAYMENT_SEND"
              | "INSTANT_PAYMENT_INBOUND";
              updated_at?: number;
              victor_transaction_id?: string;
          },
      >

    • Parameters

      • args: {
            amount: string;
            clientReferenceId: string;
            companyEntryDescription?: string;
            companyId?: string;
            companyName?: string;
            counterpartyReference: string;
            idempotencyKey: string;
            originatingAccountNumber: string;
            schedule: "same-day" | "next-day";
            secCode: "ccd" | "ppd" | "web";
        }

      Returns Promise<
          {
              addenda?: string;
              amount?: string;
              client_reference_id?: string;
              company_discretionary_data?: string;
              company_entry_description?: string;
              company_id?: string;
              created_at?: number;
              effective_entry_date?: string;
              individual_name?: string;
              originator_name?: string;
              settlement_date?: string;
              status?: | "DECLINED"
              | "FAILED"
              | "PENDING"
              | "CANCELLED"
              | "SUCCESS"
              | "ONHOLD"
              | "PENDING_APPROVAL"
              | "PROCESSING"
              | "SENT";
              type?: | "BOOK_INTERNAL"
              | "BOOK_EXTERNAL"
              | "ACH_TRANSFER"
              | "WIRE_TRANSFER"
              | "IAT_ACH_TRANSFER"
              | "INSTANT_PAYMENT_SEND"
              | "INSTANT_PAYMENT_INBOUND";
              updated_at?: number;
              victor_transaction_id?: string;
          },
      >

    • Book external transfer: moves funds between two on-us (Dart) accounts that sit in different ledger programs, so the far side is addressed as a Victor counterparty (not a bare account number) with a direction. credit pushes funds from originatingAccountNumber to the counterparty; debit pulls the other way. Mirrors createBookTransfer but hits /v2/transfers/book/external.

      Parameters

      • args: {
            amount: string;
            clientReferenceId: string;
            counterpartyReference: string;
            description?: string;
            direction: "credit" | "debit";
            idempotencyKey: string;
            originatingAccountNumber: string;
        }

      Returns Promise<
          {
              amount?: string;
              client_reference_id?: string;
              created_at?: number;
              status?: | "DECLINED"
              | "FAILED"
              | "PENDING"
              | "CANCELLED"
              | "SUCCESS"
              | "ONHOLD"
              | "PENDING_APPROVAL"
              | "PROCESSING"
              | "SENT";
              type?: "BOOK_EXTERNAL";
              updated_at?: number;
              victor_transaction_id?: string;
          },
      >

    • Parameters

      • args: {
            amount: string;
            clientReferenceId: string;
            description?: string;
            destinationAccountNumber: string;
            idempotencyKey: string;
            originatingAccountNumber: string;
        }

      Returns Promise<
          {
              addenda?: string;
              amount?: string;
              client_reference_id?: string;
              company_discretionary_data?: string;
              company_entry_description?: string;
              company_id?: string;
              created_at?: number;
              effective_entry_date?: string;
              individual_name?: string;
              originator_name?: string;
              settlement_date?: string;
              status?: | "DECLINED"
              | "FAILED"
              | "PENDING"
              | "CANCELLED"
              | "SUCCESS"
              | "ONHOLD"
              | "PENDING_APPROVAL"
              | "PROCESSING"
              | "SENT";
              type?: | "BOOK_INTERNAL"
              | "BOOK_EXTERNAL"
              | "ACH_TRANSFER"
              | "WIRE_TRANSFER"
              | "IAT_ACH_TRANSFER"
              | "INSTANT_PAYMENT_SEND"
              | "INSTANT_PAYMENT_INBOUND";
              updated_at?: number;
              victor_transaction_id?: string;
          },
      >

    • Parameters

      • args: {
            amount: string;
            clientReferenceId: string;
            counterpartyReference: string;
            idempotencyKey: string;
            notes?: string;
            originatingAccountNumber: string;
            originatorType: "BUSINESS" | "CONSUMER";
        }

      Returns Promise<
          {
              client_reference_id?: string;
              instant_payment_credit_payment?: {
                  payee?: { ultimate_creditor?: string; victor_counterparty_id: string };
                  payer?: { account_number: string; ultimate_debtor?: string };
                  payment_details?: {
                      amount: string;
                      notes?: string;
                      originator_type: "BUSINESS" | "CONSUMER";
                  };
              };
              rtp_credit_payment?: {
                  payee?: { ultimate_creditor?: string; victor_counterparty_id: string };
                  payer?: { account_number: string; ultimate_debtor?: string };
                  payment_details?: {
                      amount: string;
                      notes?: string;
                      originator_type: "BUSINESS" | "CONSUMER";
                  };
              };
              status?: string;
              victor_transaction_id?: string;
          },
      >

    • Parameters

      • args: {
            amount: string;
            beneficiaryReference?: string;
            clientReferenceId: string;
            counterpartyReference: string;
            idempotencyKey: string;
            originatingAccountNumber: string;
        }

      Returns Promise<
          {
              addenda?: string;
              amount?: string;
              client_reference_id?: string;
              company_discretionary_data?: string;
              company_entry_description?: string;
              company_id?: string;
              created_at?: number;
              effective_entry_date?: string;
              individual_name?: string;
              originator_name?: string;
              settlement_date?: string;
              status?: | "DECLINED"
              | "FAILED"
              | "PENDING"
              | "CANCELLED"
              | "SUCCESS"
              | "ONHOLD"
              | "PENDING_APPROVAL"
              | "PROCESSING"
              | "SENT";
              type?: | "BOOK_INTERNAL"
              | "BOOK_EXTERNAL"
              | "ACH_TRANSFER"
              | "WIRE_TRANSFER"
              | "IAT_ACH_TRANSFER"
              | "INSTANT_PAYMENT_SEND"
              | "INSTANT_PAYMENT_INBOUND";
              updated_at?: number;
              victor_transaction_id?: string;
          },
      >

    • Parameters

      • args: { id: string }

      Returns Promise<
          | {
              addenda?: string;
              amount?: string;
              client_reference_id?: string;
              company_discretionary_data?: string;
              company_entry_description?: string;
              company_id?: string;
              completed_date?: number;
              counterparty_name?: string;
              created_date?: number;
              description?: string;
              effective_entry_date?: string;
              error_code?: number;
              error_message?: string;
              fed_trace_id?: string;
              from_account_number?: string;
              imad?: string;
              omad?: string;
              originating_bank_bic?: string;
              originating_bank_name?: string;
              originator_account_number?: string;
              originator_name?: string;
              originator_to_beneficiary1?: string;
              originator_to_beneficiary2?: string;
              originator_to_beneficiary3?: string;
              originator_to_beneficiary4?: string;
              parent_client_reference_id?: string;
              parent_reference_id?: string;
              return_reference_id?: string;
              running_balance?: string;
              sending_bank_bic?: string;
              sending_bank_name?: string;
              settlement_date?: string;
              status?: string;
              to_account_number?: string;
              to_name?: string;
              transaction_category?: string;
              transaction_code_description?: string;
              transaction_type?: string;
              victor_counterparty_id?: string;
              victor_trace_id?: string;
              victor_transaction_id?: string;
              wire_benf_id?: string;
              wire_init_dt?: number;
              wire_origin_to_benf_info_rec?: string;
              wire_orign_name?: string;
          }
          | null,
      >

    • Parameters

      • args: {
            accountNumbers?: string[];
            dateMode?: "COMPLETED" | "CREATED";
            endDatetime?: string;
            page?: number;
            pageSize?: number;
            startDatetime?: string;
            transactionType?:
                | "all"
                | "ach"
                | "wire"
                | "book-internal"
                | "book-external"
                | "rtp-send"
                | "rtp-refund"
                | "rtp-inbound"
                | "instant-payment-send"
                | "instant-payment-refund"
                | "instant-payment-inbound";
        }
        • OptionalaccountNumbers?: string[]
        • OptionaldateMode?: "COMPLETED" | "CREATED"
        • OptionalendDatetime?: string

          ISO 8601 date and time, Zulu timezone.

        • Optionalpage?: number

          0-based.

        • OptionalpageSize?: number
        • OptionalstartDatetime?: string

          ISO 8601 date and time, Zulu timezone.

        • OptionaltransactionType?:
              | "all"
              | "ach"
              | "wire"
              | "book-internal"
              | "book-external"
              | "rtp-send"
              | "rtp-refund"
              | "rtp-inbound"
              | "instant-payment-send"
              | "instant-payment-refund"
              | "instant-payment-inbound"

      Returns Promise<
          {
              account_name?: string;
              amount?: number;
              client_reference_id?: string;
              completed_at?: string;
              counterparty_name?: string;
              created_at?: string;
              error_code?: number;
              error_message?: string;
              fed_trace_id?: string;
              from_account_number?: string;
              from_name?: string;
              imad?: string;
              ledgering_program_id?: number;
              omad?: string;
              parent_reference_id?: string;
              return_reference_id?: string;
              running_balance?: number;
              status?: string;
              to_account_number?: string;
              to_name?: string;
              transaction_category?: string;
              transaction_code_description?: string;
              transaction_type?: | "BOOK_INTERNAL"
              | "BOOK_EXTERNAL"
              | "ACH_TRANSFER"
              | "WIRE_TRANSFER"
              | "IAT_ACH_TRANSFER"
              | "INSTANT_PAYMENT_SEND"
              | "INSTANT_PAYMENT_INBOUND";
              victor_counterparty_id?: string;
              victor_trace_id?: string;
              victor_transaction_id?: string;
          }[],
      >

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods