Rotas da Ibiapaba
  1. payments
Rotas da Ibiapaba
  • ⛰️ Doc - API Rotas da Ibiapaba
  • /authentication
    • Autenticação de Usuário
      POST
    • Validação de Acesso
      POST
    • Redefinição de Senha
      POST
    • Alteração de Senha
      PATCH
    • Encerrar Sessão
      POST
    • Renovar tokens
      POST
    • Reenvio de código para email
      POST
  • /accounts
    • Cadastro de Usuário
      POST
    • Listar usuarios
      GET
    • Detalhes do Usuario
      GET
    • Cadastrar chave pix
      POST
    • Atualizar chave pix
      PUT
    • Atualizar dados do usuario
      PUT
    • Deleta dados do usuario
      PUT
  • /categories
    • Listar Categorias
      GET
    • Criar Categoria
      POST
    • Atualizar Categoria
      PUT
    • Excluir Categoria
      DELETE
  • photos
    • EnviarFotoProfile
      POST
    • EnviarGaleriadeFotos
      POST
  • /tickets
    • Validar código
      POST
    • Resgatar um único produto
      POST
    • Listar todos os tickets
      GET
  • /products
    • Cadastrar produto
    • Mostar dados de um produto
    • Atualizar um produto
    • Remover um produto
    • Mostar todos os produtos de um estabelecimento
  • /orders
    • Adicionar Item ao Carrinho
    • Iniciar processo de pagamento de pedido
    • Listar Itens do Carrinho
  • payments
    • Consultar status de pagamento
      GET
    • Solicitar retirada de dinheiro
      POST
  • /transactions
    • Mostra o resumo de movimentações em dinheiro
    • Mostar todas as transações do estabelecimento
  • /partners
    • Mostar parceiros anunciantes próximos
  • others
    • Cadastrar mensagem de ajuda ao suporte
  1. payments

Consultar status de pagamento

Em desenvolvimento
GET
/payments/{paymentId}/status/

Rota: /payments/{paymentId}/status/#

Nome: Consultar status de pagamento
Descrição: Esta rota permite ao usuário ou ao sistema consultar o status atual de uma tentativa de pagamento específica. O status é identificado pelo paymentId que foi retornado durante a iniciação do pagamento (/orders/pay/). É especialmente útil para acompanhar o progresso de transações assíncronas (como pagamentos via PIX ou Boleto, ou após um redirecionamento para 3D Secure) onde a confirmação não é imediata.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/payments//status/'
Response Response Example
200 - Example 1
{
    "message": {
        "title": "Status de Pagamento Recuperado",
        "text": "O status da transação de pagamento foi obtido com sucesso.",
        "description": "Exibe o estado atual do pagamento, que pode ser 'pending', 'approved', 'declined', 'refunded', etc."
    },
    "success": true,
    "status": 200,
    "data": {
        "paymentId": "PAY-1223345", // O ID da transação de pagamento consultada
        "orderId": "ORDER-983476", // O ID do pedido associado a este pagamento
        "status": "approved",
        "amountPaid": 150.00,
        "paymentMethodType": "credit_card",
        "lastUpdatedAt": "2025-06-12T09:15:30Z"
    }
}

Requisição

Parâmetros Path

Respostas

🟢200Success
application/json
Body

🔴500 Internal Server Error
🟠401Unauthorized
Modificado em 2025-06-12 12:13:47
Página anterior
Listar Itens do Carrinho
Próxima página
Solicitar retirada de dinheiro
Built with