NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

MX Technologies

mx_technologies

MX Technologies provides a comprehensive API platform for aggregating and enhancing financial data, enabling seamless connections to numerous financial institutions.

Developer ToolsDatabasesWeb del proveedor
Acciones
33
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (33)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Cancel Partner AccountMX_TECHNOLOGIES_CANCEL_PARTNER_ACCOUNTAcción

Tool to cancel (disable) a client account under a partner account. this maps to mx platform api: put /users/{guid} with body {"user": {"is disabled": true, "metadata": "..."}}.

Parámetros de entrada

  • reason_idintegerenum

    Reason code for cancellation. Allowed values: 1 (Cost Too High), 2 (Using A Competitive Service), 3 (Not Doing Email Marketing), 11 (Something Missing Or Not Working), 12 (Doing It In-House), 14 (Poor Results), 21 (Too Difficult To Use), 27 (Canceled Online by Customer), 30 (Dissatisfied With Billing Policies).

    123111214212730
  • effective_datestring

    Future cancellation timestamp in ISO 8601 format. If omitted or a past time is provided, cancellation defaults to the current date/time.

  • encoded_account_idstringObligatorio

    The client’s MX user GUID (encoded account ID).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create accountMX_TECHNOLOGIES_CREATE_ACCOUNTAcción

Tool to create a manual account for a given user. use when you need to add an external or test account to a user record.

Parámetros de entrada

  • accountobjectObligatorio

    Defines the fields for creating a manual account under a user.

  • user_guidstringObligatorio

    GUID of the user under which to create the account, must start with 'USR-'

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Retrieve Audience API CredentialsMX_TECHNOLOGIES_CREATE_AUDIENCE_API_CREDENTIALSAcción

Tool to retrieve audience api credentials. use when obtaining client id and client secret for audience service authentication before generating an access token. credentials must be created in the partner dashboard (partner administrator → authentication → audience api key). the tool prefers explicitly provided values, then falls back to environment variables.

Parámetros de entrada

  • client_idstring

    Audience API credential client ID (optional; falls back to env)

  • client_secretstring

    Audience API credential client secret (optional; falls back to env)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create memberMX_TECHNOLOGIES_CREATE_MEMBERAcción

Tool to create a member and start aggregating specified financial products. use after confirming user guid and gathering connection credentials or oauth details.

Parámetros de entrada

  • memberobject

    Member creation details; differs for OAuth vs non-OAuth flows.

  • user_guidstringObligatorio

    User GUID prefixed with 'USR-'.

  • dataRequestobjectObligatorio

    Container for requested products to aggregate.

  • enable_app2appboolean

    If false, disable deep-linking into institution mobile apps.

  • referral_sourcestring

    For mobile OAuth only; set to 'APP'.

  • x_callback_payloadstring

    Optional base64-encoded payload echoed in member webhooks; max length 1024 chars.

  • client_redirect_urlstringuri

    URL or URI scheme for returning UI messages in OAuth flows.

  • ui_message_webview_url_schemestring

    Custom scheme for UI message webviews.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Partner AccountMX_TECHNOLOGIES_CREATE_PARTNER_ACCOUNTAcción

Tool to create a new client account under a partner account. use when provisioning a new constant contact client after obtaining api key and jwt authorization.

