mx-platform-node
Version:
A Node library for the MX Platform API.
2,345 lines (2,342 loc) • 1.28 MB
text/typescript
/* tslint:disable */
/* eslint-disable */
/**
* MX Platform API
* The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions. Just getting started? See our [use case guides](/use-cases/).
*
* The version of the OpenAPI document: 20111101
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from './configuration';
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
import type { RequestArgs } from './base';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError } from './base';
/**
*
* @export
* @interface ACHResponse
*/
export interface ACHResponse {
/**
*
* @type {string}
* @memberof ACHResponse
*/
'account_guid'?: string;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'account_number_last_four'?: string | null;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'account_type'?: string | null;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'ach_initiated_at'?: string | null;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'client_guid'?: string;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'corrected_account_number'?: string | null;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'corrected_routing_number'?: string | null;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'created_at'?: string;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'guid'?: string;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'id'?: string;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'institution_guid'?: string;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'investigation_notes'?: string | null;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'member_guid'?: string;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'processing_errors'?: string | null;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'resolution_code'?: string | null;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'resolution_detail'?: string | null;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'resolved_status_at'?: string | null;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'return_code'?: string;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'return_notes'?: string | null;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'return_account_number'?: string | null;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'return_routing_number'?: string | null;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'return_status'?: string | null;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'returned_at'?: string | null;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'sec_code'?: string | null;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'started_processing_at'?: string | null;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'submitted_at'?: string | null;
/**
*
* @type {number}
* @memberof ACHResponse
*/
'transaction_amount'?: number | null;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'updated_at'?: string;
/**
*
* @type {string}
* @memberof ACHResponse
*/
'user_guid'?: string;
}
/**
*
* @export
* @interface ACHReturnCreateRequest
*/
export interface ACHReturnCreateRequest {
/**
* The unique identifier for the account associated with the transaction. Defined by MX.
* @type {string}
* @memberof ACHReturnCreateRequest
*/
'account_guid': string;
/**
* The last 4 digits of the account number used for the transaction by the Originating Depository Financial Institution (ODFI).
* @type {string}
* @memberof ACHReturnCreateRequest
*/
'account_number_last_four'?: string;
/**
* The date and time when the transaction was initiated by the Originating Depository Financial Institution (ODFI) in ISO 8601 format without timestamp.
* @type {string}
* @memberof ACHReturnCreateRequest
*/
'ach_initiated_at'?: string;
/**
* The account number correction reported by the RDFI. Populate only if the `resolution_code` is `NOTICE_OF_CHANGE`.
* @type {string}
* @memberof ACHReturnCreateRequest
*/
'corrected_account_number'?: string;
/**
* The routing number correction reported by the RDFI. Populate only if the `resolution_code` is `NOTICE_OF_CHANGE`. Must be a valid 9-digit routing number format.
* @type {string}
* @memberof ACHReturnCreateRequest
*/
'corrected_routing_number'?: string;
/**
* Client-defined identifier for this specific return submission. Allows you to track and reference you requests.
* @type {string}
* @memberof ACHReturnCreateRequest
*/
'id': string;
/**
* The unique identifier for the member associated with the transaction. Defined by MX.
* @type {string}
* @memberof ACHReturnCreateRequest
*/
'member_guid': string;
/**
* Incorrect account number used in the ACH transaction.
* @type {string}
* @memberof ACHReturnCreateRequest
*/
'return_account_number'?: string;
/**
* The associated ACH return code and notice of change code (for example, R02, R03, R04, R05, R20, NOC). See [Return Codes](/api-reference/platform-api/reference/ach-return-fields#return-codes) for a complete list.
* @type {string}
* @memberof ACHReturnCreateRequest
*/
'return_code': string;
/**
* Notes that you set to inform MX on internal ACH processing.
* @type {string}
* @memberof ACHReturnCreateRequest
*/
'return_notes'?: string;
/**
* Incorrect routing number used in the ACH transaction.
* @type {string}
* @memberof ACHReturnCreateRequest
*/
'return_routing_number'?: string;
/**
* The date and time when the return was reported by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp.
* @type {string}
* @memberof ACHReturnCreateRequest
*/
'returned_at'?: string;
/**
* The SEC code (Standard Entry Class Code)–a three-letter code describing how a payment was authorized (for example, `WEB`). See [SEC Codes](/api-reference/platform-api/reference/ach-return-fields#sec-codes) for a complete list.
* @type {string}
* @memberof ACHReturnCreateRequest
*/
'sec_code'?: string;
/**
* The amount of the transaction.
* @type {number}
* @memberof ACHReturnCreateRequest
*/
'transaction_amount'?: number;
/**
* The transaction amount range, used for impact assessment.
* @type {number}
* @memberof ACHReturnCreateRequest
*/
'transaction_amount_range'?: number;
/**
* MX-defined identifier for the user associated with the ACH return.
* @type {string}
* @memberof ACHReturnCreateRequest
*/
'user_guid': string;
}
/**
*
* @export
* @interface ACHReturnCreateRequestBody
*/
export interface ACHReturnCreateRequestBody {
/**
*
* @type {ACHReturnCreateRequest}
* @memberof ACHReturnCreateRequestBody
*/
'ach_return'?: ACHReturnCreateRequest;
}
/**
*
* @export
* @interface ACHReturnResponseBody
*/
export interface ACHReturnResponseBody {
/**
*
* @type {ACHResponse}
* @memberof ACHReturnResponseBody
*/
'ach_return'?: ACHResponse;
}
/**
*
* @export
* @interface ACHReturnsResponseBody
*/
export interface ACHReturnsResponseBody {
/**
*
* @type {Array<ACHResponse>}
* @memberof ACHReturnsResponseBody
*/
'ach_returns'?: Array<ACHResponse>;
/**
*
* @type {PaginationResponse}
* @memberof ACHReturnsResponseBody
*/
'pagination'?: PaginationResponse;
}
/**
*
* @export
* @interface AccountCreateRequest
*/
export interface AccountCreateRequest {
/**
*
* @type {string}
* @memberof AccountCreateRequest
*/
'account_subtype'?: string;
/**
*
* @type {string}
* @memberof AccountCreateRequest
*/
'account_type': string;
/**
*
* @type {number}
* @memberof AccountCreateRequest
*/
'apr'?: number;
/**
*
* @type {number}
* @memberof AccountCreateRequest
*/
'apy'?: number;
/**
*
* @type {number}
* @memberof AccountCreateRequest
*/
'available_balance'?: number;
/**
*
* @type {number}
* @memberof AccountCreateRequest
*/
'balance'?: number;
/**
*
* @type {number}
* @memberof AccountCreateRequest
*/
'cash_surrender_value'?: number;
/**
*
* @type {number}
* @memberof AccountCreateRequest
*/
'credit_limit'?: number;
/**
*
* @type {string}
* @memberof AccountCreateRequest
*/
'currency_code'?: string;
/**
*
* @type {number}
* @memberof AccountCreateRequest
*/
'death_benefit'?: number;
/**
*
* @type {number}
* @memberof AccountCreateRequest
*/
'interest_rate'?: number;
/**
*
* @type {boolean}
* @memberof AccountCreateRequest
*/
'is_business'?: boolean;
/**
*
* @type {boolean}
* @memberof AccountCreateRequest
*/
'is_closed'?: boolean;
/**
*
* @type {boolean}
* @memberof AccountCreateRequest
*/
'is_hidden'?: boolean;
/**
*
* @type {number}
* @memberof AccountCreateRequest
*/
'loan_amount'?: number;
/**
*
* @type {string}
* @memberof AccountCreateRequest
*/
'metadata'?: string;
/**
*
* @type {string}
* @memberof AccountCreateRequest
*/
'name': string;
/**
*
* @type {string}
* @memberof AccountCreateRequest
*/
'nickname'?: string;
/**
*
* @type {number}
* @memberof AccountCreateRequest
*/
'original_balance'?: number;
/**
*
* @type {string}
* @memberof AccountCreateRequest
*/
'property_type'?: string;
/**
*
* @type {boolean}
* @memberof AccountCreateRequest
*/
'skip_webhook'?: boolean;
}
/**
*
* @export
* @interface AccountCreateRequestBody
*/
export interface AccountCreateRequestBody {
/**
*
* @type {AccountCreateRequest}
* @memberof AccountCreateRequestBody
*/
'account'?: AccountCreateRequest;
}
/**
*
* @export
* @interface AccountNumberResponse
*/
export interface AccountNumberResponse {
/**
*
* @type {string}
* @memberof AccountNumberResponse
*/
'account_guid'?: string | null;
/**
*
* @type {string}
* @memberof AccountNumberResponse
*/
'account_number'?: string | null;
/**
*
* @type {string}
* @memberof AccountNumberResponse
*/
'guid'?: string | null;
/**
*
* @type {string}
* @memberof AccountNumberResponse
*/
'institution_number'?: string | null;
/**
*
* @type {string}
* @memberof AccountNumberResponse
*/
'loan_guarantor'?: string | null;
/**
*
* @type {string}
* @memberof AccountNumberResponse
*/
'loan_reference_number'?: string | null;
/**
*
* @type {string}
* @memberof AccountNumberResponse
*/
'member_guid'?: string | null;
/**
*
* @type {boolean}
* @memberof AccountNumberResponse
*/
'passed_validation'?: boolean | null;
/**
*
* @type {string}
* @memberof AccountNumberResponse
*/
'routing_number'?: string | null;
/**
*
* @type {string}
* @memberof AccountNumberResponse
*/
'sequence_number'?: string | null;
/**
*
* @type {string}
* @memberof AccountNumberResponse
*/
'transit_number'?: string | null;
/**
*
* @type {string}
* @memberof AccountNumberResponse
*/
'user_guid'?: string | null;
}
/**
*
* @export
* @interface AccountNumbersResponseBody
*/
export interface AccountNumbersResponseBody {
/**
*
* @type {Array<AccountNumberResponse>}
* @memberof AccountNumbersResponseBody
*/
'account_numbers'?: Array<AccountNumberResponse>;
/**
*
* @type {PaginationResponse}
* @memberof AccountNumbersResponseBody
*/
'pagination'?: PaginationResponse;
}
/**
*
* @export
* @interface AccountOwnerResponse
*/
export interface AccountOwnerResponse {
/**
*
* @type {string}
* @memberof AccountOwnerResponse
*/
'account_guid'?: string | null;
/**
*
* @type {string}
* @memberof AccountOwnerResponse
*/
'address'?: string | null;
/**
*
* @type {string}
* @memberof AccountOwnerResponse
*/
'city'?: string | null;
/**
*
* @type {string}
* @memberof AccountOwnerResponse
*/
'country'?: string | null;
/**
*
* @type {string}
* @memberof AccountOwnerResponse
*/
'email'?: string | null;
/**
*
* @type {string}
* @memberof AccountOwnerResponse
*/
'first_name'?: string | null;
/**
*
* @type {string}
* @memberof AccountOwnerResponse
*/
'guid'?: string | null;
/**
*
* @type {string}
* @memberof AccountOwnerResponse
*/
'last_name'?: string | null;
/**
*
* @type {string}
* @memberof AccountOwnerResponse
*/
'member_guid'?: string | null;
/**
*
* @type {string}
* @memberof AccountOwnerResponse
*/
'owner_name'?: string | null;
/**
*
* @type {string}
* @memberof AccountOwnerResponse
*/
'phone'?: string | null;
/**
*
* @type {string}
* @memberof AccountOwnerResponse
*/
'postal_code'?: string | null;
/**
*
* @type {string}
* @memberof AccountOwnerResponse
*/
'state'?: string | null;
/**
*
* @type {string}
* @memberof AccountOwnerResponse
*/
'user_guid'?: string | null;
}
/**
*
* @export
* @interface AccountOwnersResponseBody
*/
export interface AccountOwnersResponseBody {
/**
*
* @type {Array<AccountOwnerResponse>}
* @memberof AccountOwnersResponseBody
*/
'account_owners'?: Array<AccountOwnerResponse>;
/**
*
* @type {PaginationResponse}
* @memberof AccountOwnersResponseBody
*/
'pagination'?: PaginationResponse;
}
/**
*
* @export
* @interface AccountResponse
*/
export interface AccountResponse {
/**
*
* @type {string}
* @memberof AccountResponse
*/
'account_number'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'account_number_set_by'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'account_ownership'?: string | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'annuity_policy_to_date'?: string | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'annuity_provider'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'annuity_term_year'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'apr'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'apr_set_by'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'apy'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'apy_set_by'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'available_balance'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'available_balance_set_by'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'available_credit'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'available_credit_set_by'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'balance'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'balance_set_by'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'calculated_apr'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'cash_balance'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'cash_balance_set_by'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'cash_surrender_value'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'cash_surrender_value_set_by'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'created_at'?: string;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'credit_limit'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'credit_limit_set_by'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'currency_code'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'currency_code_set_by'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'day_payment_is_due'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'day_payment_is_due_set_by'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'death_benefit'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'death_benefit_set_by'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'federal_insurance_status'?: string | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'feed_account_number'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_account_subtype'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_account_type'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_apr'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_apy'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_available_balance'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_balance'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_cash_balance'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_cash_surrender_value'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_credit_limit'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'feed_currency_code'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_day_payment_is_due'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_death_benefit'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_holdings_value'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_interest_rate'?: number | null;
/**
*
* @type {boolean}
* @memberof AccountResponse
*/
'feed_is_closed'?: boolean | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_last_payment'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'feed_last_payment_at'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_loan_amount'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'feed_matures_on'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_minimum_balance'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_minimum_payment'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'feed_name'?: string | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'feed_nickname'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_original_balance'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'feed_payment_due_at'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_payoff_balance'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'feed_routing_number'?: string | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'feed_started_on'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_statement_balance'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'feed_total_account_value'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'guid'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'holdings_value'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'holdings_value_set_by'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'id'?: string | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'imported_at'?: string | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'institution_code'?: string | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'institution_guid'?: string | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'insured_name'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'interest_rate'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'interest_rate_set_by'?: number | null;
/**
*
* @type {boolean}
* @memberof AccountResponse
*/
'is_closed'?: boolean | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'is_closed_set_by'?: number | null;
/**
*
* @type {boolean}
* @memberof AccountResponse
*/
'is_hidden'?: boolean | null;
/**
*
* @type {boolean}
* @memberof AccountResponse
*/
'is_manual'?: boolean | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'last_payment'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'last_payment_set_by'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'last_payment_at'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'last_payment_at_set_by'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'loan_amount'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'loan_amount_set_by'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'margin_balance'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'matures_on'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'matures_on_set_by'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'member_guid'?: string | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'member_id'?: string | null;
/**
*
* @type {boolean}
* @memberof AccountResponse
*/
'member_is_managed_by_user'?: boolean | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'metadata'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'minimum_balance'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'minimum_balance_set_by'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'minimum_payment'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'minimum_payment_set_by'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'name'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'name_set_by'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'nickname'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'nickname_set_by'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'original_balance'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'original_balance_set_by'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'pay_out_amount'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'payment_due_at'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'payment_due_at_set_by'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'payoff_balance'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'payoff_balance_set_by'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'premium_amount'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'property_type'?: string | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'routing_number'?: string | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'started_on'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'started_on_set_by'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'statement_balance'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'statement_balance_set_by'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'subtype'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'subtype_set_by'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'today_ugl_amount'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'today_ugl_percentage'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'total_account_value'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'total_account_value_set_by'?: number | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'total_account_value_ugl'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'type'?: string | null;
/**
*
* @type {number}
* @memberof AccountResponse
*/
'type_set_by'?: number | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'updated_at'?: string | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'user_guid'?: string | null;
/**
*
* @type {string}
* @memberof AccountResponse
*/
'user_id'?: string | null;
}
/**
*
* @export
* @interface AccountResponseBody
*/
export interface AccountResponseBody {
/**
*
* @type {AccountResponse}
* @memberof AccountResponseBody
*/
'account'?: AccountResponse;
}
/**
*
* @export
* @interface AccountUpdateRequest
*/
export interface AccountUpdateRequest {
/**
* Can only be updated for manual accounts.
* @type {string}
* @memberof AccountUpdateRequest
*/
'account_subtype'?: string;
/**
* Can only be updated for manual accounts.
* @type {string}
* @memberof AccountUpdateRequest
*/
'account_type'?: string;
/**
* Can only be updated for manual accounts.
* @type {number}
* @memberof AccountUpdateRequest
*/
'apr'?: number;
/**
* Can only be updated for manual accounts.
* @type {number}
* @memberof AccountUpdateRequest
*/
'apy'?: number;
/**
* Can only be updated for manual accounts.
* @type {number}
* @memberof AccountUpdateRequest
*/
'available_balance'?: number;
/**
* Can only be updated for manual accounts.
* @type {number}
* @memberof AccountUpdateRequest
*/
'balance'?: number;
/**
* Can only be updated for manual accounts.
* @type {number}
* @memberof AccountUpdateRequest
*/
'cash_surrender_value'?: number;
/**
* Can only be updated for manual accounts.
* @type {number}
* @memberof AccountUpdateRequest
*/
'credit_limit'?: number;
/**
* Can only be updated for manual accounts.
* @type {string}
* @memberof AccountUpdateRequest
*/
'currency_code'?: string;
/**
* Can only be updated for manual accounts.
* @type {number}
* @memberof AccountUpdateRequest
*/
'death_benefit'?: number;
/**
* Can only be updated for manual accounts.
* @type {number}
* @memberof AccountUpdateRequest
*/
'interest_rate'?: number;
/**
* Can be updated for manual accounts and aggregated accounts.
* @type {boolean}
* @memberof AccountUpdateRequest
*/
'is_business'?: boolean;
/**
* Can only be updated for manual accounts.
* @type {boolean}
* @memberof AccountUpdateRequest
*/
'is_closed'?: boolean;
/**
* Can be updated for manual accounts and aggregated accounts.
* @type {boolean}
* @memberof AccountUpdateRequest
*/
'is_hidden'?: boolean;
/**
* Can only be updated for manual accounts.
* @type {number}
* @memberof AccountUpdateRequest
*/
'loan_amount'?: number;
/**
* Can only be updated for manual accounts.
* @type {string}
* @memberof AccountUpdateRequest
*/
'metadata'?: string;
/**
* Can only be updated for manual accounts.
* @type {string}
* @memberof AccountUpdateRequest
*/
'name'?: string;
/**
* Can only be updated for manual accounts.
* @type {string}
* @memberof AccountUpdateRequest
*/
'nickname'?: string;
/**
* Can only be updated for manual accounts.
* @type {number}
* @memberof AccountUpdateRequest
*/
'original_balance'?: number;
/**
* Can only be updated for manual accounts.
* @type {string}
* @memberof AccountUpdateRequest
*/
'property_type'?: string;
/**
* If set to true, prevents sending an account webhook for the update if that webhook type is enabled for you.
* @type {boolean}
* @memberof AccountUpdateRequest
*/
'skip_webhook'?: boolean;
}
/**
*
* @export
* @interface AccountUpdateRequestBody
*/
export interface AccountUpdateRequestBody {
/**
*
* @type {AccountUpdateRequest}
* @memberof AccountUpdateRequestBody
*/
'account'?: AccountUpdateRequest;
}
/**
*
* @export
* @interface AccountsResponseBody
*/
export interface AccountsResponseBody {
/**
*
* @type {Array<AccountResponse>}
* @memberof AccountsResponseBody
*/
'accounts'?: Array<AccountResponse>;
/**
*
* @type {PaginationResponse}
* @memberof AccountsResponseBody
*/
'pagination'?: PaginationResponse;
}
/**
*
* @export
* @interface AuthorizationCodeRequest
*/
export interface AuthorizationCodeRequest {
/**
*
* @type {string}
* @memberof AuthorizationCodeRequest
*/
'scope'?: string | null;
}
/**
*
* @export
* @interface AuthorizationCodeRequestBody
*/
export interface AuthorizationCodeRequestBody {
/**
*
* @type {AuthorizationCodeRequest}
* @memberof AuthorizationCodeRequestBody
*/
'authorization_code'?: AuthorizationCodeRequest;
}
/**
*
* @export
* @interface AuthorizationCodeResponse
*/
export interface AuthorizationCodeResponse {
/**
*
* @type {string}
* @memberof AuthorizationCodeResponse
*/
'code'?: string | null;
}
/**
*
* @export
* @interface AuthorizationCodeResponseBody
*/
export interface AuthorizationCodeResponseBody {
/**
*
* @type {AuthorizationCodeResponse}
* @memberof AuthorizationCodeResponseBody
*/
'authorization_code'?: AuthorizationCodeResponse;
}
/**
*
* @export
* @interface BudgetCreateRequest
*/
export interface BudgetCreateRequest {
/**
* Unique identifier of the category.
* @type {string}
* @memberof BudgetCreateRequest
*/
'category_guid': string;
/**
* Unique identifier of the parent budget. This is only required when creating a budget on a sub-category.
* @type {string}
* @memberof BudgetCreateRequest
*/
'parent_guid': string;
/**
* Amount of the budget.
* @type {number}
* @memberof BudgetCreateRequest
*/
'amount'?: number;
/**
* Additional information a partner can store on the budget.
* @type {string}
* @memberof BudgetCreateRequest
*/
'metadata'?: string;
/**
* When set to true, this parameter will prevent a webhook from being triggered by the request.
* @type {boolean}
* @memberof BudgetCreateRequest
*/
'skip_webhook'?: boolean;
}
/**
*
* @export
* @interface BudgetCreateRequestBody
*/
export interface BudgetCreateRequestBody {
/**
*
* @type {BudgetCreateRequest}
* @memberof BudgetCreateRequestBody
*/
'budget'?: BudgetCreateRequest;
}
/**
*
* @export
* @interface BudgetResponse
*/
export interface BudgetResponse {
/**
* A goal amount set by the user for a category\'s transaction total during a month.
* @type {number}
* @memberof BudgetResponse
*/
'amount'?: number;
/**
* Unique identifier for the budget category. Defined by MX.
* @type {string}
* @memberof BudgetResponse
*/
'category_guid'?: string;
/**
* Date and time the budget was created, represented in ISO 8601 format with timestamp.
* @type {string}
* @memberof BudgetResponse
*/
'created_at'?: string;
/**
* Unique identifier for the budget. Defined by MX.
* @type {string}
* @memberof BudgetResponse
*/
'guid'?: string;
/**
* If the budget has been exceeded, this field will be true. Otherwise, this field will be false.
* @type {boolean}
* @memberof BudgetResponse
*/
'is_exceeded'?: boolean;
/**
* If the budget is off track, this field will be true. Otherwise, this field will be false.
* @type {boolean}
* @memberof BudgetResponse
*/
'is_off_track'?: boolean;
/**
* Additional information a partner can store on the budget.
* @type {string}
* @memberof BudgetResponse
*/
'metadata'?: string | null;
/**
* The name of the budget that is visible to the user (ie \"Food\", \"Bills\", \"Entertainment\", etc).
* @type {string}
* @memberof BudgetResponse
*/
'name'?: string | null;
/**
* The percentage amount of off track spending. (Deprecated).
* @type {number}
* @memberof BudgetResponse
*/
'off_track_percentage'?: number | null;
/**
* Unique identifier for the parent budget. Defined by MX.
* @type {string}
* @memberof BudgetResponse
*/
'parent_guid'?: string | null;
/**
* The percentage of a budget that has been spent during the current calendar month Calculated as the transaction total divided by the amount and then multiplied by 100.A value of zero will be returned when `amount` is zero.
* @type {number}
* @memberof BudgetResponse
*/
'percent_spent'?: number | null;
/**
* The projected amount of spending for the budget.
* @type {number}
* @memberof BudgetResponse
*/
'projected_spending'?: number;
/**
* The revision number of this budget record.
* @type {number}
* @memberof BudgetResponse
*/
'revision'?: number;
/**
* The cumulative amount of all transactions under the budget.
* @type {any}
* @memberof BudgetResponse
*/
'transaction_total'?: any;
/**
* Date and time the budget was updated, represented in ISO 8601 format with timestamp.
* @type {any}
* @memberof BudgetResponse
*/
'updated_at'?: any;
/**
* Unique identifier for the user. Defined by MX.
* @type {any}
* @memberof BudgetResponse
*/
'user_guid'?: any;
}
/**
*
* @export
* @interface BudgetResponseBody
*/
export interface BudgetResponseBody {
/**
*
* @type {BudgetResponse}
* @memberof BudgetResponseBody
*/
'budget'?: BudgetResponse;
}
/**
*
* @export
* @interface BudgetUpdateRequest
*/
export interface BudgetUpdateRequest {
/**
* Amount of the budget.
* @type {number}
* @memberof BudgetUpdateRequest
*/
'amount'?: number;
/**
* Additional information a partner can store on the budget.
* @type {string}
* @memberof BudgetUpdateRequest
*/
'metadata'?: string;
/**
* When set to true, this parameter will prevent a webhook from being triggered by the request.
* @type {boolean}
* @memberof BudgetUpdateRequest
*/
'skip_webhook'?: boolean;
}
/**
*
* @export
* @interface BudgetUpdateRequestBody
*/
export interface BudgetUpdateRequestBody {
/**
*
* @type {BudgetUpdateRequest}
* @memberof BudgetUpdateRequestBody
*/
'budget'?: BudgetUpdateRequest;
}
/**
*
* @export
* @interface CategoriesResponseBody
*/
export interface CategoriesResponseBody {
/**
*
* @type {Array<CategoryResponse>}
* @memberof CategoriesResponseBody
*/
'categories'?: Array<CategoryResponse>;
/**
*
* @type {PaginationResponse}
* @memberof CategoriesResponseBody
*/
'pagination'?: PaginationResponse;
}
/**
*
* @export
* @interface CategoryCreateRequest
*/
export interface CategoryCreateRequest {
/**
*
* @type {string}
* @memberof CategoryCreateRequest
*/
'metadata'?: string;
/**
*
* @type {string}
* @memberof CategoryCreateRequest
*/
'name': string;
/**
*
* @type {string}
* @memberof CategoryCreateRequest
*/
'parent_guid': string;
}
/**
*
* @export
* @interface CategoryCreateRequestBody
*/
export interface CategoryCreateRequestBody {
/**
*
* @type {CategoryCreateRequest}
* @memberof CategoryCreateRequestBody
*/
'category'?: CategoryCreateRequest;
}
/**
*
* @export
* @interface CategoryResponse
*/
export interface CategoryResponse {
/**
* Category creation date-time.
* @type {string}
* @memberof CategoryResponse
*/
'created_at'?: string | null;
/**
*
* @type {string}
* @memberof CategoryResponse
*/
'guid'?: string | null;
/**
*
* @type {boolean}
* @memberof CategoryResponse
*/
'is_default'?: boolean | null;
/**
*
* @type {boolean}
* @memberof CategoryResponse
*/
'is_income'?: boolean | null;
/**
*
* @type {string}
* @memberof CategoryResponse
*/
'metadata'?: string | null;
/**
*
* @type {string}
* @memberof CategoryResponse
*/
'name'?: string | null;
/**
*
* @type {string}
* @memberof CategoryResponse
*/
'parent_guid'?: string | null;
/**
*
* @type {string}
* @memberof CategoryResponse
*/
'updated_at'?: string | null;
}
/**
*
* @export
* @interface CategoryResponseBody
*/
export interface CategoryResponseBody {
/**
*
* @type {CategoryResponse}
* @memberof CategoryResponseBody
*/
'category'?: CategoryResponse;
}
/**
*
* @export
* @interface CategoryUpdateRequest
*/
export interface CategoryUpdateRequest {
/**
*
* @type {string}
* @memberof CategoryUpdateRequest
*/
'metadata'?: string;
/**
*
* @type {string}
* @memberof CategoryUpdateRequest
*/
'name'?: string;
}
/**
*
* @export
* @interface CategoryUpdateRequestBody
*/
export interface CategoryUpdateRequestBody {
/**
*
* @type {CategoryUpdateRequest}
* @memberof CategoryUpdateRequestBody
*/
'category'?: CategoryUpdateRequest;
}
/**
*
* @export
* @interface ChallengeResponse
*/
export interface ChallengeResponse {
/**
*
* @type {string}
* @memberof ChallengeResponse
*/
'field_name'?: string | null;
/**
*
* @type {string}
* @memberof ChallengeResponse
*/
'guid'?: string | null;
/**
*
* @type {string}
* @memberof ChallengeResponse
*/
'image_data'?: string | null;
/**
*
* @type {Array<ImageOptionResponse>}
* @memberof ChallengeResponse
*/
'image_options'?: Array<ImageOptionResponse>;
/**
*
* @type {string}
* @memberof ChallengeResponse
*/
'label'?: string | null;
/**
*
* @type {Array<OptionResponse>}
* @memberof ChallengeResponse
*/
'options'?: Array<OptionResponse>;
/**
*
* @type {string}
* @memberof ChallengeResponse
*/
'type'?: string | null;
}
/**
*
* @export
* @interface ChallengesResponseBody
*/
export interface ChallengesResponseBody {
/**
*
* @type {Array<ChallengeResponse>}
* @memberof ChallengesResponseBody
*/
'challenges'?: Array<ChallengeResponse>;
/**
*
* @type {PaginationResponse}
* @memberof ChallengesResponseBody
*/
'pagination'?: PaginationResponse;
}
/**
*
* @export
* @interface ConnectWidgetRequest
*/
export interface ConnectWidgetRequest {
/**
*
* @type {string}
* @memberof ConnectWidgetRequest
*/
'client_redirect_url'?: string;
/**
*
* @type {string}
* @memberof ConnectWidgetRequest
*/
'color_scheme'?: string;
/**
*
* @type {string}
* @memberof ConnectWidgetRequest
*/
'current_institution_code'?: string;
/**
*
* @type {string}
* @memberof ConnectWidgetRequest
*/
'current_member_guid'?: string;
/**
*
* @type {boolean}
* @memberof ConnectWidgetRequest
*/
'disable_background_agg'?: boolean;
/**
*
* @type {boolean}
* @memberof ConnectWidgetRequest
*/
'disable_institution_search'?: boolean;
/**
* This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to `true`. When set to `false`, the widget will **not** direct the end user to the institution\'s mobile application. This setting is not persistent. This setting currently only affects Chase institutions.
* @type {boolean}
* @memberof ConnectWidgetRequest
*/
'enable_app2app'?: boolean;
/**
*
* @type {boolean}
* @memberof ConnectWidgetRequest
*/
'include_identity'?: boolean;
/**
*
* @type {boolean}
* @memberof ConnectWidgetRequest
*/
'include_transactions'?: boolean;
/**
*
* @type {boolean}
* @memberof ConnectWidgetRequest
*/
'is_mobile_webview'?: boolean;
/**
*
* @type {string}
* @memberof ConnectWidgetRequest
*/
'mode'?: string;
/**
*
* @type {string}
* @memberof ConnectWidgetRequest
*/
'oauth_referral_source'?: string;
/**
*
* @type {number}
* @memberof ConnectWidgetRequest
*/
'ui_message_version'?: number;
/**
*
* @type {string}
* @memberof ConnectWidgetRequest
*/
'ui_message_webview_url_scheme'?: string;
/**
*
* @type {boolean}
* @memberof ConnectWidgetRequest
*/
'update_credentials'?: boolean;
}
/**
*
* @export
* @interface ConnectWidgetRequestBody
*/
export interface ConnectWidgetRequestBody {
/**
*
* @type {ConnectWidgetRequest}
* @memberof ConnectWidgetRequestBody
*/
'config'?: ConnectWidgetRequest;
}
/**
*
* @export
* @interface ConnectWidgetResponse
*/
export interface ConnectWidgetResponse {
/**
*
* @type {string}
* @memberof ConnectWidgetResponse
*/
'connect_widget_url'?: string | null;
/**
*
* @type {string}
* @memberof ConnectWidgetResponse
*/
'guid'?: string | null;
}
/**
*
* @export
* @interface ConnectWidgetResponseBody
*/
export interface ConnectWidgetResponseBody {
/**
*
* @type {ConnectWidgetResponse}
* @memberof ConnectWidgetResponseBody
*/
'user'?: ConnectWidgetResponse;
}
/**
*
* @export
* @interface CredentialRequest
*/
export interface CredentialRequest {
/**
*
* @type {string}
* @memberof CredentialRequest
*/
'guid'?: string;
/**
*
* @type {string}
* @memberof CredentialRequest
*/
'value'?: string;
}
/**
*
* @export
* @interface CredentialResponse
*/
export interface CredentialResponse {
/**
*
* @type {number}
* @memberof CredentialResponse
*/
'display_order'?: number | null;
/**
*
* @type {string}
* @memberof CredentialResponse
*/
'field_name'?: string | null;
/**
*
* @type {string}
* @memberof CredentialResponse
*/
'field_type'?: string | null;
/**
*
* @type {string}
* @memberof CredentialResponse
*/
'guid'?: string | null;
/**
*
* @type {string}
* @memberof CredentialResponse
*/
'label'?: string | null;
/**
*
* @type {string}
* @memberof CredentialResponse
*/
'type'?: string | null;
}
/**
*
* @export
* @interface CredentialsResponseBody
*/
export interface CredentialsResponseBody {
/**
*
* @type {Array<CredentialResponse>}
* @memberof CredentialsResponseBody
*/
'credentials'?: Array<CredentialResponse>;
/**
*
* @type {PaginationResponse}
* @memberof CredentialsResponseBody
*/
'pagination'?: PaginationResponse;
}
/**
*
* @export
* @interface CreditCardProduct
*/
export interface CreditCardProduct {
/**
*
* @type {number}
*