DocumentaçãoReferência da API

Introdução

O processo de autocredenciamento visa trazer fluidez e agilidade ao processo de liberação por meio de um fluxo 100% on-line para viabilizar rapidamente a autorização de sua operação. Para o autocredenciamento em canais abertos ao público, é necessário enviar documentação e, principalmente, biometria facial pelo aplicativo Getnet Brasil.

Por meio deste guia, exploraremos cada uma das etapas, fornecendo detalhes dessa jornada, a fim de trazer clareza e garantir que, ao final da leitura, você esteja pronto para se qualificar.

Como é o processo?

Podemos definir que esse processo ocorre em 3 etapas principais:

  • Mostra de ofertas;
  • Registro de estabelecimento;
  • Pedido.

Enquanto você lê, exploraremos cada uma das etapas, bem como as regras de negócios, as operações REST e como concluí-las. O objetivo é que, ao final da leitura, você esteja pronto para comprar produtos e serviços.

As etapas

Nesta seção, exploraremos as etapas em detalhes, mostrando o que é necessário para atingir o objetivo em cada uma delas de forma funcional e técnica.

O diagrama abaixo ilustra o fluxo de autoacreditação, abrangendo as etapas que serão detalhadas abaixo:

Para consumir operações REST, é necessário realizar o fluxo de autenticação disponível neste link de documentação . O access_token gerado deve ser passado como um parâmetro chamado “Autorização” no cabeçalho da chamada.

Etapa 1: Mostra de ofertas

O Offers Showcase tem como objetivo permitir que os clientes descubram quais produtos e serviços estão disponíveis para compra. Há uma variedade de produtos e serviços que vão desde soluções digitais e financeiras até as famosas máquinas de cartão.

Quando analisamos o tópico de soluções digitais e financeiras, existem mecanismos que podem promover ainda mais a saúde financeira, como a antecipação de recebíveis ou facilitadores para sua operação, como o link de pagamento.

Para saber mais sobre as ofertas disponíveis, temos uma operação REST no serviço Ofertas que traz todos os produtos e serviços que podem ser adquiridos:

OBTENHA https://{getnet-api-base}/v1/offerings

Parâmetros importantes (queryParams):

  • país - Esse é o canal de origem e, a partir daí, ele retorna as ofertas associadas ao canal;
  • canal - Por meio dessas informações, você poderá ver ofertas exclusivas para o país informado;
  • tipo_fiscal - Indica se é uma pessoa física ou jurídica.

A documentação técnica do serviço está disponível no Página de listagem e obtenção de ofertas .

Depois de selecionar uma das ofertas listadas na vitrine, ela deve ser precificada, ou seja, os preços e tarifas dos produtos e serviços da Getnet devem ser consultados nos sistemas internos para gerar os preços de acordo com o tipo de produto.

Os preços devem ser feitos por meio do serviço de Ofertas:

OBTENHA https://{getnet-api-base}/v1/offerings/{offering_id}/pricing

Parâmetros importantes (caminho):

  • id_da_oferta - identificador da oferta a ser precificada.

A documentação técnica do serviço está disponível no Página de preços .

Depois que o preço da oferta for definido, ela deverá ser disponibilizada para inclusão no pedido. Para fazer isso, todas as informações atualizadas sobre a oferta devem ser recuperadas, e isso deve ser feito por meio do serviço Ofertas:

OBTENHA https://{getnet-api-base}/v1/offerings? priced_offering_id= {offering_id}

Parâmetros importantes (queryParam):

  • id_da_oferta - identificador da oferta.

A documentação técnica do serviço está disponível no Ofertas - Página de listagem e obtenção .

Etapa 2: Registro do estabelecimento

Para consolidar as ofertas e até mesmo ver sua viabilidade, precisamos saber mais sobre você e o estabelecimento, pois por meio dessas informações poderemos avaliar produtos e serviços mais personalizados, além de realizar alguns fluxos internos de validação.

O registro do estabelecimento é dividido em duas formas:

Simplificado — Na versão simplificada, será necessário realizar 3 etapas via APIs:

  • Pré-cadastro — Aqui você insere algumas informações básicas, como tipo de pessoa (física ou jurídica), número do documento e país para iniciar o processo de cadastro;
  • A atualização — Nesta fase, a etapa de “pré-cadastro” retorna alguns campos relevantes para a operação e algumas informações adicionais que devem ser usadas para atualizar seu cadastro completamente:
    • Pessoa jurídica: além dos dados gerais da empresa, outros grupos de dados também são necessários, como: endereço comercial, atividade econômica, contato, parceiros, representante legal, horário de funcionamento, etc. ;
    • Individual: além dos dados pessoais, outros grupos de dados também são necessários, como: endereço residencial e comercial, atividade econômica, horário de funcionamento etc.
  • Qualificação — Nesta etapa final, avaliaremos todos os dados enviados para garantir que estejam em conformidade e, também, uma avaliação completa do seu cadastro será realizada para possibilitar a contratação de produtos e serviços;

