GET https://api.fire.rest/api/v2/external/payment-methods/config
x-api-key: <your_api_key>
GET https://api.fire.rest/api/v2/external/payment-methods/config?storeCode=K008
x-api-key: <your_api_key>
{
"success": true,
"data": {
"accountId": "550e8400-e29b-41d4-a716-446655440000",
"vendorId": "100.1.10",
"generatedAt": "2026-09-04T13:00:00.000Z",
"stores": [
{
"storeId": "aa11bb22-0000-4000-8000-000000000002",
"storeCode": "K008",
"storeNumber": 812,
"name": "Quicentro",
"countryCode": "EC",
"active": "ACTIVE",
"status": "PUBLISHED",
"methods": [
{
"methodId": "9f3a1c2e-0000-4000-8000-000000000001",
"code": "datafast",
"name": "Datafast",
"description": null,
"logoUrl": "https://cdn.fire.rest/logos/datafast.webp",
"cardBrands": ["visa", "mastercard"],
"active": true,
"position": 0,
"configFields": [
{
"key": "merchant_id",
"label": "Merchant ID",
"required": true,
"scopeLevel": "account",
"secret": false,
"helpText": null
},
{
"key": "terminal_key",
"label": "Terminal key",
"required": true,
"scopeLevel": "store",
"secret": true,
"helpText": null
},
{
"key": "terminal_ip",
"label": "Card reader IP",
"required": false,
"scopeLevel": "device",
"secret": false,
"helpText": null
}
],
"charging": true,
"availability": [
{"channelCode": "KIOSK", "fulfillmentCode": "DINE_IN", "enabled": true},
{"channelCode": "KIOSK", "fulfillmentCode": "TAKEAWAY", "enabled": false}
],
"config": {"merchant_id": "M-000123", "terminal_key": "sk_live_..."},
"missingRequiredKeys": [],
"devices": [
{
"deviceType": "KIOSK",
"deviceId": "cc33dd44-0000-4000-8000-000000000003",
"charging": false,
"availability": [
{"channelCode": "KIOSK", "fulfillmentCode": "DINE_IN", "enabled": false},
{"channelCode": "KIOSK", "fulfillmentCode": "TAKEAWAY", "enabled": false}
],
"config": {"terminal_ip": "10.20.0.9"}
}
]
}
]
}
],
"warnings": [],
"total": 1,
"page": 1,
"size": 20,
"totalPages": 1
}
}
{
"success": false,
"error": "VALIDATION_ERROR",
"message": "Datos de entrada inválidos",
"details": [
{
"code": "custom",
"path": ["storeCode"],
"message": "Use either storeId or storeCode, not both"
}
]
}
{
"success": false,
"error": "UNAUTHORIZED",
"message": "API key required. Use x-api-key: pk_live_... header"
}
{
"success": false,
"error": "FORBIDDEN",
"message": "API key does not have required scope: payment-methods:read. Available: store:read"
}
{
"success": false,
"error": "FORBIDDEN",
"message": "API key must be vendor-scoped (account + vendor binding) to access this endpoint"
}
{
"success": false,
"error": "NOT_FOUND",
"message": "Store not found"
}
API
Payment method configuration (v2)
Read the payment method configuration for the vendor bound to your API key, resolved per store: which methods exist, where each one charges, and with which values.
GET
/
api
/
v2
/
external
/
payment-methods
/
config
GET https://api.fire.rest/api/v2/external/payment-methods/config
x-api-key: <your_api_key>
GET https://api.fire.rest/api/v2/external/payment-methods/config?storeCode=K008
x-api-key: <your_api_key>
{
"success": true,
"data": {
"accountId": "550e8400-e29b-41d4-a716-446655440000",
"vendorId": "100.1.10",
"generatedAt": "2026-09-04T13:00:00.000Z",
"stores": [
{
"storeId": "aa11bb22-0000-4000-8000-000000000002",
"storeCode": "K008",
"storeNumber": 812,
"name": "Quicentro",
"countryCode": "EC",
"active": "ACTIVE",
"status": "PUBLISHED",
"methods": [
{
"methodId": "9f3a1c2e-0000-4000-8000-000000000001",
"code": "datafast",
"name": "Datafast",
"description": null,
"logoUrl": "https://cdn.fire.rest/logos/datafast.webp",
"cardBrands": ["visa", "mastercard"],
"active": true,
"position": 0,
"configFields": [
{
"key": "merchant_id",
"label": "Merchant ID",
"required": true,
"scopeLevel": "account",
"secret": false,
"helpText": null
},
{
"key": "terminal_key",
"label": "Terminal key",
"required": true,
"scopeLevel": "store",
"secret": true,
"helpText": null
},
{
"key": "terminal_ip",
"label": "Card reader IP",
"required": false,
"scopeLevel": "device",
"secret": false,
"helpText": null
}
],
"charging": true,
"availability": [
{"channelCode": "KIOSK", "fulfillmentCode": "DINE_IN", "enabled": true},
{"channelCode": "KIOSK", "fulfillmentCode": "TAKEAWAY", "enabled": false}
],
"config": {"merchant_id": "M-000123", "terminal_key": "sk_live_..."},
"missingRequiredKeys": [],
"devices": [
{
"deviceType": "KIOSK",
"deviceId": "cc33dd44-0000-4000-8000-000000000003",
"charging": false,
"availability": [
{"channelCode": "KIOSK", "fulfillmentCode": "DINE_IN", "enabled": false},
{"channelCode": "KIOSK", "fulfillmentCode": "TAKEAWAY", "enabled": false}
],
"config": {"terminal_ip": "10.20.0.9"}
}
]
}
]
}
],
"warnings": [],
"total": 1,
"page": 1,
"size": 20,
"totalPages": 1
}
}
{
"success": false,
"error": "VALIDATION_ERROR",
"message": "Datos de entrada inválidos",
"details": [
{
"code": "custom",
"path": ["storeCode"],
"message": "Use either storeId or storeCode, not both"
}
]
}
{
"success": false,
"error": "UNAUTHORIZED",
"message": "API key required. Use x-api-key: pk_live_... header"
}
{
"success": false,
"error": "FORBIDDEN",
"message": "API key does not have required scope: payment-methods:read. Available: store:read"
}
{
"success": false,
"error": "FORBIDDEN",
"message": "API key must be vendor-scoped (account + vendor binding) to access this endpoint"
}
{
"success": false,
"error": "NOT_FOUND",
"message": "Store not found"
}
Returns the payment configuration Fire holds for the vendor bound to your API key, resolved store
by store: which methods each one offers, where each of them charges, and with which values. Every
entry is self-contained — there is no catalog to join against.
With no filter it returns every store of the vendor, paginated. With
storeId or storeCode, a
single one.
The response includes configuration values, including the ones flagged as secret (merchant
keys, card-reader credentials). Treat this response as sensitive material: do not log it, do not
cache it in a browser, and do not forward it to third parties.
This is v2. v1 returns country → vendor → methods
with an
enabled flag and stays available, with no sunset date. v2 changes where the data
comes from and adds the store, channel, fulfillment and terminal levels.Authentication
string
required
Your Fire API key with the
payment-methods:read scope. The key must be vendor-scoped
(account + vendor binding) — keys without a vendorId are rejected with 403. Account and
vendor are resolved from the key; they are not accepted as query params.Parameters
string
The store’s UUID in Fire. Mutually exclusive with
storeCode: sending both returns 400.string
The store’s external code (
EXTERNAL CODE in the backoffice). This is the identifier you most
likely already hold in your own store master. It is unambiguous because the API key pins the
vendor.string
Narrows
availability to one channel (for example KIOSK). Compared uppercased. Stores left
with no combination for that channel still appear, with no methods.integer
default:"1"
Page of
stores.integer
default:"20"
Stores per page. Maximum
100.Request
GET https://api.fire.rest/api/v2/external/payment-methods/config
x-api-key: <your_api_key>
GET https://api.fire.rest/api/v2/external/payment-methods/config?storeCode=K008
x-api-key: <your_api_key>
Response
boolean
Always
true on a 200.object
Show data
Show data
string
UUID of the API key’s account.
string
The API key’s vendor.
string
ISO 8601 timestamp of the resolution.
object[]
Show store
Show store
string
The store’s UUID.
string | null
External code.
integer
The store’s number in Fire.
string | null
Store name.
string | null
null when the store has no country set; it then appears in warnings and methods comes back empty.string
ACTIVE, INACTIVE or SUSPENDED.string
DRAFT, PUBLISHED, PARTIALLY_PUBLISHED or ARCHIVED.object[]
Show storeMethod
Show storeMethod
string
The method’s UUID. This is the identifier, and the only stable one.
string
Code, for convenience. Unique only within a country, so use
methodId to identify a method.string
Display name.
string | null
Optional description.
string | null
Logo URL.
string[]
Accepted brands. Empty = not a card method.
boolean
Whether the method is active on the account. When
false it charges in no store.integer
Suggested order.
object[]
The fields the method declares. What the values in
config mean.boolean
Derived: the method is active and charges in at least one combination. With
?channel=, scoped to that channel.object[]
object
Effective store-level values: the account’s, with the store’s on top. Only
account and store fields.string[]
Mandatory account or store fields left empty. If this is not empty, the store is not ready to charge with that method.
object[]
Terminals with their own configuration or stance. Empty is the normal case.
Show device
Show device
string
KIOSK or POS.string
The terminal’s identifier in Fire.
boolean
Whether that unit charges, already resolved against its store.
object[]
Same as the store’s, with the terminal’s own stance applied on top.
object
Only the values set on that terminal, without merging the store’s again: that is how you tell an exception from inheritance.
object[]
What came back incomplete without failing the request. Today only
STORE_COUNTRY_MISSING:
the store has no country set, so its catalog could not be resolved.integer
Stores of the vendor matching the filter.
integer
Page returned.
integer
Page size.
integer
Total pages.
{
"success": true,
"data": {
"accountId": "550e8400-e29b-41d4-a716-446655440000",
"vendorId": "100.1.10",
"generatedAt": "2026-09-04T13:00:00.000Z",
"stores": [
{
"storeId": "aa11bb22-0000-4000-8000-000000000002",
"storeCode": "K008",
"storeNumber": 812,
"name": "Quicentro",
"countryCode": "EC",
"active": "ACTIVE",
"status": "PUBLISHED",
"methods": [
{
"methodId": "9f3a1c2e-0000-4000-8000-000000000001",
"code": "datafast",
"name": "Datafast",
"description": null,
"logoUrl": "https://cdn.fire.rest/logos/datafast.webp",
"cardBrands": ["visa", "mastercard"],
"active": true,
"position": 0,
"configFields": [
{
"key": "merchant_id",
"label": "Merchant ID",
"required": true,
"scopeLevel": "account",
"secret": false,
"helpText": null
},
{
"key": "terminal_key",
"label": "Terminal key",
"required": true,
"scopeLevel": "store",
"secret": true,
"helpText": null
},
{
"key": "terminal_ip",
"label": "Card reader IP",
"required": false,
"scopeLevel": "device",
"secret": false,
"helpText": null
}
],
"charging": true,
"availability": [
{"channelCode": "KIOSK", "fulfillmentCode": "DINE_IN", "enabled": true},
{"channelCode": "KIOSK", "fulfillmentCode": "TAKEAWAY", "enabled": false}
],
"config": {"merchant_id": "M-000123", "terminal_key": "sk_live_..."},
"missingRequiredKeys": [],
"devices": [
{
"deviceType": "KIOSK",
"deviceId": "cc33dd44-0000-4000-8000-000000000003",
"charging": false,
"availability": [
{"channelCode": "KIOSK", "fulfillmentCode": "DINE_IN", "enabled": false},
{"channelCode": "KIOSK", "fulfillmentCode": "TAKEAWAY", "enabled": false}
],
"config": {"terminal_ip": "10.20.0.9"}
}
]
}
]
}
],
"warnings": [],
"total": 1,
"page": 1,
"size": 20,
"totalPages": 1
}
}
{
"success": false,
"error": "VALIDATION_ERROR",
"message": "Datos de entrada inválidos",
"details": [
{
"code": "custom",
"path": ["storeCode"],
"message": "Use either storeId or storeCode, not both"
}
]
}
{
"success": false,
"error": "UNAUTHORIZED",
"message": "API key required. Use x-api-key: pk_live_... header"
}
{
"success": false,
"error": "FORBIDDEN",
"message": "API key does not have required scope: payment-methods:read. Available: store:read"
}
{
"success": false,
"error": "FORBIDDEN",
"message": "API key must be vendor-scoped (account + vendor binding) to access this endpoint"
}
{
"success": false,
"error": "NOT_FOUND",
"message": "Store not found"
}
How to read the response
To decide whether to show a method in a store, look atcharging. It is true when the
method is active on the account and charges in at least one combination of that store.
To know in which channel and fulfillment it charges, look at availability. An entry with
enabled: false means “configured here, but switched off right now” — the provider is down, say.
That is different from not appearing at all: what does not appear is not offered in that store.
Collapsing the two costs you later: drop the paused entries and, the day the method is resumed,
your side reads it as a combination nobody ever set up and reconfigures what was already there.
Before attempting a charge, look at missingRequiredKeys. If it carries anything, mandatory
data is missing and the charge will fail on the provider’s side.
devices is almost always empty. It shows up when one terminal has an exception — a kiosk’s
card reader broke and only that unit was switched off, leaving the rest of the store charging. If
your integration does not distinguish terminals you can ignore it: the store level is the right
answer for a sales channel.
Notes
- Identify methods by
methodId, never bycode. A code is unique only within a country, and a vendor with stores in two countries can define the same code twice, with different ids. fulfillmentCodeis returned exactly as stored, without normalizing against the global catalog.- Methods with
active: falseare returned anyway, so you can render them as “unavailable” or hide them — your call. - Asking for a store that does not belong to your key’s vendor returns
404, not403.
Related
Payment method configuration (v1)
The previous version, without store levels. Still available.
Channels configuration
Which channels and fulfillments your vendor has enabled.