Pular para o conteúdo principal

Contas

Uma conta de pagamento é uma forma de receber pagamentos ao fazer um pedido. Você pode criar várias contas para diferentes tipos de pagamento, como conectar um sistema de pagamento ou adicionar pagamento em dinheiro.

As ferramentas para trabalhar com contas estão na subseção "Contas" na seção "Pagamentos". As contas de pagamento já criadas estão na lista geral. Abaixo está um formulário para criar novas contas de pagamento.

Tipos de contas de pagamento.​

Atualmente, existem vários tipos de contas de pagamento disponíveis no sistema.

Stripe​

A OneEntry Platform suporta integração com o sistema de pagamento Stripe. Escolha este tipo se você deseja conectar o sistema de pagamento Stripe ao seu projeto. Mais detalhes sobre a conexão do Stripe com a OneEntry Platform podem ser encontrados aqui. (abre em uma nova aba)

Midtrans​

A OneEntry Platform suporta integração com o sistema de pagamento indonésio Midtrans. Mais detalhes sobre a conexão do Midtrans podem ser encontrados aqui. (abre em uma nova aba)

Xendit​

A OneEntry Platform suporta integração com o sistema de pagamento Xendit. Mais detalhes sobre a conexão do Xendit podem ser encontrados aqui. (abre em uma nova aba)

Personalizado​

Se você deseja usar outro sistema de pagamento ou aceitar pagamento em dinheiro, use este tipo de contas de pagamento.

Criação de conta de pagamento​

No formulário de criação de conta de pagamento, forneça:

  • Nome - String não única
  • Tipo - Valor da lista suspensa. Contas dos tipos Stripe, Midtrans e Xendit podem ser criadas apenas uma por projeto; contas do tipo Personalizado podem ser criadas quantas forem necessárias.
  • Token - String única.

Após preencher o formulário, clique no botão "Adicionar". Se todos os campos estiverem preenchidos corretamente, a conta de pagamento será criada e adicionada à lista geral.

Edição de conta de pagamento​

Selecione da lista a conta de pagamento que deseja editar e clique no ícone de edição Editar.

No modo de edição, você pode alterar:

  • Nome
  • Tipo
  • Token

As contas Stripe, Midtrans e Xendit no modo de edição também têm configurações de conexão com o sistema de pagamento. Elas estão descritas nas páginas Stripe (abre em uma nova aba), Midtrans (abre em uma nova aba) e Xendit (abre em uma nova aba).

Na tela de edição, também há uma tabela de histórico de versões da conta (colunas Version, Who made the change, Date, Saved data e ícone Restore Data na linha da versão; enquanto não houver salvamentos, em vez da tabela será exibido "No data available"): dela você pode ver salvamentos anteriores e restaurar o necessário. Mais detalhes estão na seção Histórico de versões.

As alterações serão salvas automaticamente.

Parâmetros personalizados para a API de pagamento​

Para uma integração flexível com vários sistemas de pagamento (por exemplo, PayPal, Stripe e outros), você pode adicionar parâmetros personalizados, específicos para uma API concreta, à conta de pagamento.

Esses parâmetros são passados na forma de pares "chave-valor" ao inicializar a sessão de pagamento. Por exemplo, na API de Pedidos do PayPal, frequentemente são necessários campos como purchase_units, intent, application_context.return_url ou payer.email_address, enquanto o Stripe utiliza outros parâmetros, como mode, line_items, etc.

Como funciona​

Além dos campos básicos (Nome, Tipo, Token), nas contas do tipo Stripe, Midtrans e Xendit, você verá uma tabela "Parâmetros personalizados para a API de pagamento" (Custom parameters for payment API). Contas do tipo Personalizado não têm essa tabela. Na tabela, são exibidos conjuntos de atributos da seção Settings → Attributes. A tabela permite definir a correspondência entre:

  • Token (Nome do parâmetro na API) (por exemplo, purchase_units para PayPal ou line_items para Stripe)
  • Valor, que será inserido ao criar o pagamento

Para definir o valor, é necessário abrir a edição do conjunto, clicando no botão Configurações. Em seguida, escolha o atributo necessário do conjunto pré-configurado e insira o valor necessário, de acordo com o tipo de atributo.

⚠️ Importante: os conjuntos de atributos e seu conteúdo são configurados separadamente e podem incluir campos de diferentes tipos: string, número, booleano, JSON, etc.

Exemplo de uso com PayPal Suponha que você queira passar os detalhes do pedido para o PayPal através do campo purchase_units. Você cria um conjunto de atributos chamado "PayPal Purchase Unit", adiciona a ele o atributo items do tipo JSON, contendo uma estrutura como:

    {
      "invoice_id": "90210",
      "amount": {
        "currency_code": "USD",
        "value": "230.00",
        "breakdown": {
          "item_total": {
            "currency_code": "USD",
            "value": "220.00"
          },
          "shipping": {
            "currency_code": "USD",
            "value": "10.00"
          }
        }
      },
      "items": [
        {
          "name": "T-Shirt",
          "description": "Super Fresh Shirt",
          "unit_amount": {
            "currency_code": "USD",
            "value": "20.00"
          },
          "quantity": "1",
          "category": "PHYSICAL_GOODS",
          "sku": "sku01",
          "image_url": "https://example.com/static/images/items/1/tshirt_green.jpg",
          "url": "https://example.com/url-to-the-item-being-purchased-1",
          "upc": {
            "type": "UPC-A",
            "code": "123456789012"
          }
        },
        {
          "name": "Shoes",
          "description": "Running, Size 10.5",
          "sku": "sku02",
          "unit_amount": {
            "currency_code": "USD",
            "value": "100.00"
          },
          "quantity": "2",
          "category": "PHYSICAL_GOODS",
          "image_url": "https://example.com/static/images/items/1/shoes_running.jpg",
          "url": "https://example.com/url-to-the-item-being-purchased-2",
          "upc": {
            "type": "UPC-A",
            "code": "987654321012"
          }
        }
      ]
}

Em seguida, nas configurações da conta de pagamento, você vincula:

Chave: purchase_units Valor: atributo items do conjunto "PayPal Purchase Unit" Ao criar o pedido, o sistema automaticamente insere o valor atual desse atributo no corpo da solicitação para a API do PayPal.

Outros parâmetros frequentemente utilizados no PayPal:

intent — por exemplo, "CAPTURE" ou "AUTHORIZE" application_context.return_url — URL para retorno após pagamento bem-sucedido application_context.cancel_url — URL de cancelamento do pagamento

Esse mecanismo permite adaptar as integrações de pagamento às exigências de APIs externas.

Exportação de dados da conta de pagamento​

Na linha da conta, além de ocultar, alterar e excluir, há um botão de exportação de dados (na versão atual, a dica é "Settings"). Ele abre uma janela de exportação: escolha o formato do arquivo — csv ou xml — e confirme a exportação, o arquivo será baixado no navegador. O botão está disponível para o administrador com permissão para exportar no módulo de pagamentos.

Ocultação da conta de pagamento​

Se você não deseja mais usar a conta de pagamento e não pode excluí-la, pois já está sendo utilizada no projeto, você pode ocultá-la.

Para isso, na conta selecionada, clique no ícone "olho" Ocultar.

Contas de pagamento ocultas não serão oferecidas pelo sistema para seleção ao configurar o armazenamento de pedidos.

Exclusão da conta de pagamento​

Selecione da lista a conta de pagamento que deseja excluir e clique no ícone de exclusão Excluir.

Confirme a ação na janela de diálogo. Após isso, a conta de pagamento será excluída e desaparecerá da lista geral.