Transaction API

[amirrustam]

Data Model

• id | string
• uuid | string
• source | BankAccount
• amount | number
• description | string
• privacy_level | enumerated string: "public" | "private" | "contacts" (default User.default_privacy_level)
• receiver_id | User
• sender_id | User
• balance_at_completion | number
• status | enumrated string: "pending" | "incomplete" | "complete"
• request (object)
  • status | enumrated string: "pending" | "accepted" | "rejected"
  • resolved_at | timestamp (ISO 8601)
• created_at | timestamp (ISO 8601)
• modified_at | timestamp (ISO 8601)

HTTP API

• GET /transactions - scoped user, auth-required

  • Validate params
  • Tested
  • Query Params:
    • status (default: "complete")
    • request_status (default: none)
    • receiver_id
    • sender_id
  • TODO: Complex logic outside of vanilla lowdb, Created Evaluate/Implement expanded query params for /transactions  #18
  • range_start_ts
  • range_end_ts
  • amount_max
  • amount_min

• GET /transactions/contacts - scoped user, auth-required

  • Validate params
  • Tested
  • Query Params:
    • status (default: "complete")
    • request_status (default: none)
    • receiver_id
    • sender_id
  • TODO: Complex logic outside of vanilla lowdb, Created Evaluate/Implement expanded query params for /transactions  #18
  • range_start_ts
  • range_end_ts
  • amount_max
  • amount_min

• GET /transactions/public - auth-required

  • Validate params
  • Tested
  • Sorted
  • Query Params:
    • order
      • default: public transactions of contacts first ordered by most recent, then all other transactions ordered by most recent

• POST /transactions - scoped-user

  • Validate params
  • Tested
  • Body Parameters:
    • type: "payment" | "request"
    • source: bank_account_id
    • amount
    • description
    • privacy_level: "public" | "private" | "contacts"
    • receiver_id
    • sender_id

• PATCH /transactions/:transaction_id - scoped-user

  • Validate params
  • Tested
  • Body Parameters:
    • request_status: "accepted" | "rejected"