Parámetros de entrada

  • websiteanyuri
  • passwordstring

    Password for the account (8–80 chars). Required unless using SSO/external authenticator.

  • last_namestring

    Last name of the client account owner.

  • first_namestring

    First name of the client account owner.

  • login_namestringObligatorio

    Unique login; allowed characters: alphanumeric, '-', '_', '.', '+', '@'.

  • state_codestring

    Required for US states and Canadian provinces; two-letter code.

  • external_idstring

    External authenticator's unique ID for the client account.

  • country_codestringObligatorio

    Two-letter ISO 3166-1 country code.

  • gdpr_opt_outboolean

    Set true to prevent marketing communications to the account.

  • idp_providerstring

    SSO identity provider name (use in place of password).

  • time_zone_idstring

    Time zone ID for the client's location.

  • contact_emailstringObligatorio

    Valid email address for the new client account.

  • contact_phonestring

    Contact phone number for the client account.

  • billing_localestringenum

    Currency locale; 'en_US' (USD) or 'en_GB' (GBP).

    en_USen_GB
  • idp_provider_idstring

    SSO identity provider unique ID (use in place of password).

  • external_providerstring

    Name of the external authenticator (e.g., PayPal, Yahoo).

  • organization_namestring

    Organization name for the client account.

  • managed_site_ownerboolean

    Managed accounts default to true; overriding to false is ignored.

  • organization_phonestring

    Organization phone number for the client account.

  • partner_account_idstring

    Partner-defined unique identifier for billing or reporting.

  • enable_single_billingboolean

    Enable single billing when partner account supports it and managed_site_owner is true.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Partner Account User SSOMX_TECHNOLOGIES_CREATE_PARTNER_ACCOUNT_USER_SSOAcción

Tool to create a new partner account user with single sign-on enabled. use when adding an sso user under a partner client account with 'sso for all users' enabled.

Parámetros de entrada

  • last_namestringObligatorio

    User's last name

  • role_namestringObligatorioenum

    User role; values include 'account_manager' or 'campaign_creator'

    account_managercampaign_creator
  • first_namestringObligatorio

    User's first name

  • login_namestringObligatorio

    Unique login name for the account

  • external_idstringObligatorio

    ID that uniquely identifies the user for the external authenticator

  • contact_emailstringObligatorioemail

    Unique email to associate with the user

  • encoded_account_idstringObligatorio

    The client account's encoded ID

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Fetch rewardsMX_TECHNOLOGIES_FETCH_REWARDSAcción

Tool to initiate rewards aggregation for a specific member. use after connecting the member to trigger an async rewards job.

Parámetros de entrada

  • user_guidstringObligatorio

    MX-assigned unique identifier for the user.

  • member_guidstringObligatorio

    MX-assigned unique identifier for the member.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get configurable widget URLMX_TECHNOLOGIES_GET_CONFIGURABLE_WIDGET_URLAcción

Tool to retrieve a configurable widget url for a user. use after determining the user guid.

Parámetros de entrada

  • configobjectObligatorio

    Configuration options container for the widget URL

  • user_guidstringObligatorio

    The user's GUID; must start with 'USR-' prefix

  • data_requestobject

    Optional data aggregation request (e.g., products).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Account Numbers by MemberMX_TECHNOLOGIES_LIST_ACCOUNT_NUMBERS_BY_MEMBERAcción

Tool to list account numbers for a specific member. use after obtaining user and member guids.

Parámetros de entrada

  • pageinteger

    Page number of results (>=1).

  • user_guidstringObligatorio

    MX user GUID (must start with 'USR-').

  • member_guidstringObligatorio

    MX member GUID (must start with 'MEM-').

  • records_per_pageinteger

    Number of records per page (10-1000).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List account ownersMX_TECHNOLOGIES_LIST_ACCOUNT_OWNERSAcción

Tool to list account owners associated with a member's account. use after validating user and member guids.

Parámetros de entrada

  • pageinteger

    Page number to retrieve (>=1).

  • user_guidstringObligatorio

    User GUID, must start with 'USR-'.

  • member_guidstringObligatorio

    Member GUID, must start with 'MEM-'.

  • records_per_pageinteger

    Number of records per page; valid values 10-1000.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List account owners by memberMX_TECHNOLOGIES_LIST_ACCOUNT_OWNERS_BY_MEMBERAcción

Tool to list account owners for a specific member. use when you have the user guid and member guid.

Parámetros de entrada

  • pageinteger

    Page number for paginated results (>=1).

  • user_guidstringObligatorio

    Unique identifier for the user (prefix USR-).

  • member_guidstringObligatorio

    Unique identifier for the member.

  • records_per_pageinteger

    Number of records per page; defaults to 25 if not provided. Valid range is 10-1000.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List accountsMX_TECHNOLOGIES_LIST_ACCOUNTSAcción

