šŸ‹ PagLemon | API Documentation
  1. Pagamentos
šŸ‹ PagLemon | API Documentation
  • Raiz
    • Admin
      • Aprovar empresa
      • Listar empresas
      • Listar solicitaƧƵes empresas
      • Receitas
      • Listar todos os pagamentos
      • Listar total de transaƧƵes
      • Listar dados de faturamento
      • Aprovar saque
      • Listar todas solicitaƧƵes de saques
      • Dashboard
      • Reprovar saque
      • Listar configuraƧƵes de saques
      • Listar configuraƧƵes de saque por ID
      • Atualizar configuração de saque por ID
      • Listar taxas
      • Listar taxa por ID
      • Listar todas as transaƧƵes
      • Listar administradores 🚧
      • Listar configuraƧƵes
      • Listar configuraƧƵes por ID
      • Atualizar configuraƧƵes
    • Default
      • Criar uma taxa
      • Atualizar uma taxa
      • Criar saque 🚧
      • Listar todos saques
      • Obter saque por ID
      • Listar taxas
      • Listar todas as transaƧƵes
      • Obter transaƧƵes por ID
    • Autenticação
      • Registro de usuĆ”rio
      • Login
      • Refresh token
    • Dashboard
      • Resumo
    • Empresas
      • Criar empresa
      • Atualizar empresa
      • Excluir empresa
      • Enviar documentos
      • Atualizar documentos
      • Listar empresas
    • IntegraƧƵes
      • Login API
      • Obter credenciais
      • Atualizar credenciais
    • Links de Pagamento
      • Criar link de pagamento
      • Listar links de pagamento
      • Obter link de pagamento pelo hash
      • Excluir link de pagamento
    • Pagamentos
      • Criar novo pagamento
        POST
      • Listar pagamentos
        GET
      • Listar pagamento por ID
        GET
    • UsuĆ”rios
      • Criar usuĆ”rio
      • Listar usuĆ”rio por ID
      • Atualizar usuĆ”rio
      • Excluir usuĆ”rio
      • Atualizar senha
    • Saldo
      • Obter saldo
    • Clientes
      • Criar novo cliente vendedor
      • Listar clientes vendedores
      • Obter um cliente vendedor por ID
      • Atualizar cliente vendedor
    • Webhooks
      • Criar webhook
      • Listar webhooks
      • Excluir webhook
    • Status
      • Eventos de saque (exemplos)
      • Status
  • Esquemas
    • Admin__api_v1_admin_enterprises_By_id__POST__Response_200
    • Admin__api_v1_admin_enterprises_By_id__POST__Response_400
    • Admin__api_v1_admin_enterprises__GET__Response_200
    • Admin__api_v1_admin_enterprises__GET__Response_401
    • Admin__api_v1_admin_enterprises_request__GET__Response_200
    • Admin__api_v1_admin_enterprises_revenue__GET__Response_200
    • Admin__api_v1_admin_payments__GET__Response_200
    • Admin__api_v1_admin_payments_total_transactions__GET__Response_200
    • Admin__api_v1_admin_payments_billing__GET__Response_200
    • Admin__api_v1_admin_withdrawals_request__GET__Response_200
    • Admin__api_v1_admin_withdrawals_dashboard__GET__Response_200
    • Admin__api_v1_admin_withdrawal_configs_By_sellerId__GET__Response_200
    • Admin__api_v1_admin_withdrawal_configs_By_sellerId__PUT__Request
    • Default__api_v1_fees__POST__Request
    • Default__api_v1_fees__POST__Response_201
    • Admin__api_v1_admin_fees__GET__Response_200
    • Default__api_v1_fees_By_id__PUT__Response_200
    • Admin__api_v1_admin_members__GET__Response_200
    • Admin__api_v1_admin_reserve_configs__GET__Response_200
    • Admin__api_v1_admin_reserve_configs_By_sellerId__GET__Response_200
    • Admin__api_v1_admin_reserve_configs_By_sellerId__PUT__Request
    • Autenticacao__api_v1_auth_register__POST__Request
    • Autenticacao__api_v1_auth_register__POST__Response_201
    • Autenticacao__api_v1_auth_register__POST__Response_400
    • Autenticacao__api_v1_auth_login__POST__Request
    • Autenticacao__api_v1_auth_login__POST__Response_200
    • Autenticacao__api_v1_auth_refresh__POST__Request
    • Autenticacao__api_v1_auth_refresh__POST__Response_200
    • Dashboard__api_v1_dashboard_overview__GET__Response_200
    • Empresas__api_v1_enterprises__POST__Request
    • Empresas__api_v1_enterprises__POST__Response_201
    • Empresas__api_v1_enterprises__PATCH__Response_200
    • Empresas__api_v1_enterprises__DELETE__Response_204
    • Empresas__api_v1_enterprises_By_id__POST__Request
    • Empresas__api_v1_enterprises_By_id__POST__Response_400
    • Empresas__api_v1_enterprises_By_id_documents_By_type__PATCH__Request
    • Empresas__api_v1_enterprises_By_id_documents_By_type__PATCH__Response_200
    • Integracoes__api_v1_api_auth_login__POST__Request
    • Integracoes__api_v1_api_auth_login__POST__Response_200
    • Integracoes__api_v1_integrations_credentials__GET__Response_201
    • Links_de_Pagamento__api_v1_payment_links__POST__Request
    • Links_de_Pagamento__api_v1_payment_links__POST__Response_201
    • Links_de_Pagamento__api_v1_payment_links__GET__Response_200
    • Pagamentos__api_v1_payments__POST__Request
    • Pagamentos__api_v1_payments__POST__Response_200
    • Pagamentos__api_v1_payments_By_id__GET__Response_200
    • Default__api_v1_withdrawals__POST__Request
    • Default__api_v1_withdrawals__POST__Response_201
    • Default__api_v1_withdrawals__GET__Response_200
    • Usuarios__api_v1_users__POST__Request
    • Usuarios__api_v1_users_By_id__GET__Response_200
    • Usuarios__api_v1_users_By_id__PATCH__Request
    • Usuarios__api_v1_users_By_id_password__PATCH__Request
    • Saldo__api_v1_seller_balances_me__GET__Response_200
    • Clientes__api_v1_customers__POST__Request
    • Clientes__api_v1_customers__POST__Response_201
    • Clientes__api_v1_customers__GET__Response_200
    • Webhooks__api_v1_seller_webhooks__POST__Request
    • Webhooks__api_v1_seller_webhooks__POST__Response_201
    • Status__Root__GET__Response_200
    • Status__api_v1_status__GET__Response_200
    • Error_Unauthorized
    • Error_Standard
  1. Pagamentos

