Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsQuote Surcharge
Search the full API reference Esc to close

Quote Surcharge

Payments · REST API reference

Get support
POST/v1/facilities/{facility_id}/payments/surcharge-quote
What the processor will add to this card charge, before it is made (spec 12).

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 POST \
  --url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/payments/surcharge-quote' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 0,
  "payment_method_id": "00000000-0000-4000-8000-000000000001"
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

facility_idpath · stringrequired

Format: uuid

Request body

application/json · Required

amountnumber | stringrequired

The BASE amount to be charged, before any surcharge. The surcharge is added on top of it.

Pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$)

Show amount schema
number | string

The BASE amount to be charged, before any surcharge. The surcharge is added on top of it.

Variant 1: number
number
Variant 2: string
string
payment_method_idstringrequired

The vaulted instrument that would be charged. Must belong to a tenant at this facility, or be a one-time card of this facility -- a method at another facility in the same org is not quoted, and answers surchargeable: false.

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>",
    "surcharge_amount": "<VALUE_MATCHING_PATTERN>",
    "surchargeable": false,
    "total_charged": "<VALUE_MATCHING_PATTERN>",
    "bin_type": "string",
    "rate": "<VALUE_MATCHING_PATTERN>"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataSurchargeQuoteResponserequired

The processor's answer, shaped for a confirm step.

Show data schema
amountstringrequired

The base amount the quote was taken for, echoed back.

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

bin_typestring | null

How the processor classifies the card: CREDIT, DEBIT or PREPAID. Null when not quoted.

Show bin_type schema
string | null

How the processor classifies the card: CREDIT, DEBIT or PREPAID. Null when not quoted.

Variant 1: string
string
Variant 2: null
null
ratestring | null

The surcharge rate as a percent, for example 3.0 for 3%. Null when not quoted.

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

Show rate schema
string | null

The surcharge rate as a percent, for example 3.0 for 3%. Null when not quoted.

Variant 1: string
string
Variant 2: null
null
surcharge_amountstringrequired

What the cardholder pays on top of the amount. 0.00 when no surcharge applies. Never part of the ledger.

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

surchargeablebooleanrequired

True when a surcharge applies to this card at this amount. False is a normal answer.

total_chargedstringrequired

What the cardholder's statement will show: amount plus surcharge. Equal to amount when none applies.

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

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

Quote Surcharge | Facily Developers