Jornadas de Credenciamento — Visão Geral
1. O que é o Credenciamento?
O credenciamento é o processo pelo qual um estabelecimento comercial (merchant) passa a fazer parte da rede Getnet, habilitando-se a aceitar pagamentos com cartão e outros meios eletrônicos. Durante esse processo são coletados dados cadastrais, realizada análise de risco e compliance (qualificação), definidas as ofertas comerciais contratadas e criado o pedido formal que consolida tudo isso.
2. Tipos de Jornada
| Característica | Credenciamento Autônomo | Credenciamento Assistido |
|---|---|---|
| Quem preenche os dados | O próprio merchant, em canal digital self-service | Um agente / consultor da Getnet |
| Interação humana | Mínima — fluxo guiado pela aplicação | Alta — agente guia o merchant |
| Ponto de entrada | Canal digital aberto (mar aberto) | Canal interno / back-office |
| Momento da vitrine de ofertas | Antes da criação do merchant | Após a criação do merchant |
| Filtros do GET /offerings | country + channel (opcionalmente monthly_card_income + merchant_category_code + fiscal_type se o canal já dispuser dessas informações antes de exibir as ofertas) | country + channel + monthly_card_income + merchant_category_code + fiscal_type |
monthly_card_income no POST /merchants | Não obrigatório na criação | Enviado já na criação |
MCC (merchant_category_code) | Não utilizado como filtro obrigatório | Retornado no POST /merchants e usado no GET /offerings |
fiscal_type | Opcional — usado se disponível antes do cadastro | Utilizado como filtro no GET /offerings |
3. Autenticação — Pré-requisito de Ambas as Jornadas
📄 Detalhes completos em POST /token
4. Jornada 1 — Credenciamento Autônomo (Mar Aberto)
4.1 Visão macro do fluxo
4.2 Detalhamento das etapas
🔐 Autenticação
access_token conforme descrito na seção 3 e inclua-o em todas as chamadas seguintes.🛍️ Vitrine de Ofertas
Antes de iniciar o cadastro, consulte as ofertas disponíveis para o canal e país. Isso permite que o merchant escolha um plano antes de se cadastrar.
Etapa 0 — Verificação prévia (opcional, mas recomendada)
Etapa 1 — Criação do merchant (dados mínimos)
merchant_id, que será usado em todas as chamadas seguintes.⚠️ Guarde omerchant_idretornado — ele é obrigatório em todas as próximas chamadas.
Etapa 1.5 — Consulta de CEP e opções de entrega (quando necessário)
Valide o CEP informado pelo merchant e consulte as opções de entrega disponíveis para aquele endereço.
Etapa 2 — Complemento de dados (quando necessário)
⚠️ Nunca envie payload parcial. OPUTsubstitui todos os dados do merchant. Sempre busque o objeto completo comGETantes de modificá-lo.
Etapa 3 — Qualificação (análise de risco e compliance)
GET para obtê-lo.Etapa 4 — Resultado da qualificação
report.recommended.status retornado pelo POST /merchants/{merchant_id}/qualification para decidir como prosseguir:Etapas 5 e 6 — Montagem dos itens do pedido
Para cada oferta selecionada pelo merchant, mapeie cada item da oferta para um item do pedido:
Etapa 6.5 — Montagem do endereço de entrega (delivery_info)
GET /offerings/delivery-data, monte o objeto delivery_info que será enviado no POST /orders.Etapa 7 — Dados bancários (domicílio bancário)
Para cada bandeira contratada, informe os dados da conta bancária onde o merchant receberá os valores.
📄 Banks
Etapa 8 — Criação do pedido
Com todos os dados coletados, crie o pedido formal de credenciamento.
total_price dos itens onde product.product_type = "terminal", agrupados pelo product.pricing_model.pricing_type:Itens comproduct_typediferente determinal(ex.:composite,service) não entram neste cálculo. Campos sem terminais correspondentes devem ser enviados com valor0.
⚠️ Guarde oorder_idretornado — ele é obrigatório em todas as próximas chamadas (PUT /orders/{order_id},POST /orders/{order_id}/validation,PUT /orders/{order_id}/submit).
Etapa 8.5 — Atualização do pedido (quando necessário)
PUT /orders/{order_id}.⚠️ Nunca envie payload parcial. OPUTsubstitui todos os dados do pedido. Sempre envie o objeto completo.
PUT /merchants/{merchant_id}:| Comportamento | Merchant | Order |
|---|---|---|
| Enriquecimento | ✅ Sim — a plataforma adiciona informações ao objeto após a criação | ❌ Não — os dados do pedido são exatamente os que o canal enviou no POST /orders |
| GET antes do PUT | Obrigatório — para obter os dados enriquecidos e não sobrescrevê-los acidentalmente | Opcional — se o canal armazena o pedido localmente, os dados são idênticos aos da plataforma |
- Se o canal armazena o pedido em seu domínio: basta modificar ou incrementar os campos na estrutura local e enviar o
PUTcom o objeto completo — não é necessário chamarGET /orders/{order_id}antes. - Se o canal não armazena o pedido: chamar
GET /orders/{order_id}(usando oorder_idretornado noPOST /orders), aplicar as alterações e enviar oPUT.
Após qualquer alteração nos itens, recalcule os campos de totalização conforme a Etapa 8.
Etapa 9 — Validação do pedido (recomendada)
Antes de submeter, valide o pedido para identificar e corrigir eventuais problemas.
⚠️ Após a submissão (Etapa 10) o pedido não pode mais ser corrigido. Use esta etapa como salvaguarda.
Etapa 10 — Submissão do pedido
Submeta o pedido após confirmação do merchant. Esta é a etapa final.
5. Jornada 2 — Credenciamento Assistido
merchant_category_code (MCC) retornado, a vitrine de ofertas é consultada de forma personalizada para aquele perfil de negócio.5.1 Visão macro do fluxo
5.2 Detalhamento das etapas
🔐 Autenticação
access_token conforme descrito na seção 3.Etapa 0 — Verificação prévia (opcional, mas recomendada)
Idêntica à jornada autônoma.
Etapa 1 — Criação do merchant (dados mínimos)
monthly_card_income (faturamento mensal no cartão) é enviado já na criação. O retorno inclui o merchant_category_code (MCC), que deve ser guardado para filtrar as ofertas adequadas ao perfil do negócio.⚠️ Guarde tanto omerchant_idquanto omerchant_category_code— ambos são usados nas chamadas seguintes.
🛍️ Vitrine de Ofertas (após criação do merchant)
Etapas 1.5 a 10 — Complemento, Qualificação, Pedido e Submissão
| Etapa | Descrição | Link |
|---|---|---|
| 1.5 | Consulta de CEP e opções de entrega | → Etapa 1.5 |
| 2 | Complemento de dados via PUT /merchants | → Etapa 2 |
| 3 | Disparar qualificação | → Etapa 3 |
| 4 | Verificar resultado da qualificação | → Etapa 4 |
| 5-6 | Montagem dos itens do pedido | → Etapas 5 e 6 |
| 7 | Informar dados bancários | → Etapa 7 |
| 8 | Criar pedido | → Etapa 8 |
| 8.5 | Atualizar pedido (quando necessário) | → Etapa 8.5 |
| 9 | Validar pedido | → Etapa 9 |
| 10 | Submeter pedido | → Etapa 10 |
5.3 Diferenças em relação ao Credenciamento Autônomo
| Aspecto | Autônomo | Assistido |
|---|---|---|
| Quem opera | O próprio merchant | Agente / consultor |
| Momento da vitrine de ofertas | Antes da criação do merchant | Após a criação do merchant |
| Filtros da vitrine | country + channel (opcionalmente monthly_card_income + merchant_category_code + fiscal_type se disponíveis) | country + channel + monthly_card_income + merchant_category_code + fiscal_type |
monthly_card_income no POST /merchants | Não obrigatório na criação | Enviado já na criação |
MCC (merchant_category_code) | Não utilizado como filtro obrigatório | Retornado no POST /merchants e usado no GET /offerings |
fiscal_type | Opcional — usado se disponível | Utilizado como filtro no GET /offerings |
6. Referência Rápida de Endpoints por Etapa
Credenciamento Autônomo
| Etapa | Método | Endpoint | Documentação |
|---|---|---|---|
| Autenticação | POST | /token | POST /token |
| Vitrine de ofertas | GET | /offerings | GET /offerings |
| 0 — Verificação prévia | GET | /establishment-contracts-basic/legal-document-number/{doc}/ec-accredited | GET /establishment-contracts-basic/legal-document-number/{doc}/ec-accredited |
| 1 — Criação do merchant | POST | /merchants | POST /merchants |
| 1.5 — Consulta de CEP | GET | /domains/zipcode/{postal_code} | GET /domains/zipcode/{postal_code} |
| 1.5 — Opções de entrega | GET | /offerings/delivery-data | GET /offerings/delivery-data |
| 2 — Obter merchant atual | GET | /merchants/{merchant_id} | GET /merchants/{merchant_id} |
| 2 — Complementar dados | PUT | /merchants/{merchant_id} | PUT /merchants/{merchant_id} |
| 3 — Disparar qualificação | POST | /merchants/{merchant_id}/qualification | POST /merchants/{merchant_id}/qualification |
| 4 — Consultar qualificação | GET | /merchants/{merchant_id}/qualification | GET /merchants/{merchant_id}/qualification |
| 6.5 — Montar delivery_info | — | (montagem local com dados de GET /offerings/delivery-data + CEP) | → Etapa 6.5 |
| 8 — Criar pedido | POST | /orders | POST /orders |
| 8.5 — Atualizar pedido | PUT | /orders/{order_id} | PUT /orders/{order_id} |
| 9 — Validar pedido | POST | /orders/{order_id}/validation | POST /orders/{order_id}/validation |
| 10 — Submeter pedido | PUT | /orders/{order_id}/submit | PUT /orders/{order_id}/submit |
Credenciamento Assistido
| Etapa | Método | Endpoint | Documentação |
|---|---|---|---|
| Autenticação | POST | /token | POST /token |
| 0 — Verificação prévia | GET | /establishment-contracts-basic/legal-document-number/{doc}/ec-accredited | GET /establishment-contracts-basic/legal-document-number/{doc}/ec-accredited |
| 1 — Criação do merchant | POST | /merchants | POST /merchants |
| Vitrine de ofertas | GET | /offerings?monthly_card_income={val}&merchant_category_code={mcc}&fiscal_type={fiscal_type} | GET /offerings |
| 1.5 — Consulta de CEP | GET | /domains/zipcode/{postal_code} | GET /domains/zipcode/{postal_code} |
| 1.5 — Opções de entrega | GET | /offerings/delivery-data | GET /offerings/delivery-data |
| 2 — Obter merchant atual | GET | /merchants/{merchant_id} | GET /merchants/{merchant_id} |
| 2 — Complementar dados | PUT | /merchants/{merchant_id} | PUT /merchants/{merchant_id} |
| 3 — Disparar qualificação | POST | /merchants/{merchant_id}/qualification | POST /merchants/{merchant_id}/qualification |
| 3 — Disparar qualificação | POST | /merchants/{merchant_id}/qualification | POST /merchants/{merchant_id}/qualification |
| 4 — Consultar qualificação | GET | /merchants/{merchant_id}/qualification | GET /merchants/{merchant_id}/qualification |
| 6.5 — Montar delivery_info | — | (montagem local com dados de GET /offerings/delivery-data + CEP) | → Etapa 6.5 |
| 8 — Criar pedido | POST | /orders | POST /orders |
| 8.5 — Atualizar pedido | PUT | /orders/{order_id} | PUT /orders/{order_id} |
| 9 — Validar pedido | POST | /orders/{order_id}/validation | POST /orders/{order_id}/validation |
| 10 — Submeter pedido | PUT | /orders/{order_id}/submit | PUT /orders/{order_id}/submit |
7. Conceitos Transversais
merchant_id
POST /merchants. Deve ser persistido e utilizado em todas as chamadas subsequentes do ciclo de credenciamento.priced_offering_id
Identificador de uma oferta com preços detalhados por bandeira. Obtido na Offerings API e utilizado na montagem dos itens do pedido.
order_id e order_number
order_id: identificador interno gerado noPOST /orders. Usado para validação e submissão.order_number: gerado após a submissão bem-sucedida. Usado pelo merchant para acompanhar o status logístico do pedido.
Qualificação
GET).Domicílio bancário
Conta(s) bancária(s) onde o merchant receberá os repasses das transações. Deve ser informado por bandeira contratada.
📄 Banks · Centralizers
Nesta página