Saltar al contenido principal
GET
/
api
/
v1
/
external
/
payment-methods
/
config
GET https://app.fire.rest/api/v1/external/payment-methods/config
x-api-key: <tu_api_key>

{
  "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
            }
          ]
        }
      ]
    }
  ]
}
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.

​
Autenticación

​
x-api-key
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://app.fire.rest/api/v1/external/payment-methods/config
x-api-key: <tu_api_key>

​
Respuesta

​
accountId
string
UUID del account al que pertenece la API key.
​
countries
object[]
{
  "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
            }
          ]
        }
      ]
    }
  ]
}

​
Notas

  • uuid viene del catálogo global de payment_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.
  • countries agrupa 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.