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

List Autopay Attempts

Payments · REST API reference

Get support
GET/v1/facilities/{facility_id}/autopay-attempts
The failed-payment queue for one facility (spec 10.6), or for every facility under `all`, newest attempt first.

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>/autopay-attempts' \
  --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

statequery · string

Default: "failed" · Values: "failed", "suspended", "scheduled"

limitquery · integer

Default: 100 · Minimum: 1 · Maximum: 200

Responses

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

200Successful Response
JSON · generated example
{
  "data": [
    {
      "consecutive_failures": 0,
      "enrollment_id": "00000000-0000-4000-8000-000000000001",
      "facility_id": "00000000-0000-4000-8000-000000000001",
      "lease_id": "00000000-0000-4000-8000-000000000001",
      "method_type": "string",
      "payment_method_id": "00000000-0000-4000-8000-000000000001",
      "state": "failed",
      "tenant_id": "00000000-0000-4000-8000-000000000001",
      "tenant_name": "string",
      "amount": "<VALUE_MATCHING_PATTERN>",
      "attempt_kind": "string",
      "card_brand": "string"
    }
  ],
  "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

dataAutopayAttemptResponse[]required
Show data schema
amountstring | null

Amount of the most recent attempt. Null when none has been made.

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

Show amount schema
string | null

Amount of the most recent attempt. Null when none has been made.

Variant 1: string
string
Variant 2: null
null
attempt_kindstring | null

scheduled, retry, or manual, for the most recent attempt.

Show attempt_kind schema
string | null

scheduled, retry, or manual, for the most recent attempt.

Variant 1: string
string
Variant 2: null
null
card_brandstring | null

Card brand, for a card.

Show card_brand schema
string | null

Card brand, for a card.

Variant 1: string
string
Variant 2: null
null
consecutive_failuresintegerrequired

Declines in a row since the last success or cured balance.

enrollment_idstringrequired

The autopay enrollment this row is about.

Format: uuid

facility_idstringrequired

The facility of the lease, so a row read under `all` says whose it is.

Format: uuid

failure_reasonstring | null

Why the most recent attempt failed, in terms suitable for showing to staff.

Show failure_reason schema
string | null

Why the most recent attempt failed, in terms suitable for showing to staff.

Variant 1: string
string
Variant 2: null
null
last_attempted_atstring | null

When the most recent attempt was made.

Format: date-time

Show last_attempted_at schema
string | null

When the most recent attempt was made.

Variant 1: string
string
Variant 2: null
null
last_fourstring | null

Last four digits of the stored instrument.

Show last_four schema
string | null

Last four digits of the stored instrument.

Variant 1: string
string
Variant 2: null
null
last_payment_idstring | null

The most recent attempt's payment record.

Format: uuid

Show last_payment_id schema
string | null

The most recent attempt's payment record.

Variant 1: string
string
Variant 2: null
null
lease_idstringrequired

The lease the enrollment charges.

Format: uuid

method_typestringrequired

How the money would arrive: card or ach.

next_attempt_onstring | null

When autopay will try again. Null when no retry is scheduled.

Format: date

Show next_attempt_on schema
string | null

When autopay will try again. Null when no retry is scheduled.

Variant 1: string
string
Variant 2: null
null
payment_method_idstringrequired

The stored instrument autopay charges.

Format: uuid

statestringrequired

Which queue this row was listed under.

Values: "failed", "suspended", "scheduled"

suspended_atstring | null

When autopay stopped attempting. Null while the enrollment is live.

Format: date-time

Show suspended_at schema
string | null

When autopay stopped attempting. Null while the enrollment is live.

Variant 1: string
string
Variant 2: null
null
suspension_reasonstring | null

Why it stopped: consecutive_failures, method_removed, staff, or cancelled.

Show suspension_reason schema
string | null

Why it stopped: consecutive_failures, method_removed, staff, or cancelled.

Variant 1: string
string
Variant 2: null
null
tenant_idstringrequired

The tenant who gave the mandate.

Format: uuid

tenant_namestringrequired

The tenant's display name, for the queue row.

unit_numberstring | null

The unit on the lease, where one is assigned.

Show unit_number schema
string | null

The unit on the lease, where one is assigned.

Variant 1: string
string
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 Autopay Attempts | Facily Developers