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

List Tenant Payment Methods

Tenants · REST API reference

Get support
GET/v1/tenants/{tenant_id}/payment-methods

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/tenants/<TENANT_ID>/payment-methods' \
  --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

tenant_idpath · stringrequired

Format: uuid

cursorquery · string | null
limitquery · integer

Default: 50 · Minimum: 1 · Maximum: 200

sortquery · string | null

Values: "created_at", "is_default"

orderquery · string

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

Responses

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

200Successful Response
JSON · generated example
{
  "data": [
    {
      "added_via": "string",
      "created_at": "2026-10-29T12:00:00Z",
      "id": "00000000-0000-4000-8000-000000000001",
      "is_active": false,
      "is_chargeable": false,
      "is_default": false,
      "method_type": "string",
      "provider": "string",
      "updated_at": "2026-10-29T12:00:00Z",
      "ach_account_type": "string",
      "ach_bank_name": "string",
      "bank_holder_type": "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

dataPaymentMethodResponse[]required
Show data schema
ach_account_typestring | null

Whether the ACH account is checking or savings.

Show ach_account_type schema
string | null

Whether the ACH account is checking or savings.

Variant 1: string
string
Variant 2: null
null
ach_bank_namestring | null

Name of the bank holding the account, for an ACH method.

Show ach_bank_name schema
string | null

Name of the bank holding the account, for an ACH method.

Variant 1: string
string
Variant 2: null
null
added_viastringrequired

How the method was stored, for example by the tenant in the portal or by staff.

bank_holder_typestring | null

Whether the bank account belongs to a person or a business, as the processor classifies it. Null for a card, and for a bank account stored before Facily recorded it.

Show bank_holder_type schema
string | null

Whether the bank account belongs to a person or a business, as the processor classifies it. Null for a card, and for a bank account stored before Facily recorded it.

Variant 1: string
string
Variant 2: null
null
bin_typestring | null

CREDIT, DEBIT, or PREPAID as the processor reports it. Drives surcharging.

Show bin_type schema
string | null

CREDIT, DEBIT, or PREPAID as the processor reports it. Drives surcharging.

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

Card network, for example Visa or Mastercard.

Show card_brand schema
string | null

Card network, for example Visa or Mastercard.

Variant 1: string
string
Variant 2: null
null
card_exp_monthinteger | null

Card expiry month, 1 to 12.

Show card_exp_month schema
integer | null

Card expiry month, 1 to 12.

Variant 1: integer
integer
Variant 2: null
null
card_exp_yearinteger | null

Card expiry year, four digits.

Show card_exp_year schema
integer | null

Card expiry year, four digits.

Variant 1: integer
integer
Variant 2: null
null
created_atstringrequired

When the method was stored.

Format: date-time

idstringrequired

Unique identifier for this stored payment method.

Format: uuid

is_activebooleanrequired

Whether the method may currently be charged.

is_chargeablebooleanrequired

True when this method can actually be charged: a live, non-deleted token at the current processor. A migrated legacy row is false.

is_defaultbooleanrequired

True for the method charged when no other is specified.

last_fourstring | null

Last four digits of the card or bank account, for identifying it to the tenant. No other digits are ever stored or returned.

Show last_four schema
string | null

Last four digits of the card or bank account, for identifying it to the tenant. No other digits are ever stored or returned.

Variant 1: string
string
Variant 2: null
null
method_typestringrequired

The instrument type, for example card or ACH.

nicknamestring | null

Staff-set label, for telling two cards on file apart.

Show nickname schema
string | null

Staff-set label, for telling two cards on file apart.

Variant 1: string
string
Variant 2: null
null
providerstringrequired

Who holds the token: stax for a chargeable method, legacy for a method migrated from the previous system whose token has not yet been imported.

updated_atstringrequired

When the method was last modified.

Format: date-time

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 tenants operations
Build something that works beautifully.

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

List Tenant Payment Methods | Facily Developers