StafeBank Gateway
    StafeBank Gateway
    • 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
      • 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
        POST
      • Obter Bandeira
        POST
      • Buscar Cartão
        GET
      • Listar Cartões
        GET
    • Webhook
      • Criar um webhook
      • Atualizar Webhook
      • Retornar Webhooks Cadastrados
      • Retornar um Webhook
      • Remover um Webhook
    • Simulate
      • Tax
    • Recurrence
      • Plans
        • Create Plan
        • Update Plan
        • Get a Plan
        • List Plans
      • Subscription
        • Create Subscription
        • Cancel Subscription
        • GET Subscription

    Overview

    Introdução#

    Bem-vindo à documentação da API do Gateway de Pagamentos StafeBank.
    Esta API permite a integração de pagamentos de forma segura e eficiente, fornecendo endpoints para transações, consultas e gerenciamento de pagamentos.

    Hosts#

    O host para acessar as funcionalidades da API é:
    http://onapi.stafebank.com.br
    O host de production é o mesmo de sandbox.
    Para acessar as funcionalidades sandbox é necessário utilizar a chave de desenvolvedor que é passada pelo time de suporte.

    Autenticação#

    A API do Gateway utiliza autenticação via Bearer Token, garantindo segurança e controle de acesso. Todas as requisições protegidas devem incluir um token de aplicação no cabeçalho da requisição.

    Obtendo o Token#

    Para acessar os endpoints protegidos, você precisará de um token de autenticação. Esse token pode ser obtido no painel da StafeBank.

    Cabeçalho de Autenticação#

    Todas as requisições autenticadas devem conter o seguinte cabeçalho:
    Authorization: Bearer {SEU_TOKEN_AQUI}

    Exemplo de Requisiçã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 em suporte@stafebank.com.br.
    Modificado em 2025-06-11 09:44:36
    Próxima página
    Webhooks
    Built with