GET https://api.fire.rest/api/v1/external/payment-methods/config
x-api-key: <tu_api_key>
{
"success": true,
"data": {
"accountId": "550e8400-e29b-41d4-a716-446655440000",
"countries": [
{
"countryCode": "EC",
"vendors": [
{
"vendorId": "100.1.10",
"vendorName": "Sandbox Ecuador",
"paymentMethods": [
{
"uuid": "9f3a-...-e1",
"code": "CASH",
"name": "Efectivo",
"description": null,
"enabled": true
},
{
"uuid": "7e2b-...-c8",
"code": "CREDIT_CARD",
"name": "Tarjeta de crédito",
"description": "Visa, Mastercard",
"enabled": true
},
{
"uuid": "abcf-...-2d",
"code": "PlaceToPay",
"name": "PlaceToPay",
"description": null,
"enabled": false
}
]
}
]
}
]
}
}
{
"success": false,
"error": "UNAUTHORIZED",
"message": "API key required. Use x-api-key: pk_live_... header"
}
{
"success": false,
"error": "FORBIDDEN",
"message": "API key must be vendor-scoped (account + vendor binding) to access this endpoint"
}
API
Configuración de métodos de pago
Lee los métodos de pago configurados (habilitados y deshabilitados) para el vendor asociado a tu API key. Úsalo para saber qué métodos de pago puede ofrecer tu integración.
GET
/
api
/
v1
/
external
/
payment-methods
/
config
GET https://api.fire.rest/api/v1/external/payment-methods/config
x-api-key: <tu_api_key>
{
"success": true,
"data": {
"accountId": "550e8400-e29b-41d4-a716-446655440000",
"countries": [
{
"countryCode": "EC",
"vendors": [
{
"vendorId": "100.1.10",
"vendorName": "Sandbox Ecuador",
"paymentMethods": [
{
"uuid": "9f3a-...-e1",
"code": "CASH",
"name": "Efectivo",
"description": null,
"enabled": true
},
{
"uuid": "7e2b-...-c8",
"code": "CREDIT_CARD",
"name": "Tarjeta de crédito",
"description": "Visa, Mastercard",
"enabled": true
},
{
"uuid": "abcf-...-2d",
"code": "PlaceToPay",
"name": "PlaceToPay",
"description": null,
"enabled": false
}
]
}
]
}
]
}
}
{
"success": false,
"error": "UNAUTHORIZED",
"message": "API key required. Use x-api-key: pk_live_... header"
}
{
"success": false,
"error": "FORBIDDEN",
"message": "API key must be vendor-scoped (account + vendor binding) to access this endpoint"
}
Devuelve la configuración completa de métodos de pago para el vendor asociado a tu API key, enriquecida con datos del catálogo global (
uuid, name, description).
El endpoint no acepta query params — accountId y vendorId se derivan de la API key. Devuelve todos los métodos (habilitados y deshabilitados) para que el cliente decida qué mostrar. Los métodos del JSONB sin match en el catálogo se excluyen.
Ya existe una v2 de este endpoint que resuelve la
configuración por tienda, con niveles de canal, fulfillment y terminal, y devuelve los
valores de configuración. Esta v1 sigue disponible y no tiene fecha de baja — migrá cuando
te sirva.
Autenticación
string
requerido
Tu API key de Fire con scope
payment-methods:read. La key debe ser vendor-scoped (binding account + vendor) — las keys sin vendorId se rechazan con 403.Petición
GET https://api.fire.rest/api/v1/external/payment-methods/config
x-api-key: <tu_api_key>
Respuesta
boolean
Siempre
true en un 200.object
Mostrar data
Mostrar data
string
UUID del account al que pertenece la API key.
object[]
Mostrar country
Mostrar country
string
ISO 3166-1 alpha-2 (ej.
BR, EC, CO).object[]
Mostrar vendor
Mostrar vendor
string
Identificador del vendor.
string
Nombre legible del vendor.
{
"success": true,
"data": {
"accountId": "550e8400-e29b-41d4-a716-446655440000",
"countries": [
{
"countryCode": "EC",
"vendors": [
{
"vendorId": "100.1.10",
"vendorName": "Sandbox Ecuador",
"paymentMethods": [
{
"uuid": "9f3a-...-e1",
"code": "CASH",
"name": "Efectivo",
"description": null,
"enabled": true
},
{
"uuid": "7e2b-...-c8",
"code": "CREDIT_CARD",
"name": "Tarjeta de crédito",
"description": "Visa, Mastercard",
"enabled": true
},
{
"uuid": "abcf-...-2d",
"code": "PlaceToPay",
"name": "PlaceToPay",
"description": null,
"enabled": false
}
]
}
]
}
]
}
}
{
"success": false,
"error": "UNAUTHORIZED",
"message": "API key required. Use x-api-key: pk_live_... header"
}
{
"success": false,
"error": "FORBIDDEN",
"message": "API key must be vendor-scoped (account + vendor binding) to access this endpoint"
}
Notas
uuidviene del catálogo global depayment_methods, no del JSONB por account.- Los métodos deshabilitados se incluyen para que puedas renderizarlos con estado “no disponible” o esconderlos — es tu decisión.
countriesagrupa por código de país del JSONB.
Relacionado
Configuración de canales
Endpoint companion para leer los canales de venta configurados.
Autenticación
Cómo funcionan las API keys vendor-scoped y los scopes.