Introdução

GoMoney API

Documentação oficial para integração externa com customers e PIX

View as Markdown

A GoMoney disponibiliza uma estrutura de integração voltada a operações com autenticação, gerenciamento de customers e cobrança via PIX.

Esta seção reúne apenas conteúdo conceitual. O objetivo é explicar como os fluxos funcionam, quais responsabilidades existem em cada etapa e como os mecanismos de autenticação se relacionam entre si.

Escopo desta documentação

  • funcionamento dos acessos na plataforma e na camada de pagamentos;
  • processo de solicitação e custódia das credenciais de integração;
  • exigência de wallet previamente cadastrada e aprovada para operações de recebimento;
  • papel do cadastro de customers no fluxo operacional;
  • visão do ciclo de vida das cobranças PIX;
  • princípios de tratamento de erros e suporte ao go-live.

Fluxo resumido

  1. O integrador cria na plataforma um acesso do tipo INTEGRATION.
  2. Mantém a permissão INTEGRATION_ONLY ativa nesse acesso.
  3. Solicita ao suporte as credenciais clientKey e clientSecret, além da liberação do domínio.
  4. Informa a wallet operacional já registrada e aprovada.
  5. Faz login na API com o email e a senha do acesso criado para integração.
  6. Organiza seus customers para suportar conciliação e rastreabilidade.
  7. Gera cobranças PIX e acompanha o avanço do ciclo operacional.

Premissas importantes

  • o sistema combina autenticação de sessão com autenticação de integração;
  • o login da API deve usar o acesso criado para integração, não o usuário principal da conta;
  • as credenciais de integração pertencem exclusivamente ao solicitante autorizado;
  • a credencial de integração e a sessão autenticada precisam representar o mesmo usuário;
  • a wallet de recebimento precisa estar registrada e aprovada na plataforma antes da vinculação operacional.

Próximas leituras