Completo - Nesse aspecto, o fluxo ocorrerá em duas etapas também via APIs:

  • Cadastro — Nesta operação, será necessário informar todos os campos relevantes ao tipo de pessoa:
    • Pessoa jurídica: além dos dados gerais da empresa, outros grupos de dados também são necessários, como: endereço comercial, atividade econômica, contato, parceiros, representante legal, horário de funcionamento, etc. ;
    • Individual: além dos dados pessoais, outros grupos de dados também são necessários, como: endereço residencial e comercial, atividade econômica, horário de funcionamento etc.
  • Qualificação — Essa etapa segue o mesmo formato da versão simplificada, ou seja, todo o cadastro será avaliado para garantir que os produtos e serviços sejam relevantes.

Operações REST:

Registro simplificado

POSTAGEM https://{getnet-api-base}/merchants

Parâmetros importantes (corpo):

  • código_do_adquirente : Código do adquirente (sempre será getnet);
  • dados_legais do comerciante : Este é um objeto que conterá informações sobre o próprio estabelecimento:
    • Pessoa jurídica : país, pessoa.tipo fiscal, pessoa.legal _número do _documento;
    • Individual : country, person.fiscal_type, person.legal_document_number e birth_date.
  • informações_adicionais : Para fins de registro, termos e condições, é necessário aceitar essas informações e, para isso, esse objeto representa a “aceitação” dos termos e condições gerais de operação da LGPD.

A documentação técnica dos serviços está disponível no Registro simplificado e Páginas de consulta de documentos .

Complemento de registro

COLOQUE https://{getnet-api-base}/merchants

Parâmetros importantes (caminho):

  • ID do comerciante : ID do comerciante. Parâmetros importantes (corpo):
  • código_do_adquirente : Código do adquirente (sempre será getnet);
  • dados_legais do comerciante : Este é um objeto que conterá informações sobre o próprio estabelecimento:
    • Entidade legal : país, person.fiscal_type, person.legal_document_number, person.legal_name, person.founding_date, person.business_address, person.economic_activity_profile, person.contacts, person.shareholders, person.legal_representative, person.working_hours e outros;
    • Individual : country, person.fiscal_type, person.legal_document_number, person, person.birth_date, person.economic_activity_profile, person.residential_address, person.commercial_address, person.working_hours, person.legal_representative e outros.
  • informações_adicionais : Para fins de registro, termos e condições, é necessário aceitar essas informações e, para isso, esse objeto representa a “aceitação” dos termos e condições gerais de operação da LGPD.

A documentação técnica dos serviços está disponível no Registro simplificado e Páginas de consulta de documentos .

Qualificação de registro

POSTAGEM https://{getnet-api-base}/merchants/{merchant_id}/qualification

Parâmetros importantes (caminho):

  • ID do comerciante : Identificação do estabelecimento.

A documentação técnica das operações está disponível neste Link de comerciantes .

Etapa 3: Criando o pedido

Para que uma pessoa física ou jurídica realmente se torne cliente da Getnet, é necessário comprar produtos e/ou serviços e, para isso, um pedido deve ser feito.

A solicitação inclui informações sobre a oferta selecionada, detalhes do estabelecimento, bem como o endereço do cliente e a conta bancária para receber pagamentos.

Para criar um pedido, o serviço Pedidos deve ser usado:

POSTAGEM https://{getnet-api-base}/v1/orders

Parâmetros importantes (corpo):

  • dados_legais do comerciante : Este é um objeto que conterá informações sobre o próprio estabelecimento, como: país, person.fiscal _type, person.legal _document_number e similares;
  • informações_de_entrega : objeto contendo as informações para entregar os produtos adquiridos no pedido;
  • contas_comerciante : objeto contendo detalhes da conta bancária para receber pagamentos;
  • itens : objeto que contém todos os produtos e serviços solicitados no pedido.

A documentação técnica do serviço está disponível no Página de criação do pedido .

Depois de enviar o pedido, é necessário validar os dados enviados para o pedido e verificar se eles estão para realmente enviar o pedido.

Para validar o pedido, o serviço Pedidos deve ser usado:

POSTAGEM https://{getnet-api-base}/v1/orders/{order_id}/validation

Parâmetros importantes (caminho):

  • id_do_pedido : identificador do pedido a ser validado.

A documentação técnica do serviço está disponível no Página de validação do pedido .

Depois que o pedido for validado e aprovado, ele poderá ser enviado para compra e envio de produtos e/ou serviços.

Para enviar o pedido, o serviço Pedidos deve ser usado:

COLOQUE https://{getnet-api-base}/v1/orders/{order_id}/submit

Parâmetros importantes (caminho):

  • id_do_pedido : identificador do pedido a ser validado.

A documentação técnica do serviço está disponível no Página de envio de pedidos .