Tool to list all accounts for a user. use after confirming the user guid.

Parámetros de entrada

  • pageinteger

    Page number of results to return (1-based).

  • use_casestring[]

    Filter accounts by member use cases: 'PFM' and/or 'MONEY_MOVEMENT'.

  • is_manualboolean

    Only include accounts that were manually created.

  • user_guidstringObligatorio

    MX user GUID (must start with 'USR-').

  • records_per_pageinteger

    Number of records per page (10-1000). Defaults to MX default of 25.

  • member_is_managed_by_userboolean

    Only include accounts whose member is managed by the user.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List budgetsMX_TECHNOLOGIES_LIST_BUDGETSAcción

Tool to list budgets for a specific user. use after obtaining a valid user guid to retrieve that user’s budgets.

Parámetros de entrada

  • user_guidstringObligatorio

    The unique identifier (GUID) of the MX user.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List categoriesMX_TECHNOLOGIES_LIST_CATEGORIESAcción

Tool to list all categories for a user. use when you need to fetch both default and custom categories for a given user guid.

Parámetros de entrada

  • pageinteger

    Page number of results to return. Must be >= 1.

  • user_guidstringObligatorio

    The unique identifier (GUID) of the MX user.

  • records_per_pageinteger

    Number of records per page (10-1000). Defaults to 25.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List challengesMX_TECHNOLOGIES_LIST_CHALLENGESAcción

Tool to list mfa challenges for a member. use when the member is in challenged state to retrieve prompts to answer.

Parámetros de entrada

  • pageinteger

    Page number for paginated results, must be >= 1.

  • user_guidstringObligatorio

    The unique identifier (GUID) for the MX user (prefix 'USR-').

  • member_guidstringObligatorio

    The unique identifier (GUID) for the member.

  • records_per_pageinteger

    Number of records per page; valid range 10–1000 (default 25).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Connect Widget URLsMX_TECHNOLOGIES_LIST_CONNECT_WIDGET_URLSAcción

Tool to list connect widget urls for a user. use when you need to retrieve all connect widget urls associated with a user.

Parámetros de entrada

  • configobject

    Optional configuration for the widget. If provided, keys will be sent under widget_url. If a 'type' key is provided it will be mapped to 'widget_type'.

  • user_guidstringObligatorio

    The unique identifier (GUID) of the MX user.

  • data_requestobject

    Optional data aggregation request (e.g., { 'products': ['transactions'] }).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List favorite institutionsMX_TECHNOLOGIES_LIST_FAVORITE_INSTITUTIONSAcción

Tool to list partner favorite institutions, sorted by popularity. use when you need to retrieve a paginated set of a partner's favorite institutions.

Parámetros de entrada

  • pageinteger

    Page number of results to return. Must be >= 1.

  • iso_country_codestring[]

    Filter by ISO country codes (e.g., ['US', 'CA']).

  • records_per_pageinteger

    Number of records per page (10-100). Defaults to 25.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List goalsMX_TECHNOLOGIES_LIST_GOALSAcción

Tool to list goals for a specific user. use after obtaining a valid user guid to view user goals.

Parámetros de entrada

  • pageinteger

    Page number of results to return. Must be >= 1.

  • to_datestring

    Return goals created on or before this date (YYYY-MM-DD).

  • from_datestring

    Return goals created on or after this date (YYYY-MM-DD).

  • user_guidstringObligatorio

    The unique identifier (GUID) of the MX user.

  • records_per_pageinteger

    Number of records per page (1-1000).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List institution credentialsMX_TECHNOLOGIES_LIST_INSTITUTION_CREDENTIALSAcción

Tool to list credential fields required by a given institution. use after selecting the institution code; supports optional pagination.

Parámetros de entrada

  • pageinteger

    Page number for pagination; must be >= 1.

  • institution_codestringObligatorio

    MX-defined code for the institution (e.g., 'mxbank').

  • records_per_pageinteger

    Number of records per page for pagination; must be >= 1.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List institutionsMX_TECHNOLOGIES_LIST_INSTITUTIONSAcción

