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

    Hierarchy

    • VictorBaseClient
      • VictorTransactionClient
    Index

    Constructors

    • Parameters

      • args: {
            baseUrl: string;
            clientId: string;
            clientSecret: string;
            keyvStore?: KeyvStoreAdapter;
            proxy: { cert: string; key: string; uri: string } | null;
        }

      Returns VictorTransactionClient

    Properties

    client: Client<paths>

    Methods

    • 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<
          {
              amount?: string;
              client_reference_id?: string;
              created_at?: number;
              status?: | "DECLINED"
              | "FAILED"
              | "PENDING"
              | "SENT"
              | "CANCELLED"
              | "ONHOLD"
              | "PENDING_APPROVAL"
              | "PROCESSING"
              | "SUCCESS";
              type?: | "BOOK_INTERNAL"
              | "BOOK_EXTERNAL"
              | "ACH_TRANSFER"
              | "WIRE_TRANSFER"
              | "IAT_ACH_TRANSFER"
              | "RTP_SEND"
              | "RTP_REFUND"
              | "RTP_INBOUND";
              updated_at?: number;
              victor_transaction_id?: string;
          },
      >

    • Parameters

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

      Returns Promise<
          {
              amount?: string;
              client_reference_id?: string;
              created_at?: number;
              status?: | "DECLINED"
              | "FAILED"
              | "PENDING"
              | "SENT"
              | "CANCELLED"
              | "ONHOLD"
              | "PENDING_APPROVAL"
              | "PROCESSING"
              | "SUCCESS";
              type?: | "BOOK_INTERNAL"
              | "BOOK_EXTERNAL"
              | "ACH_TRANSFER"
              | "WIRE_TRANSFER"
              | "IAT_ACH_TRANSFER"
              | "RTP_SEND"
              | "RTP_REFUND"
              | "RTP_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;
              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<
          {
              amount?: string;
              client_reference_id?: string;
              created_at?: number;
              status?: | "DECLINED"
              | "FAILED"
              | "PENDING"
              | "SENT"
              | "CANCELLED"
              | "ONHOLD"
              | "PENDING_APPROVAL"
              | "PROCESSING"
              | "SUCCESS";
              type?: | "BOOK_INTERNAL"
              | "BOOK_EXTERNAL"
              | "ACH_TRANSFER"
              | "WIRE_TRANSFER"
              | "IAT_ACH_TRANSFER"
              | "RTP_SEND"
              | "RTP_REFUND"
              | "RTP_INBOUND";
              updated_at?: number;
              victor_transaction_id?: string;
          },
      >

    • Parameters

      • args: { id: string }

      Returns Promise<
          | {
              amount?: string;
              client_reference_id?: string;
              completed_date?: number;
              created_date?: number;
              description?: 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_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;
              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,
      >