Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsList Payments
Search the full API reference Esc to close

List Payments

Payments · REST API reference

Get support
GET/v1/facilities/{facility_id}/payments

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request GET \
  --url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/payments' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Try a request

Staging · read-only

Explore your organization with a read-only request to staging.

Kept in this tab only. Sent directly to api.staging.facily.ai.

GET

Replace the {placeholders} in the path with your resource IDs.

Response
Your response will appear here.

Parameters

facility_idpath · string | stringrequired

Format: uuid

cursorquery · string | null
limitquery · integer

Default: 50 · Minimum: 1 · Maximum: 200

pagequery · integer | null

1-based page number, for a numbered pager. Mutually exclusive with `cursor`.

Minimum: 1

sortquery · string | null

Values: "paid_at", "created_at", "amount", "status"

orderquery · string

Default: "desc" · Values: "asc", "desc"

statusquery · string | null
method_typequery · string | null
sourcequery · string | null
tenant_idquery · string | null

Format: uuid

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": [
    {
      "amount": "<VALUE_MATCHING_PATTERN>",
      "created_at": "2026-10-29T12:00:00Z",
      "facility_id": "00000000-0000-4000-8000-000000000001",
      "id": "00000000-0000-4000-8000-000000000001",
      "method_type": "string",
      "payment_number": "string",
      "processed_externally": false,
      "refund_amount": "<VALUE_MATCHING_PATTERN>",
      "source": "string",
      "status": "string",
      "entry_mode": "string",
      "failed_at": "2026-10-29T12:00:00Z"
    }
  ],
  "meta": {
    "request_id": "string"
  },
  "pagination": {
    "has_more": false,
    "limit": 0,
    "cursor": "string",
    "total_count": 0
  },
  "metrics": {
    "cards": {},
    "computed_at": "2026-10-29T12:00:00Z",
    "is_stale": false,
    "scope": "facility"
  }
}

application/json

dataPaymentResponse[]required
Show data schema
amountstringrequired

Gross amount received.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

created_atstringrequired

When the payment record was created.

Format: date-time

entry_modestring | null

stored, keyed, terminal, or external. Null for cash, check and money order.

Show entry_mode schema
string | null

stored, keyed, terminal, or external. Null for cash, check and money order.

Variant 1: string
string
Variant 2: null
null
facility_idstringrequired

The facility the payment was taken at.

Format: uuid

failed_atstring | null

When the payment failed, if it did.

Format: date-time

Show failed_at schema
string | null

When the payment failed, if it did.

Variant 1: string
string
Variant 2: null
null
failure_reasonstring | null

Why the payment failed, in terms suitable for showing to staff.

Show failure_reason schema
string | null

Why the payment failed, in terms suitable for showing to staff.

Variant 1: string
string
Variant 2: null
null
idstringrequired

Unique identifier for this payment.

Format: uuid

ledger_kindstring | null

The kind of ledger the payment is booked to: lease, counter (a walk-in sale) or lead_deposit. Null when it is not known: a payment booked to no ledger that stated no split.

Values: "lease", "counter", "lead_deposit"

Show ledger_kind schema
string | null

The kind of ledger the payment is booked to: lease, counter (a walk-in sale) or lead_deposit. Null when it is not known: a payment booked to no ledger that stated no split.

Variant 1: string
string

Values: "lease", "counter", "lead_deposit"

Variant 2: null
null
method_typestringrequired

How the money arrived: cash, check, money_order, card or ach.

paid_atstring | null

When the payment succeeded. Null until it does.

Format: date-time

Show paid_at schema
string | null

When the payment succeeded. Null until it does.

Variant 1: string
string
Variant 2: null
null
payment_methodPaymentMethodCompactResponse | null

The stored payment instrument used, where the payment came from one.

Show payment_method schema
PaymentMethodCompactResponse | null

The stored payment instrument used, where the payment came from one.

Variant 1: PaymentMethodCompactResponse
card_brandstring | null
Show card_brand schema
string | null
Variant 1: string
Variant 2: null
idstringrequired

Format: uuid

last_fourstring | null
Show last_four schema
string | null
Variant 1: string
Variant 2: null
method_typestringrequired
Variant 2: null
null
payment_numberstringrequired

Operator-facing payment reference, unique within the facility.

processed_externallybooleanrequired

True when the money was captured outside Facily, on a terminal or gateway the platform does not control, and recorded here afterwards.

processor_account_idstring | null

The merchant account this payment was charged through. Null for cash, check, money order, and payments recorded from an external terminal.

Format: uuid

Show processor_account_id schema
string | null

The merchant account this payment was charged through. Null for cash, check, money order, and payments recorded from an external terminal.

Variant 1: string
string
Variant 2: null
null
reference_numberstring | null

The check number or the money-order serial, without a leading '#'. Null for cash, card and ACH, and for a check recorded before Facily kept the number. Never a processor id.

Show reference_number schema
string | null

The check number or the money-order serial, without a leading '#'. Null for cash, card and ACH, and for a check recorded before Facily kept the number. Never a processor id.

Variant 1: string
string
Variant 2: null
null
refund_amountstringrequired

Total refunded against this payment so far. Equal to amount when fully refunded.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

settled_atstring | null

When the processor confirmed funds. Null until settlement, and for cash, check and money order.

Format: date-time

Show settled_at schema
string | null

When the processor confirmed funds. Null until settlement, and for cash, check and money order.

Variant 1: string
string
Variant 2: null
null
sourcestringrequired

What initiated the payment, for example autopay, the tenant portal, or a staff member.

statusstringrequired

Current state, for example succeeded, pending, failed, refunded, or voided.

surcharge_amountstring

Processor card surcharge charged on top of amount; never part of the ledger.

Default: "0.00" · Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

tenantTenantCompactResponse | null

The tenant the payment was received from. Null for a payment with no tenant: a walk-in sale or a lead's reservation deposit.

Show tenant schema
TenantCompactResponse | null

The tenant the payment was received from. Null for a payment with no tenant: a walk-in sale or a lead's reservation deposit.

Variant 1: TenantCompactResponse
emailstring | null

Primary email address.

Show email schema
string | null

Primary email address.

Variant 1: string
Variant 2: null
first_namestringrequired

Given name.

idstringrequired

Unique identifier for the tenant.

Format: uuid

last_namestringrequired

Family name.

phonestring | null

Primary telephone number.

Show phone schema
string | null

Primary telephone number.

Variant 1: string
Variant 2: null
tenant_numberstringrequired

Operator-facing tenant reference, unique within the facility.

Variant 2: null
null
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
metricsEmbeddedMetrics | null
Show metrics schema
EmbeddedMetrics | null
Variant 1: EmbeddedMetrics
cardsobjectrequired
computed_atstring | nullrequired

Format: date-time

Show computed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
is_stalebooleanrequired
scopestringrequired

Values: "facility", "portfolio"

Variant 2: null
null
paginationPaginationBlockrequired

Pagination metadata for list responses.

Show pagination schema
cursorstring | null
Show cursor schema
string | null
Variant 1: string
string
Variant 2: null
null
has_morebooleanrequired
limitintegerrequired
total_countinteger | null
Show total_count schema
integer | null
Variant 1: integer
integer
Variant 2: null
null
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll payments operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

List Payments | Facily Developers