Pular para o conteúdo principal

Contas

A 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á o formulário para criar novas contas de pagamento.

Tipos de contas de pagamento.​

Atualmente, o sistema oferece duas opções de tipos de contas de pagamento.

Stripe​

A plataforma OneEntry suporta integração com o sistema de pagamento Stripe. Escolha este tipo se quiser conectar o sistema de pagamento Stripe ao seu projeto. A integração do Stripe com a plataforma OneEntry é discutida aqui.

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 da conta de pagamento, indique:

  • Nome - String não única
  • Tipo - Valor da lista suspensa.
  • Marcador - 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 da conta de pagamento​

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

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

  • Nome
  • Tipo
  • Marcador

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), é possível adicionar parâmetros personalizados, específicos para uma API em particular, à conta de pagamento.

Esses parâmetros são transmitidos 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, Marcador), você verá uma tabela "Parâmetros personalizados para a API de pagamentos". A tabela é uma agregação de conjuntos de atributos do módulo de Configurações e permite definir a correspondência entre:

  • Marcador (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 Edit. 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 enviar os detalhes do pedido para o PayPal através do campo purchase_units. Você cria um conjunto de atributos chamado "Unidade de Compra do PayPal", adiciona a ele um 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": "Camiseta",
          "description": "Camiseta Super Fresca",
          "unit_amount": {
            "currency_code": "USD",
            "value": "20.00"
          },
          "quantity": "1",
          "category": "BENS_FÍSICOS",
          "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": "Sapatos",
          "description": "Corrida, Tamanho 10.5",
          "sku": "sku02",
          "unit_amount": {
            "currency_code": "USD",
            "value": "100.00"
          },
          "quantity": "2",
          "category": "BENS_FÍSICOS",
          "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 "Unidade de Compra do PayPal"
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 a quaisquer requisitos específicos de APIs externas sem alterar o código da plataforma.

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" Edit.

As 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 Edit.

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