Tool to list financial institutions supported by mx. use when you need to retrieve available institutions with optional filters like name, country code, or products; supports pagination.

Parámetros de entrada

  • namestring

    Filter to institutions whose name contains the given substring.

  • pageinteger

    Page number for pagination; must be >= 1.

  • iso_country_codestring[]

    Filter by ISO country codes (e.g., ['US', 'CA', 'MX']).

  • records_per_pageinteger

    Records per page; valid values: 10-100. Defaults to 25; values >100 reset to 25.

  • supported_productsstring[]

    Filter by supported products; e.g., ['account_verification','identity_verification','transactions','history','statements','investments'].

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List member accountsMX_TECHNOLOGIES_LIST_MEMBER_ACCOUNTSAcción

Tool to list accounts for a specific member. use when you need to retrieve all accounts associated with a given user and member guid.

Parámetros de entrada

  • pageinteger

    Page number of results to return (1-based).

  • user_guidstringObligatorio

    MX user GUID (must start with 'USR-').

  • member_guidstringObligatorio

    MX member GUID (must start with 'MBR-' or 'MEM-').

  • records_per_pageinteger

    Number of records per page. Defaults to MX default if not specified.

  • member_is_managed_by_userboolean

    Filter accounts whose member is managed by the user.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List membersMX_TECHNOLOGIES_LIST_MEMBERSAcción

Tool to list members associated with a specific user. use when you need to retrieve the members for a given user guid.

Parámetros de entrada

  • pageinteger

    Page number of results to return. Must be >= 1.

  • use_casestring[]

    Filter members by one or more use cases: PFM and/or MONEY_MOVEMENT.

  • user_guidstringObligatorio

    MX-defined unique user identifier (prefix 'USR-').

  • records_per_pageinteger

    Number of records per page (10-1000). Defaults to 25.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List rewardsMX_TECHNOLOGIES_LIST_REWARDSAcción

Tool to list rewards associated with a specific user and member. use after confirming both user guid and member guid; supports pagination.

Parámetros de entrada

  • pageinteger

    Page number for paginated results (>=1).

  • user_guidstringObligatorio

    MX-assigned unique identifier for the user.

  • member_guidstringObligatorio

    MX-assigned unique identifier for the member.

  • records_per_pageinteger

    Number of records per page (>=1).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List statements by memberMX_TECHNOLOGIES_LIST_STATEMENTS_BY_MEMBERAcción

Tool to list statements for a member. use after obtaining valid user and member guids.

Parámetros de entrada

  • pageinteger

    Page number of results to return (1-based).

  • user_guidstringObligatorio

    MX user GUID (must start with 'USR-').

  • member_guidstringObligatorio

    MX member GUID (must start with 'MEM-').

  • records_per_pageinteger

    Number of records per page (10-1000). Defaults to MX default of 25.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List taggingsMX_TECHNOLOGIES_LIST_TAGGINGSAcción

Tool to list all taggings for a specific user. use when you need to fetch taggings associated with a user after obtaining their user guid.

Parámetros de entrada

  • pageinteger

    Page number of results to return. Must be >= 1.

  • user_guidstringObligatorio

    The unique identifier (GUID) of the MX user (prefix USR-).

  • records_per_pageinteger

    Number of records per page (10-1000). Defaults to 25.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List tagsMX_TECHNOLOGIES_LIST_TAGSAcción

Tool to list all tags for a user. use after obtaining a valid user guid; supports pagination.

Parámetros de entrada

  • pageinteger

    Page number of results to return. Must be >= 1.

  • user_guidstringObligatorio

    The unique identifier (GUID) of the MX user.

  • records_per_pageinteger

    Number of records per page (>=1).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List transactionsMX_TECHNOLOGIES_LIST_TRANSACTIONSAcción

Tool to list transactions for a user. use when you need to retrieve a user's transaction history across all accounts. use after obtaining a valid user guid.

