Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsGet Payment Processor
Search the full API reference Esc to close

Get Payment Processor

Payments · REST API reference

Get support
GET/v1/facilities/{facility_id}/payment-processor
The merchant account serving this facility, if any (spec 5.4, 15).

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>/payment-processor' \
  --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 · stringrequired

Format: uuid

Responses

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

200Successful Response
JSON · generated example
{
  "data": {
    "linked": false,
    "account_id": "00000000-0000-4000-8000-000000000001",
    "capabilities": {},
    "frozen": false,
    "linked_at": "2026-10-29T12:00:00Z",
    "merchant_display_name": "string",
    "provider": "string",
    "sandbox": false,
    "status": "string",
    "surcharge_enabled": false,
    "web_payments_token": "string"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataPaymentProcessorResponserequired

What payment processor, if any, serves a facility (spec 5.4, 15).

Show data schema
account_idstring | null

Facily's identifier for the merchant registration. Stored on every payment it processes.

Format: uuid

Show account_id schema
string | null

Facily's identifier for the merchant registration. Stored on every payment it processes.

Variant 1: string
string
Variant 2: null
null
capabilitiesobject

What this merchant account may do, for example allow_ach or is_surcharge_enabled.

frozenboolean

True when Facily has frozen this merchant: no new charges, tokenization sessions or autopay until it is unfrozen; money already in flight still settles, refunds and reconciles.

Default: false

linkedbooleanrequired

True when a merchant account is registered for this facility. Linked is not the same as usable -- check status.

linked_atstring | null

When this merchant account was first linked to the facility. Null when no merchant is linked.

Format: date-time

Show linked_at schema
string | null

When this merchant account was first linked to the facility. Null when no merchant is linked.

Variant 1: string
string
Variant 2: null
null
merchant_display_namestring | null

The merchant's business name as the processor holds it, for confirming the right account is linked.

Show merchant_display_name schema
string | null

The merchant's business name as the processor holds it, for confirming the right account is linked.

Variant 1: string
string
Variant 2: null
null
providerstring | null

The processor behind the merchant account, for example stax.

Show provider schema
string | null

The processor behind the merchant account, for example stax.

Variant 1: string
string
Variant 2: null
null
sandboxboolean

True when the linked merchant is a processor sandbox account: test cards only, no real money.

Default: false

statusstring | null

The merchant's state at the processor. Only an active merchant can be charged; anything else means underwriting or a hold.

Show status schema
string | null

The merchant's state at the processor. Only an active merchant can be charged; anything else means underwriting or a hold.

Variant 1: string
string
Variant 2: null
null
surcharge_enabledboolean

True when card surcharging is live for this facility: the merchant is enabled for it AND the facility's own setting is on. Both are required, and this is the resolved answer -- do not re-derive it from capabilities. It reflects those two switches only: a merchant that is pending, inactive or frozen still reports true if both hold, because this answers whether the program is on and not whether a charge would succeed right now -- status and frozen answer that. False when nothing is linked.

Default: false

web_payments_tokenstring | null

Public, browser-safe key for the processor's tokenization JS. Returned only while status is active, so a card form is never mounted against a merchant that would refuse the charge.

Show web_payments_token schema
string | null

Public, browser-safe key for the processor's tokenization JS. Returned only while status is active, so a card form is never mounted against a merchant that would refuse the charge.

Variant 1: string
string
Variant 2: null
null
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
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

Get Payment Processor | Facily Developers