Payment methods config

GET https://api.fire.rest/api/v1/external/payment-methods/config
x-api-key: <your_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": "Cash",
                "description": null,
                "enabled": true
              },
              {
                "uuid": "7e2b-...-c8",
                "code": "CREDIT_CARD",
                "name": "Credit card",
                "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: <your_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": "Cash",
                "description": null,
                "enabled": true
              },
              {
                "uuid": "7e2b-...-c8",
                "code": "CREDIT_CARD",
                "name": "Credit card",
                "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"
}

Returns the full payment-methods configuration for the vendor bound to your API key, enriched with global catalog data (uuid, name, description). The endpoint takes no query parameters — accountId and vendorId are derived from the API key. All methods are returned (enabled and disabled) so the client can decide what to show. Methods in the account JSONB without a catalog match are excluded.

There is now a v2 of this endpoint that resolves the configuration per store, with channel, fulfillment and terminal levels, and returns the configuration values. This v1 stays available and has no sunset date — migrate when it suits you.

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.

Request

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

Response

boolean

Always true on a 200.

object

Show data

string

UUID of the account the API key belongs to.

object[]

Show country

string

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

object[]

Show vendor

string

Vendor identifier.

string

Human-readable vendor name.

object[]

Show paymentMethod

string

UUID from the global payment_methods catalog.

string

Payment method code (e.g. CASH, CREDIT_CARD).

string

Display name.

string | null

Optional description.

boolean

Whether the method is active for this 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": "Cash",
                "description": null,
                "enabled": true
              },
              {
                "uuid": "7e2b-...-c8",
                "code": "CREDIT_CARD",
                "name": "Credit card",
                "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"
}

Notes

uuid comes from the global payment_methods catalog, not from the per-account JSONB.
Disabled methods are included so you can render them with an “unavailable” state or hide them — it is your decision.
countries groups by country code from the JSONB.

Channels config

Companion endpoint to read configured sales channels.

Authentication

How vendor-scoped API keys and scopes work.

​Authentication

​Request

​Response

​Notes

​Related

Channels config

Authentication

Authentication

Request

Response

Notes

Related