Parámetros de entrada

  • pageinteger

    Page number of results to return (1-based).

  • to_dateinteger

    Unix timestamp to filter transactions up to this date (inclusive).

  • includesstring[]

    Optional enhancements to include: repeating_transactions, merchants, classifications, geolocations.

  • use_casestring[]

    Allowed values: 'PFM' and/or 'MONEY_MOVEMENT'.

  • from_dateinteger

    Unix timestamp to filter transactions from this date (inclusive).

  • user_guidstringObligatorio

    The unique identifier (GUID) of the MX user (must start with 'USR-').

  • to_created_atinteger

    Unix timestamp to filter transactions created up to this time (inclusive).

  • to_updated_atinteger

    Unix timestamp to filter transactions updated up to this time (inclusive).

  • from_created_atinteger

    Unix timestamp to filter transactions created from this time (inclusive).

  • from_updated_atinteger

    Unix timestamp to filter transactions updated from this time (inclusive).

  • records_per_pageinteger

    Number of records per page (10-1000). Defaults to MX API default of 25 if not specified.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List transactions by memberMX_TECHNOLOGIES_LIST_TRANSACTIONS_BY_MEMBERAcción

Tool to list transactions for a member. use when you have valid user and member guids and need their transactions.

Parámetros de entrada

  • pageinteger

    Page number of results to return (1-based).

  • to_dateinteger

    Unix timestamp to filter transactions to this date (midnight); defaults to 5 days forward.

  • includesstring

    Comma-separated list of enhancements: repeating_transactions,merchants,classifications,geolocations

  • from_dateinteger

    Unix timestamp to filter transactions from this date; defaults to 120 days ago.

  • user_guidstringObligatorio

    MX user GUID (must start with 'USR-').

  • member_guidstringObligatorio

    MX member GUID (must start with 'MEM-').

  • to_timestampinteger

    Unix timestamp to filter transactions to created time.

  • to_created_atinteger

    Unix timestamp to filter transactions to created-at.

  • to_updated_atinteger

    Unix timestamp to filter transactions to updated-at.

  • from_timestampinteger

    Unix timestamp to filter transactions from created time.

  • from_created_atinteger

    Unix timestamp to filter transactions from created-at.

  • from_updated_atinteger

    Unix timestamp to filter transactions from updated-at.

  • records_per_pageinteger

    Number of records per page (10-1000). Defaults to MX default of 25.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List usersMX_TECHNOLOGIES_LIST_USERSAcción

Tool to list users. use when you need to retrieve a paginated list of user accounts with optional filters.

Parámetros de entrada

  • idstring

    Filter by partner-defined user ID.

  • pageinteger

    Page number for paginated results (>=1).

  • emailstring

    Filter by user email.

  • is_disabledboolean

    Filter to only disabled users.

  • records_per_pageinteger

    Number of records per page (10-1000).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Read accountMX_TECHNOLOGIES_READ_ACCOUNTAcción

Tool to retrieve details for a specific account. use after obtaining valid user and account guids to fetch up-to-date account information.

Parámetros de entrada

  • user_guidstringObligatorio

    The unique identifier (GUID) of the MX user.

  • account_guidstringObligatorio

    The unique identifier (GUID) of the account.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Read account balanceMX_TECHNOLOGIES_READ_ACCOUNT_BALANCEAcción

Tool to retrieve the available balance for a specific account. use after confirming the user and account guids.

Parámetros de entrada

  • user_guidstringObligatorio

    MX-defined user GUID (must start with 'USR-').

  • account_guidstringObligatorio

    Unique identifier (GUID) of the account.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Read categoryMX_TECHNOLOGIES_READ_CATEGORYAcción

Tool to retrieve a default category by guid. use after confirming the default category guid.

Parámetros de entrada

  • category_guidstringObligatorio

    The unique identifier (GUID) of the default category to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Read FDX accountMX_TECHNOLOGIES_READ_FDX_ACCOUNTAcción

Tool to return details for the specified fdx account. use when you have an fdx accountid and need full account info.

Parámetros de entrada

  • accountIdstringObligatorio

    The FDX account identifier whose details to return.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not