1.0.0
  • 1.0.0
  • 1.1.0
    1.0.0
    • 1.0.0
    • 1.1.0
    Default module
    • Default module
    • Teste
    • Overview
    • Webhooks
    • Error codes
    • Ambiente de Testes
    • Transactions
      • Criar uma Transação
        POST
      • Criar uma Transação Com 3DS
        POST
      • Criar uma Transação PIX
        POST
      • Criar uma Transação Boleto
        POST
      • Criar uma Transação - Split
        POST
      • Estornar uma transação
        POST
      • Capturando uma Transação
        POST
      • Buscar Transação
        GET
      • Listar Transações
        GET
      • Retornar Histórico de uma Transação
        GET
      • Retornar Parcelas de uma transação
        GET
    • Payment Links
      • Criar Link
        POST
      • Atualizar Link
        PUT
      • Buscar Link
        GET
      • Listar Links
        GET
      • Transações de um link
        GET
    • Customer
      • Criar Cliente
        POST
      • Encontrar Cliente
        POST
      • Cartões do Cliente
        POST
      • Atualizar Cliente
        PUT
      • Buscar Cliente
        GET
      • Listar Clientes
        GET
      • Deletar um cliente
        DELETE
    • Cards
      • Criar Cartão
      • Obter Bandeira
      • Buscar Cartão
      • Listar Cartões
    • Simulate
      • Tax
    • Split
      • Receivers
        • Criando um recebedor
        • Atualizando um recebedor
        • Retornar um recebedor
        • Retornar recebedores
        • Deletar um recebedor
      • Receiver Bank Accounts
        • Criar banco para um recebedor
        • Retornar contas de um recebedor
        • Retornar conta de um recebedor por id da conta bancária
        • Deletar uma conta bancária de um recebedor
        • Atualizar o status da conta bancária de um recebedor
    • Recurrence
      • Prices
        • Criar novo preço
        • visualizar os preços de um plano
        • visualizar os preços de um plano Copy
        • Atualizar preço
        • Deletar preço
      • Plans
        • Criar um Plano
        • Atualizar Um Plano
        • Listar Planos
        • Buscar um Plano
        • Deletar um Plano
      • Subscriptions
        • Criar uma Assinatura (IDs)
        • Criar uma Assinatura (Sem IDs)
        • Atualizar uma Assinatura
        • Buscar uma Assinatura
        • Buscar Assinaturas
        • Cancelar uma Assinatura
        • Deletar uma Assinatura
    • Webhook
      • Criar um webhook
      • Atualizar Webhook
      • Retornar Webhooks Cadastrados
      • Retornar um Webhook
      • Remover um Webhook
    • Configuration
      • Adding Acquirers
      • Setting Main Acquirer
      • Configuring Anti Fraud
    • Esquemas
      • Teste 3

    Overview

    Apresentação da documentação da ferramente de gateway de pagamentos Pay Tools.

    Ambientes de teste e produção#

    Ao efetuar transações com a Pay Tools, você tem à disposição duas Chaves de API distintas, uma para a fase de testes e outra para a fase de produção. Além disso, os endpoints também são diferenciados, com um específico para testes e outro para operações em produção. Dessa maneira, você pode selecionar tanto a chave quanto o endpoint apropriados conforme o tipo de operação que deseja realizar.

    Chaves de API#

    Diferenças entre as chaves de API.
    Produção: live_xxxxxxxxxxxxxxxxxx
    Sandbox: test_xxxxxxxxxxxxxxxxxxx
    As chaves de autenticação destinadas ao ambiente live possuem a capacidade de executar qualquer operação em nossa API, portanto, é de suma importância que sejam mantidas em um local seguro, evitando sua exposição no lado do cliente de sua aplicação.

    Códigos de resposta#

    CódigoSignificado
    200Tudo ocorreu como deveria e sua requisição foi processada com sucesso.
    400Algum parâmetro obrigatório não foi passado, ou os parâmetros passados não estão corretos.
    401Falta de autorização para acessar este endpoint.
    404Endpoint não encontrado, revise a URL passada.
    500Erro interno, tente sua requisição novamente. Caso o erro continue, entre em contato com suporte@paytools.com.br
    Modificado em 2025-01-13 10:21:27
    Próxima página
    Webhooks
    Built with