MX Technologies transactions API
The transactions API from MX Technologies — 19 operation(s) for transactions.
The transactions API from MX Technologies — 19 operation(s) for transactions.
openapi: 3.0.0
info:
contact:
name: MX Platform API
url: https://www.mx.com/products/platform-api
description: '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/).
'
title: MX Platform accounts transactions API
version: '20111101'
servers:
- url: https://int-api.mx.com
- url: https://api.mx.com
security:
- basicAuth: []
tags:
- name: transactions
paths:
/transactions/enhance:
post:
description: Use this endpoint to categorize, cleanse, and classify transactions. These transactions are not persisted or stored on the MX platform. <br /><br />For more information on returned data, please see the [Enhanced Transactions fields guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions).
operationId: enhanceTransactions
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EnhanceTransactionsRequestBody'
description: Transaction object to be enhanced
required: true
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/EnhanceTransactionsResponseBody'
description: OK
summary: Enhance transactions
tags:
- transactions
/users/{user_guid}/accounts/{account_guid}/transactions:
post:
operationId: createManualTransaction
tags:
- transactions
summary: Create manual transaction
description: This endpoint can only be used to create manual transactions that are under a manual account. This endpoint accepts the optional MX-Skip-Webhook header and skip_webhook parameter.
parameters:
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/accountGuid'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionCreateRequestBody'
responses:
'200':
description: OK
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/TransactionCreateResponseBody'
get:
description: Requests to this endpoint return a list of transactions associated with the specified account. <br /><br /> Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
operationId: listTransactionsByAccount
parameters:
- $ref: '#/components/parameters/accountGuid'
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/fromDate'
- $ref: '#/components/parameters/toDate'
- $ref: '#/components/parameters/fromCreatedAt'
- $ref: '#/components/parameters/toCreatedAt'
- $ref: '#/components/parameters/fromUpdatedAt'
- $ref: '#/components/parameters/toUpdatedAt'
- $ref: '#/components/parameters/categoryGuidQuery'
- $ref: '#/components/parameters/categoryGuidQueryArray'
- $ref: '#/components/parameters/topLevelCategoryGuid'
- $ref: '#/components/parameters/topLevelCategoryGuidArray'
- $ref: '#/components/parameters/includes'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/TransactionsResponseBodyIncludes'
description: OK
summary: List transactions by account
tags:
- transactions
/users/{user_guid}/members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid}:
put:
description: Use this endpoint to update a specific transaction according to its unique GUID.
operationId: updateTransactionByAccount
parameters:
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/accountGuid'
- $ref: '#/components/parameters/transactionGuid'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionUpdateRequestBody'
description: Transaction object to be updated
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionResponseBody'
description: OK
summary: Update Transaction by Account
tags:
- transactions
/users/{user_guid}/members/{member_guid}/extend_history:
post:
description: Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication.
operationId: extendHistory
parameters:
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/userGuid'
responses:
'202':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: Accepted
summary: Extend history
tags:
- transactions
/users/{user_guid}/members/{member_guid}/transactions:
get:
description: Requests to this endpoint return a list of transactions associated with the specified `member`, across all accounts associated with that `member`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
operationId: listTransactionsByMember
parameters:
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/fromDate'
- $ref: '#/components/parameters/toDate'
- $ref: '#/components/parameters/fromCreatedAt'
- $ref: '#/components/parameters/toCreatedAt'
- $ref: '#/components/parameters/fromUpdatedAt'
- $ref: '#/components/parameters/toUpdatedAt'
- $ref: '#/components/parameters/categoryGuidQuery'
- $ref: '#/components/parameters/categoryGuidQueryArray'
- $ref: '#/components/parameters/topLevelCategoryGuid'
- $ref: '#/components/parameters/topLevelCategoryGuidArray'
- $ref: '#/components/parameters/includes'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/TransactionsResponseBodyIncludes'
description: OK
summary: List transactions by member
tags:
- transactions
/users/{user_guid}/tags/{tag_guid}/transactions:
get:
description: Use this endpoint to get a list of all transactions associated with a particular tag according to the tag's unique GUID. This lists all transactions that have been assigned to a particular tag using the create tagging endpoint. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
operationId: listTransactionsByTag
parameters:
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/tagGuid'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/fromDate'
- $ref: '#/components/parameters/toDate'
- $ref: '#/components/parameters/fromCreatedAt'
- $ref: '#/components/parameters/toCreatedAt'
- $ref: '#/components/parameters/fromUpdatedAt'
- $ref: '#/components/parameters/toUpdatedAt'
- $ref: '#/components/parameters/categoryGuidQuery'
- $ref: '#/components/parameters/categoryGuidQueryArray'
- $ref: '#/components/parameters/topLevelCategoryGuid'
- $ref: '#/components/parameters/topLevelCategoryGuidArray'
- $ref: '#/components/parameters/useCase'
- $ref: '#/components/parameters/includes'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/TransactionsResponseBodyIncludes'
description: OK
summary: List transactions by tag
tags:
- transactions
/users/{user_guid}/transaction_rules/{transaction_rule_guid}:
delete:
description: Use this endpoint to permanently delete a transaction rule based on its unique GUID.
operationId: deleteTransactionRule
parameters:
- $ref: '#/components/parameters/transactionRuleGuid'
- $ref: '#/components/parameters/userGuid'
responses:
'204':
description: No Content
summary: Delete transaction rule
tags:
- transactions
/users/{user_guid}/transactions:
get:
description: Requests to this endpoint return a list of transactions associated with the specified `user`, across all members and accounts associated with that `user`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
operationId: listTransactions
parameters:
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/fromDate'
- $ref: '#/components/parameters/toDate'
- $ref: '#/components/parameters/fromCreatedAt'
- $ref: '#/components/parameters/toCreatedAt'
- $ref: '#/components/parameters/fromUpdatedAt'
- $ref: '#/components/parameters/toUpdatedAt'
- $ref: '#/components/parameters/categoryGuidQuery'
- $ref: '#/components/parameters/categoryGuidQueryArray'
- $ref: '#/components/parameters/topLevelCategoryGuid'
- $ref: '#/components/parameters/topLevelCategoryGuidArray'
- $ref: '#/components/parameters/useCase'
- $ref: '#/components/parameters/includes'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/TransactionsResponseBodyIncludes'
description: OK
summary: List transactions
tags:
- transactions
/users/{user_guid}/transactions/{transaction_guid}:
parameters:
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/transactionGuid'
get:
description: Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. <br /><br /> Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the [Optional Enhancement Query Parameter guide](/api-reference/platform-api/reference/transactions-overview#enhanced-transactions#optional-enhancement-query-parameter).
operationId: readTransaction
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/TransactionsResponseBodyIncludes'
description: OK
summary: Read transaction
tags:
- transactions
parameters:
- $ref: '#/components/parameters/includes'
put:
description: Use this endpoint to update a specific transaction according to its unique GUID.
operationId: updateTransaction
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionUpdateRequestBody'
description: Transaction object with the fields to be updated.
required: true
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/TransactionResponseBody'
description: OK
summary: Update transaction
tags:
- transactions
delete:
tags:
- transactions
operationId: deleteManualTransactions
summary: Delete manual transactions
description: Delete a manual transaction. In the path, use the manual transaction guid as the `transaction_guid`, such as `MAN-810828b0-5210-4878-9bd3-f4ce514f90c4`.
responses:
'204':
description: No content
/users/{user_guid}/repeating_transactions:
get:
description: Retrieve a list of all recurring transactions for a user. <br /><br />For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions).
operationId: repeatingTransactions
parameters:
- $ref: '#/components/parameters/userGuid'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/RepeatingTransactionsResponseBody'
description: OK
summary: List Repeating Transactions
tags:
- transactions
/users/{user_guid}/repeating_transactions/{repeating_transaction_guid}:
get:
description: Get a Specific Repeating Transaction. <br /><br />List For more see the [Repeating Transactions guide](/api-reference/platform-api/v20111101/reference/transactions-overview#repeating-transactions)
operationId: specificRepeatingTransaction
parameters:
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/repeatingTransactionGuid'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/RepeatingTransactionsResponseBody'
description: OK
summary: Get a Repeating Transaction
tags:
- transactions
/users/{user_guid}/transactions/{transaction_guid}/split:
parameters:
- $ref: '#/components/parameters/transactionGuid'
- $ref: '#/components/parameters/userGuid'
delete:
tags:
- transactions
operationId: deleteSplitTransactions
summary: Delete split transactions
description: This endpoint deletes all split transactions linked to a parent transaction, but it leaves the parent transaction active. This request will also update the parent transaction's has_been_split field to false. This endpoint accepts the optional MX-Skip-Webhook header.
responses:
'204':
description: No content
post:
tags:
- transactions
operationId: createSplitTransactions
summary: Create split transactions
description: 'This endpoint creates two or more child transactions that are branched from a previous transaction. This endpoint allows you to link multiple categories, descriptions, and amounts to a parent transaction. When a split transaction is created, the parent transaction''s `has_been_split` field will automatically be updated to true and the child transactions'' `parent_guid` will have the transaction guid of the parent. The total amount of the child transactions must equal the amount of the parent transaction. Once a transaction has been split it can''t be split again. In order to re-split a transaction, it must first be un-split. This can be done by calling the Delete Split Transactions endpoint. Calling this endpoint will delete the existing child transactions and update the parent transaction''s `has_been_split` field to false. You can then re-split the parent transaction by calling Create Split Transaction again.
'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SplitTransactionRequestBody'
responses:
'200':
content:
application/vnd.mx.api.v1+json:
schema:
$ref: '#/components/schemas/SplitTransactionsResponseBody'
description: OK
/users/{user_guid}/members/{member_guid}/accounts/{account_guid}/transactions:
get:
description: Requests to this endpoint return a list of transactions associated with the specified account. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the Optional Enhancement Query Parameter guide.
operationId: listTransactionsByAccountPerMember
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/userGuid'
- $ref: '#/components/parameters/accountGuid'
- $ref: '#/components/parameters/memberGuid'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/fromDateUnix'
- $ref: '#/components/parameters/toDateUnix'
- $ref: '#/components/parameters/fromCreatedAt_2'
- $ref: '#/components/parameters/toCreatedAt_2'
- $ref: '#/components/parameters/fromUpdatedAt_2'
- $ref: '#/components/parameters/toUpdatedAt_2'
- $ref: '#/components/parameters/includes'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsResponseBodyIncludes'
description: OK
summary: List transactions by account per member
tags:
- transactions
/users/{user_identifier}/members/{member_identifier}/extend_history:
post:
description: Some institutions allow developers to access an extended transaction history with up to 24 months of data associated with a particular member. The process for fetching and then reading this extended transaction history is much like standard aggregation, and it may trigger multi-factor authentication.
operationId: extendHistory
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/memberIdentifier'
- $ref: '#/components/parameters/userIdentifier'
responses:
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/MemberResponseBody'
description: Accepted
summary: Extend history
tags:
- transactions
/users/{user_identifier}/members/{member_identifier}/transactions:
get:
description: Requests to this endpoint return a list of transactions associated with the specified `member`, across all accounts associated with that `member`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the Optional Enhancement Query Parameter guide.
operationId: listTransactionsByMember
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/userIdentifier'
- $ref: '#/components/parameters/memberIdentifier'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/fromDateUnix'
- $ref: '#/components/parameters/toDateUnix'
- $ref: '#/components/parameters/fromCreatedAt_2'
- $ref: '#/components/parameters/toCreatedAt_2'
- $ref: '#/components/parameters/fromTimestamp'
- $ref: '#/components/parameters/toTimestamp'
- $ref: '#/components/parameters/fromUpdatedAt_2'
- $ref: '#/components/parameters/toUpdatedAt_2'
- $ref: '#/components/parameters/includes'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsResponseBodyIncludes'
description: OK
summary: List transactions by member
tags:
- transactions
/users/{user_identifier}/tags/{tag_guid}/transactions:
get:
description: Use this endpoint to get a list of all transactions associated with a particular tag according to the tag's unique GUID. This lists all transactions that have been assigned to a particular tag using the create tagging endpoint. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the Optional Enhancement Query Parameter guide.
operationId: listTransactionsByTag
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/userIdentifier'
- $ref: '#/components/parameters/tagGuid'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/fromDateUnix'
- $ref: '#/components/parameters/toDateUnix'
- $ref: '#/components/parameters/fromCreatedAt_2'
- $ref: '#/components/parameters/toCreatedAt_2'
- $ref: '#/components/parameters/fromUpdatedAt_2'
- $ref: '#/components/parameters/toUpdatedAt_2'
- $ref: '#/components/parameters/includes'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsResponseBodyIncludes'
description: OK
summary: List transactions by tag
tags:
- transactions
/users/{user_identifier}/transactions:
get:
description: Requests to this endpoint return a list of transactions associated with the specified `user`, across all members and accounts associated with that `user`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the Optional Enhancement Query Parameter guide.
operationId: listTransactions
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/userIdentifier'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/recordsPerPageMax1000'
- $ref: '#/components/parameters/fromDateUnix'
- $ref: '#/components/parameters/toDateUnix'
- $ref: '#/components/parameters/fromCreatedAt_2'
- $ref: '#/components/parameters/toCreatedAt_2'
- $ref: '#/components/parameters/fromUpdatedAt_2'
- $ref: '#/components/parameters/toUpdatedAt_2'
- $ref: '#/components/parameters/useCase_2'
- $ref: '#/components/parameters/includes'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsResponseBodyIncludes'
description: OK
summary: List transactions
tags:
- transactions
/users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}:
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/userIdentifier'
- $ref: '#/components/parameters/memberIdentifier'
- $ref: '#/components/parameters/accountIdentifier'
- $ref: '#/components/parameters/transactionIdentifier'
get:
description: Requests to this endpoint will return the attributes of the specified `transaction`. To read a manual transaction, use the manual transaction guid in the path as the `transactionGuid`. <br /><br />Enhanced transaction data may be requested using the `includes` parameter. To use this optional parameter, the value should include the optional metadata requested such as `repeating_transactions`, `merchants`, `classifications`, `geolocations`. For more information, see the Optional Enhancement Query Parameter guide.
operationId: readTransactionByAccount
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsResponseBodyIncludes'
description: OK
summary: Read transaction by account
tags:
- transactions
parameters:
- $ref: '#/components/parameters/acceptVersion'
- $ref: '#/components/parameters/includes'
put:
description: Use this endpoint to update the `description` of a specific transaction according to its unique GUID.
operationId: updateTransactionByAccount
parameters:
- $ref: '#/components/parameters/acceptVersion'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionUpdateRequestBody'
description: Transaction object to be updated with a new description
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionResponseBody'
description: OK
summary: Update transaction
tags:
- transactions
? /users/{user_identifier}/members/{member_identifier}/accounts/{account_identifier}/transactions/{transaction_identifier}/split
: parameters:
- $ref: '#/components/parameters/transactionIdentifier'
- $ref: '#/components/parameters/userIdentifier'
- $ref: '#/components/parameters/memberIdentifier'
- $ref: '#/components/parameters/accountIdentifier'
- $ref: '#/components/parameters/acceptVersion'
delete:
tags:
- transactions
operationId: deleteSplitTransactionByAccount
summary: Delete split transactions by account
description: This endpoint deletes all split transactions linked to a parent transaction, but it leaves the parent transaction active. This request will also update the parent transaction's has_been_split field to false. This endpoint accepts the optional MX-Skip-Webhook header.
responses:
'204':
description: No content
post:
tags:
- transactions
operationId: createSplitTransactionsByAccount
summary: Create split transactions by account
description: 'This endpoint creates two or more child transactions that are branched from a previous transaction. This endpoint allows you to link multiple categories, descriptions, and amounts to a parent transaction. When a split transaction is created, the parent transaction''s `has_been_split` field will automatically be updated to true and the child transactions'' `parent_guid` will have the transaction guid of the parent. The total amount of the child transactions must equal the amount of the parent transaction. Once a transaction has been split it can''t be split again. In order to re-split a transaction, it must first be un-split. This can be done by calling the Delete Split Transactions endpoint. Calling this endpoint will delete the existing child transactions and update the parent transaction''s `has_been_split` field to false. You can then re-split the parent transaction by calling Create Split Transaction again.
'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SplitTransactionRequestBody'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SplitTransactionsResponseBody'
description: OK
components:
parameters:
tagGuid:
description: The unique id for a `tag`.
example: TAG-aef36e72-6294-4c38-844d-e573e80aed52
in: path
name: tag_guid
required: true
schema:
type: string
fromDateUnix:
description: Filter transactions from this date. This only supports unix timestamp format. Defaults to 120 days ago if not provided.
example: '1666936800'
in: query
name: from_date
schema:
type: string
fromTimestamp:
name: from_timestamp
in: query
description: Filter transactions from the date the transaction was created. This only supports unix timestamp format.
example: '1666936800'
schema:
type: string
toDateUnix:
description: Filter transactions to this date (at midnight). This only supports unix timestamp format. Defaults to 5 days forward from the day the request is made to capture pending transactions.
example: '1698472800'
in: query
name: to_date
schema:
type: string
acceptVersion:
name: Accept-Version
in: header
required: true
schema:
type: string
default: v20250224
example: v20250224
description: MX Platform API version.
userGuid:
description: The unique identifier for a `user`, beginning with the prefix `USR-`.
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
in: path
name: user_guid
required: true
schema:
type: string
accountGuid:
description: The unique id for an `account`.
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
in: path
name: account_guid
required: true
schema:
type: string
toCreatedAt_2:
name: to_created_at
description: Filter transaction to the date in which the transaction was created. This only supports unix timestamp format.
example: '1698472800'
in: query
schema:
type: string
userIdentifier:
description: Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you).
in: path
required: true
name: user_identifier
schema:
type: string
fromUpdatedAt:
name: from_updated_at
description: Filter transactions from the date in which the transaction was updated. This only supports ISO 8601 format without timestamp (YYYY-MM-DD). Maximum date range limit is 6 months.
example: '2024-01-01'
in: query
schema:
type: string
topLevelCategoryGuid:
name: top_level_category_guid
description: 'Filter transactions belonging to specified `top_level_category_guid`. This must be top level category guid, use `category_guid` for subcateg
# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mx-technologies/refs/heads/main/openapi/mx-technologies-transactions-api-openapi.yml