Skip to content
Vespy API

Record security deposit

POST
/api/trust/deposits
curl --request POST \
  --url https://api.getvespy.com/api/trust/deposits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "amountCents": 1, "bankAccountId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "leaseId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "receivedAt": "2026-04-15T12:00:00Z", "status": "held", "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
amountCents
required
integer
>= 1
bankAccountId
string format: uuid
leaseId
string format: uuid
receivedAt
string format: date-time
status
string
Allowed values: held partially_returned returned forfeited
tenantId
string format: uuid

Responses

Section titled “Responses”

201

Section titled “201”

Default Response

Media typeapplication/json
object
securityDeposit
required
object
amountCents
required
integer
>= 1
bankAccountId
required
string format: uuid
nullable
createdAt
required
string format: date-time
id
required
string format: uuid
isOverdue
required
boolean
leaseId
required
string format: uuid
nullable
organizationId
required
string format: uuid
propertyState
required
string
nullable
receivedAt
required
string format: date-time
returnDeadline
required
string format: date-time
nullable
returnDeadlineDays
required
integer
nullable
returnedAt
required
string format: date-time
nullable
status
required
string
Allowed values: held partially_returned returned forfeited
tenantId
required
string format: uuid
nullable
updatedAt
required
string format: date-time
Example
{
  "securityDeposit": {
    "status": "held"
  }
}

400

Section titled “400”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

404

Section titled “404”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

409

Section titled “409”

Default Response

Media typeapplication/json
object
code
string
errors
Array<object>
object
code
required
string
message
required
string
path
required
string
message
required
string
Examplegenerated
{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}