Saltar para o conteúdo principal
GET
/
api
/
v1
/
external
/
payment-methods
/
config
GET https://app.fire.rest/api/v1/external/payment-methods/config
x-api-key: <sua_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": "Dinheiro",
              "description": null,
              "enabled": true
            },
            {
              "uuid": "7e2b-...-c8",
              "code": "CREDIT_CARD",
              "name": "Cartão de crédito",
              "description": "Visa, Mastercard",
              "enabled": true
            },
            {
              "uuid": "abcf-...-2d",
              "code": "PlaceToPay",
              "name": "PlaceToPay",
              "description": null,
              "enabled": false
            }
          ]
        }
      ]
    }
  ]
}
Retorna a configuração completa de métodos de pagamento para o vendor vinculado à sua API key, enriquecida com dados do catálogo global (uuid, name, description). O endpoint não aceita query params — accountId e vendorId são derivados da API key. Retorna todos os métodos (habilitados e desabilitados) para que o cliente decida o que mostrar. Métodos do JSONB sem match no catálogo são excluídos.

​
Autenticação

​
x-api-key
string
obrigatório
Sua API key do Fire com scope payment-methods:read. A key deve ser vendor-scoped (binding account + vendor) — keys sem vendorId são rejeitadas com 403.

​
Requisição

GET https://app.fire.rest/api/v1/external/payment-methods/config
x-api-key: <sua_api_key>

​
Resposta

​
accountId
string
UUID do account ao qual a API key pertence.
​
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": "Dinheiro",
              "description": null,
              "enabled": true
            },
            {
              "uuid": "7e2b-...-c8",
              "code": "CREDIT_CARD",
              "name": "Cartão de crédito",
              "description": "Visa, Mastercard",
              "enabled": true
            },
            {
              "uuid": "abcf-...-2d",
              "code": "PlaceToPay",
              "name": "PlaceToPay",
              "description": null,
              "enabled": false
            }
          ]
        }
      ]
    }
  ]
}

​
Notas

  • uuid vem do catálogo global de payment_methods, não do JSONB por account.
  • Métodos desabilitados são incluídos para que você possa renderizá-los com estado “indisponível” ou escondê-los — é sua decisão.
  • countries agrupa pelo código de país do JSONB.

​
Relacionados

Configuração de canais

Endpoint companion para ler os canais de venda configurados.

Autenticação

Como funcionam as API keys vendor-scoped e os scopes.