Pular para o conteúdo

Primeiros passos

Antes de iniciar o processo de integração com a API do Payments Direct, revise os seguintes itens:

Repositório do GitHub

O repositório oficial do Payments Direct no GitHub é a fonte única de verdade para tudo o que você precisa para integrar com a API do Payments Direct v2026.04:

  • Especificação OpenAPI: a definição canônica da API do Payments Direct.
  • SDKs: bibliotecas de cliente em várias linguagens, disponíveis no repositório e pelos gerenciadores de pacotes padrão.
  • Exemplos: código de exemplo de ponta a ponta para fluxos de pagamento comuns (criar uma cotação, enviar um pagamento, verificar o status).
  • Releases: versões com tag que alinham a especificação, os SDKs e os exemplos a releases específicas da API.

Consulte o README do repositório para ver instruções de instalação e exemplos de uso.

Ferramentas

Para se preparar para a integração com a API do Payments Direct:

  • Instale o Postman (como alternativa, a documentação traz exemplos em curl).
  • Use o Postman para gerar uma collection a partir da especificação da API do Payments Direct. Para saber como fazer isso, consulte Generate collections from you API specification.
  • Configure um gerenciador de senhas para as chaves de API.
  • Confirme com o seu contato na Ripple que a sua instância de teste está pronta.

Criação de usuários

Para configurar contas para os desenvolvedores, o administrador da sua organização precisa:

  1. Acessar o Payments Direct UI.
  2. Navegar até Configurações e selecionar Usuários.
  3. Selecionar Novo usuário.
  4. Marcar a permissão Pode ler de API Credentials.
  5. Marcar a permissão Pode editar de API Credentials.
  6. Salvar o usuário e repetir o processo para cada desenvolvedor da equipe.

Credenciais da API

Para configurar as credenciais da API, cada desenvolvedor precisa:

  1. Acessar o Payments Direct UI, clicar em Configurações e depois clicar em Credenciais de API na seção Integration.
  2. Clique em Nova credencial.
  3. Informar um nome para a nova credencial.
  4. Clique em Salvar e gerar chave.
  5. Copiar a credencial e armazená-la em local seguro para usar nas chamadas de API.
  6. Para concluir a criação da credencial, clicar em Fechar.