/v1/facilities/{facility_id}/payment-processorAuthentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest 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 --request GET \
--url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/payment-processor' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
facility_idpath · stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"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
dataPaymentProcessorResponserequiredWhat payment processor, if any, serves a facility (spec 5.4, 15).
Show data schema
account_idstring | nullFacily's identifier for the merchant registration. Stored on every payment it processes.
Format: uuid
Show account_id schema
string | nullFacily's identifier for the merchant registration. Stored on every payment it processes.
Variant 1: string
stringVariant 2: null
nullcapabilitiesobjectWhat this merchant account may do, for example allow_ach or is_surcharge_enabled.
frozenbooleanTrue 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
linkedbooleanrequiredTrue when a merchant account is registered for this facility. Linked is not the same as usable -- check status.
linked_atstring | nullWhen this merchant account was first linked to the facility. Null when no merchant is linked.
Format: date-time
Show linked_at schema
string | nullWhen this merchant account was first linked to the facility. Null when no merchant is linked.
Variant 1: string
stringVariant 2: null
nullmerchant_display_namestring | nullThe merchant's business name as the processor holds it, for confirming the right account is linked.
Show merchant_display_name schema
string | nullThe merchant's business name as the processor holds it, for confirming the right account is linked.
Variant 1: string
stringVariant 2: null
nullproviderstring | nullThe processor behind the merchant account, for example stax.
Show provider schema
string | nullThe processor behind the merchant account, for example stax.
Variant 1: string
stringVariant 2: null
nullsandboxbooleanTrue when the linked merchant is a processor sandbox account: test cards only, no real money.
Default: false
statusstring | nullThe merchant's state at the processor. Only an active merchant can be charged; anything else means underwriting or a hold.
Show status schema
string | nullThe merchant's state at the processor. Only an active merchant can be charged; anything else means underwriting or a hold.
Variant 1: string
stringVariant 2: null
nullsurcharge_enabledbooleanTrue 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 | nullPublic, 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 | nullPublic, 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
stringVariant 2: null
nullmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired