A transaction represents any instance in which money moves into or out of an account. This could be a purchase at a business, a payroll deposit, a transfer from one account to another, an ATM withdrawal, etc. Each transaction belongs to only one account.


Read Transaction

Endpoint: GET /users/:user_guid/transactions/:transaction_guid

This endpoint will return the attributes of the specified transaction.

Parameters

For the Request

Example Request

curl -X GET /users/:user_guid/transactions/:transaction_guid \\
  -H 'Content-Type: application/json' \\
	-H "Authorization: Bearer {access_token}" \\

Response

{
  "transaction": {
    "account_guid": "ACT-09c0ee66-51a8-4edf-b977-99534a471134",
    "account_id": "account-1040434698",
    "amount": 7.94,
    "category": "Paycheck",
    "check_number_string": null,
    "created_at": "2020-03-02T19:11:11Z",
    "currency_code": "USD",
    "date": "2020-03-02",
    "description": "Paycheck",
    "guid": "TRN-181ce5d9-d33e-45b9-a9cd-8f8ef9d82d5d",
    "id": "transaction-1040434568",
    "is_bill_pay": false,
    "is_direct_deposit": false,
    "is_expense": false,
    "is_fee": false,
    "is_income": true,
    "is_international": null,
    "is_overdraft_fee": false,
    "is_payroll_advance": false,
    "is_recurring": false,
    "is_subscription": false,
    "latitude": null,
    "localized_description": null,
    "localized_memo": null,
    "longitude": null,
    "member_guid": "MBR-3eb08fde-01d5-454c-ae6a-95606ccd1225",
    "member_is_managed_by_user": true,
    "memo": null,
    "merchant_category_code": null,
    "merchant_guid": null,
    "merchant_location_guid": null,
    "original_description": "Payroll",
    "posted_at": "2020-03-03T12:00:00Z",
    "status": "POSTED",
    "top_level_category": "Income",
    "transacted_at": "2020-03-02T12:00:00Z",
    "type": "CREDIT",
    "updated_at": "2020-03-02T19:11:14Z",
    "user_guid": "USR-a2e65785-975d-dcbd-fd22-7bbba2581fb0",
    "user_id": "user-1040435626"
  }
}

Update Transaction

Endpoint: PUT /users/:user_guid/transactions/:transaction_guid

Use this endpoint to update the description of a specific transaction according to its unique GUID.

Parameters

For the Request

Example Request

curl -X PUT /users/:user_guid/transactions/:transaction_guid \\
  -H 'Accept: application/vnd.mx.api.v1+json' \\
	-H 'Content-Type: application/json' \\
	-H "Authorization: Bearer {access_token}" \\
	-d '{
	      "transaction": {
	        "description": "new description"
	      }
	    }'