Skip to content
Vespy API

List payments

GET
/api/payments
curl --request GET \
  --url 'https://api.getvespy.com/api/payments?status=received&sortBy=receivedAt&sortDirection=asc&page=1&pageSize=20' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
search
string
>= 1 characters <= 100 characters
tenantId
string format: uuid
leaseId
string format: uuid
propertyId
string format: uuid
unitId
string format: uuid
status
string
Allowed values: received pending failed reversed
receivedAfter
string format: date
receivedBefore
string format: date
createdAfter
string format: date
createdBefore
string format: date
sortBy
string
Allowed values: receivedAt tenantName propertyName amountCents paymentMethod allocatedCents unallocatedCents status createdAt
sortDirection
string
Allowed values: asc desc
page
integer
default: 1 >= 1
pageSize
integer
default: 20 >= 1 <= 100

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
page
required
integer
>= 1
pageSize
required
integer
>= 1 <= 100
payments
required
Array<object>
object
allocations
required
Array<object>
object
amountCents
required
integer
>= 1
charge
required
object
amountCents
required
integer
>= 1
balanceCents
required
integer
chargeType
required
string
Allowed values: rent fee deposit adjustment other
dueDate
required
string format: date
id
required
string format: uuid
name
required
string
nullable <= 160 characters
status
required
string
Allowed values: pending posted paid void
chargeId
required
string format: uuid
id
required
string format: uuid
paymentId
required
string format: uuid
paymentReceivedAt
required
string format: date-time
amountCents
required
integer
>= 1
checkNumber
required
string
nullable >= 1 characters <= 64 characters
createdAt
required
string format: date-time
id
required
string format: uuid
idempotencyKey
required
string
nullable
lease
required
object
endDate
required
string format: date
nullable
id
required
string format: uuid
startDate
required
string format: date
status
required
string
Allowed values: draft active ended terminated
leaseId
required
string format: uuid
nullable
organizationId
required
string format: uuid
paymentMethod
required
string
Allowed values: ach card cash check other
property
required
object
city
required
string
>= 1 characters <= 120 characters
id
required
string format: uuid
name
required
string
>= 1 characters <= 160 characters
state
required
string
>= 2 characters <= 2 characters
receivedAt
required
string format: date-time
status
required
string
Allowed values: received pending failed reversed
tenant
required
object
fullName
required
string
>= 1 characters <= 160 characters
id
required
string format: uuid
tenantId
required
string format: uuid
nullable
unallocatedCents
required
integer
unit
required
object
id
required
string format: uuid
unitNumber
required
string
nullable >= 1 characters <= 32 characters
total
required
integer
totalPages
required
integer
>= 1
Example
{
  "payments": [
    {
      "allocations": [
        {
          "charge": {
            "chargeType": "rent",
            "status": "pending"
          }
        }
      ],
      "lease": {
        "status": "draft"
      },
      "paymentMethod": "ach",
      "status": "received"
    }
  ]
}

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"
}