Listar pagamento por ID

GET
/api/v1/payments/{id}
Endpoint para listar pagamento pelo ID.

šŸ’¾ Estrutura de Dados#

Headers#

Content-type: application/json
Authorization: Bearer <JWT_TOKEN>

Route Params#

PropriedadeTipoObrigatórioDescriçãoValor (exemplo)
:idUUIDSimIdentificador Ćŗnico (ID) do pagamento123e4567-e89b-12d3-a456-426655440000

Body (JSON)#

Não aplicÔvel

Requisição

Parâmetros de Caminho

Respostas

🟢200
application/json
Body

🟠400
🟠401
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/v1/payments/2ed5d3b1-d767-4318-9cde-bccc43c4b1e1'
Response Response Example
200 - Sucesso
{
    "id": "2ed5d3b1-d767-4318-9cde-bccc43c4b1e1",
    "externalId": null,
    "amount": 15,
    "status": "CREATED",
    "qrCode": null,
    "createdAt": "2025-12-02T18:43:56.941Z",
    "expiresAt": "2025-12-03T18:43:56.936Z",
    "confirmedAt": null,
    "purchaser": "pluggou",
    "method": "pix",
    "customerEmail": "joao@email.com",
    "customerName": "João Silva",
    "paymentLinkId": "481ca7fe-c035-4586-aff9-5bd0e4b6756c",
    "amountWithAllFees": 15,
    "amountWithFeesPagLemon": 15,
    "amountWithFeesGateway": 14.5,
    "customerId": "4ef35102-e234-4a03-84ae-6c3346fa0027",
    "metadata": null,
    "paymentLink": {
        "id": "481ca7fe-c035-4586-aff9-5bd0e4b6756c",
        "description": "Payment link example.",
        "url": "http://localhost:3000/checkout/link-n5cHNvRswh",
        "status": "ACTIVE",
        "qtdPayments": 0,
        "amount": 200.5,
        "createdAt": "2025-12-02T18:38:34.818Z",
        "hash": "link-n5cHNvRswh",
        "purchaser": "pluggou",
        "sellerId": "4ef35102-e234-4a03-84ae-6c3346fa0027"
    }
}
Modificado emĀ 2025-12-31 00:48:40
PƔgina anterior
Listar pagamentos
Próxima pÔgina
Criar usuƔrio
Built with