Listar Provedores

Recupere a lista de provedores disponíveis para associar ao lojista. Use o id retornado aqui como providerId ao criar uma credencial.

Endpoint

GET/v1/providers

Não requer parâmetros adicionais. A resposta inclui todos os provedores disponíveis na plataforma.

Response

[
  {
    "id": "d1niaaopa579sdaa4tug",
    "type": "payment_processor",
    "context": "card_present",
    "name": "PagSeguro",
    "enabled": true,
    "createdAt": "2026-01-10T12:00:00Z",
    "updatedAt": "2026-01-10T12:00:00Z"
  },
  {
    "id": "d1nic8kpa579sdaa4tuj",
    "type": "payment_processor",
    "context": "card_present",
    "name": "BTG",
    "enabled": true,
    "createdAt": "2026-09-27T12:00:00Z",
    "updatedAt": "2026-09-27T12:00:00Z"
  },
  {
    "id": "d1nid0kpa579sdaa4tuk",
    "type": "banking_entities",
    "context": "unknown",
    "name": "BTG",
    "enabled": true,
    "createdAt": "2026-01-10T12:00:00Z",
    "updatedAt": "2026-01-10T12:00:00Z"
  }
]

Campos da Resposta

Array de provedores. Cada item:

Campo	Tipo	Descrição
id	string	Identificador (XID) do provedor. É este valor que vai no campo providerId de POST /v1/credentials.
type	string	Tipo do provedor: payment_processor (adquirente) ou banking_entities (banco)
context	string	Canal atendido: card_present, card_not_present ou unknown
name	string	Nome do provedor
enabled	boolean	Se o provedor está habilitado
createdAt	string	Timestamp de criação (ISO 8601)
updatedAt	string	Timestamp da última atualização (ISO 8601)

dica

Um mesmo name pode aparecer mais de uma vez com type/context diferentes (ex.: BTG). Escolha o provedor pelo par type/context, não apenas pelo nome.

Provedores Suportados

Provedor (name)	type	context	Descrição
PagSeguro	payment_processor	card_present	PagSeguro — adquirente de cartão presente (POS)
Adiq	payment_processor	card_present	Adiq — adquirente de cartão presente (POS)
BTG	payment_processor	card_present	BTG — adquirente de cartão presente (POS), com roteamento
Cielo	payment_processor	card_not_present	Cielo — adquirente de e-commerce
Rede	payment_processor	card_not_present	Rede — adquirente de e-commerce
Adyen	payment_processor	card_not_present	Adyen — adquirente de e-commerce
Pagar.me	payment_processor	card_not_present	Pagar.me — adquirente de e-commerce
BTG	banking_entities	unknown	BTG — banco, usado nas credenciais PIX

Provedores agrupados por canal

GET/v1/providers/grouped

Retorna somente os provedores habilitados, agrupados por canal (context). É a forma mais simples de encontrar o provedor certo para cada tipo de credencial.

Response

{
  "channels": [
    {
      "name": "card_present",
      "providers": [
        { "id": "d1niaaopa579sdaa4tug", "name": "PagSeguro" },
        { "id": "d1nic8kpa579sdaa4tuj", "name": "BTG" }
      ]
    },
    {
      "name": "card_not_present",
      "providers": [
        { "id": "d1nib3kpa579sdaa4tuh", "name": "Cielo" }
      ]
    },
    {
      "name": "unknown",
      "providers": [
        { "id": "d1nid0kpa579sdaa4tuk", "name": "BTG" }
      ]
    }
  ]
}

Campo	Tipo	Descrição
channels	array	Lista de canais
channels[].name	string	Canal (context): card_present, card_not_present ou unknown
channels[].providers	array	Provedores habilitados no canal
channels[].providers[].id	string	Identificador (XID) do provedor — usar como providerId
channels[].providers[].name	string	Nome do provedor

BTG de cartão

Para criar a credencial de cartão do BTG com roteamento, use o id do BTG no canal card_present. O BTG do canal unknown é o banco, usado nas credenciais PIX.

Provedores de PIX/banco (ex.: BTG, type = banking_entities), usados nas credenciais PIX de Criar Credencial, aparecem nesta mesma lista quando habilitados para a sua conta. O BTG também aparece como adquirente de cartão (type = payment_processor, context = card_present) — são dois provedores distintos, cada um com seu id.