Configuração de métodos de pagamento

GET https://api.fire.rest/api/v1/external/payment-methods/config
x-api-key: <sua_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": "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
              }
            ]
          }
        ]
      }
    ]
  }
}

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

GET

api

external

payment-methods

config

GET https://api.fire.rest/api/v1/external/payment-methods/config
x-api-key: <sua_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": "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
              }
            ]
          }
        ]
      }
    ]
  }
}

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

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.

Já existe uma v2 deste endpoint que resolve a configuração por loja, com níveis de canal, fulfillment e terminal, e devolve os valores de configuração. Esta v1 continua disponível e não tem data de desativação — migre quando fizer sentido para você.

Autenticação

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

Resposta

boolean

Sempre true em um 200.

object

Mostrar data

string

UUID do account ao qual a API key pertence.

object[]

Mostrar country

string

ISO 3166-1 alpha-2 (ex. BR, EC, CO).

object[]

Mostrar vendor

string

Identificador do vendor.

string

Nome legível do vendor.

object[]

Mostrar paymentMethod

string

UUID do catálogo global de payment_methods.

string

Código do método (ex. CASH, CREDIT_CARD).

string

Nome de exibição.

string | null

Descrição opcional.

boolean

Se o método está ativo para este 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": "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
              }
            ]
          }
        ]
      }
    ]
  }
}

{
  "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

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.

API

APIs de parceiro

Configuração de métodos de pagamento

Autenticação

Requisição

Resposta

Notas

Relacionados

Configuração de canais

Autenticação

​Autenticação

​Requisição

​Resposta

​Notas

​Relacionados

Configuração de canais

Autenticação

Autenticação

Requisição

Resposta

Notas

Relacionados