# šŸ‹ PagLemon | API Documentation ## API Docs - Raiz > Admin [Aprovar empresa](https://docs.paglemon.org/aprovar-empresa-26133823e0.md): Endpoint para usuĆ”rio administrador realizar a aprovação de uma empresa. - Raiz > Admin [Listar empresas](https://docs.paglemon.org/listar-empresas-26133824e0.md): Endpoint para usuĆ”rio administrador listar todas as empresas. - Raiz > Admin [Listar solicitaƧƵes empresas](https://docs.paglemon.org/listar-solicita%C3%A7%C3%B5es-empresas-26133825e0.md): Endpoint para listar todas as solicitaƧƵes de empresas pendentes de aprovação. - Raiz > Admin [Receitas](https://docs.paglemon.org/receitas-26133826e0.md): - Raiz > Admin [Listar todos os pagamentos](https://docs.paglemon.org/listar-todos-os-pagamentos-26133827e0.md): Endpoint para usuĆ”rio administrador listar todos os pagamentos. - Raiz > Admin [Listar total de transaƧƵes](https://docs.paglemon.org/listar-total-de-transa%C3%A7%C3%B5es-26133828e0.md): Endpoint para usuĆ”rio administrador obter dados de total de transaƧƵes. - Raiz > Admin [Listar dados de faturamento](https://docs.paglemon.org/listar-dados-de-faturamento-26133829e0.md): Endpoint para usuĆ”rio administrador obter dados de faturamento. - Raiz > Admin [Aprovar saque](https://docs.paglemon.org/aprovar-saque-26133830e0.md): Endpoint para usuĆ”rio administrador realizar a aprovação de uma saque. - Raiz > Admin [Listar todas solicitaƧƵes de saques](https://docs.paglemon.org/listar-todas-solicita%C3%A7%C3%B5es-de-saques-26133831e0.md): Endpoint para listar todas as solicitaƧƵes de saques pendentes de aprovação. - Raiz > Admin [Dashboard](https://docs.paglemon.org/dashboard-26133832e0.md): Endpoint que obtĆ©m dados para o dashboard de saques do administrador. - Raiz > Admin [Reprovar saque](https://docs.paglemon.org/reprovar-saque-26133833e0.md): Endpoint para usuĆ”rio administrador realizar a reprovação de uma saque. - Raiz > Admin [Listar configuraƧƵes de saques](https://docs.paglemon.org/listar-configura%C3%A7%C3%B5es-de-saques-26133834e0.md): Endpoint para listar todas as configuraƧƵes de saques dos vendedores (*seller*). - Raiz > Admin [Listar configuraƧƵes de saque por ID](https://docs.paglemon.org/listar-configura%C3%A7%C3%B5es-de-saque-por-id-26133835e0.md): Endpoint para listar todas as configuraƧƵes de saque de um vendedor (*seller*) especĆ­fico. - Raiz > Admin [Atualizar configuração de saque por ID](https://docs.paglemon.org/atualizar-configura%C3%A7%C3%A3o-de-saque-por-id-26133836e0.md): Endpoint para atualizar as configuraƧƵes de saque de um vendedor (*seller*) especĆ­fico. - Raiz > Admin [Listar taxas](https://docs.paglemon.org/listar-taxas-26133837e0.md): Endpoint para usuĆ”rio administrador listar todas as taxas (usuĆ”rio vigente autenticado). - Raiz > Admin [Listar taxa por ID](https://docs.paglemon.org/listar-taxa-por-id-26133838e0.md): Endpoint para usuĆ”rio administrador listar uma taxa por ID vendedor (*seller*). - Raiz > Admin [Listar todas as transaƧƵes](https://docs.paglemon.org/listar-todas-as-transa%C3%A7%C3%B5es-26133839e0.md): Endpoint para usuĆ”rio administrador listar todas as transaƧƵes. - Raiz > Admin [Listar administradores 🚧](https://docs.paglemon.org/listar-administradores-26133840e0.md): - Raiz > Admin [Listar configuraƧƵes](https://docs.paglemon.org/listar-configura%C3%A7%C3%B5es-26133841e0.md): Endpoint para listar as configuraƧƵes dos vendedores (*seller*). - Raiz > Admin [Listar configuraƧƵes por ID](https://docs.paglemon.org/listar-configura%C3%A7%C3%B5es-por-id-26133842e0.md): Endpoint para listar as configuraƧƵes dos vendedores (*seller*). - Raiz > Admin [Atualizar configuraƧƵes](https://docs.paglemon.org/atualizar-configura%C3%A7%C3%B5es-26133843e0.md): Endpoint para atualzar as configuraƧƵes dos vendedores (*seller*). - Raiz > Default [Criar uma taxa](https://docs.paglemon.org/criar-uma-taxa-26133844e0.md): Endpoint para usuĆ”rio administrador criar uma taxa (usuĆ”rio vigente autenticado). - Raiz > Default [Atualizar uma taxa](https://docs.paglemon.org/atualizar-uma-taxa-26133845e0.md): Endpoint para usuĆ”rio administrador atualizar parĆ¢metros de taxa existente (usuĆ”rio vigente autenticado). - Raiz > Default [Criar saque 🚧](https://docs.paglemon.org/criar-saque-26133846e0.md): Endpoint para criar um novo registro de saque. - Raiz > Default [Listar todos saques](https://docs.paglemon.org/listar-todos-saques-26133847e0.md): Listar todas as solicitaƧƵes de saque do vendedor (usuĆ”rio) logado. Ou seja, serĆ” listado somente os saques do usuĆ”rio atual autenticado. - Raiz > Default [Obter saque por ID](https://docs.paglemon.org/obter-saque-por-id-26133848e0.md): Retorna os detalhes de um saque especĆ­fico pelo seu ID. - Raiz > Default [Listar taxas](https://docs.paglemon.org/listar-taxas-26133849e0.md): Endpoint para usuĆ”rios verem suas próprias taxas (usuĆ”rio vigente autenticado). - Raiz > Default [Listar todas as transaƧƵes](https://docs.paglemon.org/listar-todas-as-transa%C3%A7%C3%B5es-26133850e0.md): Endpoint para listar todas as transaƧƵes. - Raiz > Default [Obter transaƧƵes por ID](https://docs.paglemon.org/obter-transa%C3%A7%C3%B5es-por-id-26133851e0.md): Endpoint para buscar por uma transação especĆ­fica. - Raiz > Autenticação [Registro de usuĆ”rio](https://docs.paglemon.org/registro-de-usu%C3%A1rio-26133852e0.md): Endpoint para criar um novo usuĆ”rio. - Raiz > Autenticação [Login](https://docs.paglemon.org/login-26133853e0.md): Endpoint que autentica um usuĆ”rio e retorna tokens de acesso para usuĆ”rio realizar login. - Raiz > Autenticação [Refresh token](https://docs.paglemon.org/refresh-token-26133854e0.md): Endpoint para atualizar um token de acesso expirado usando um refresh token. - Raiz > Dashboard [Resumo](https://docs.paglemon.org/resumo-26133855e0.md): Endpoint para retornar dados sobre receitas. - Raiz > Empresas [Criar empresa](https://docs.paglemon.org/criar-empresa-26133856e0.md): Endpoint para criar uma nova empresa associada ao usuĆ”rio autenticado. - Raiz > Empresas [Atualizar empresa](https://docs.paglemon.org/atualizar-empresa-26133857e0.md): Endpoint para atualizar os dados da empresa associada ao usuĆ”rio autenticado. - Raiz > Empresas [Excluir empresa](https://docs.paglemon.org/excluir-empresa-26133858e0.md): Endpoint para excluir a empresa associada ao usuĆ”rio autenticado (_soft delete_). - Raiz > Empresas [Enviar documentos](https://docs.paglemon.org/enviar-documentos-26133859e0.md): Endpoint para enviar imagem dos documentos. - Raiz > Empresas [Atualizar documentos](https://docs.paglemon.org/atualizar-documentos-26133860e0.md): Endpoint para atualizar algum dos documentos. - Raiz > Empresas [Listar empresas](https://docs.paglemon.org/listar-empresas-26133861e0.md): Endpoint para obter dados da empresa associada ao usuĆ”rio autenticado. - Raiz > IntegraƧƵes [Login API](https://docs.paglemon.org/login-api-26133862e0.md): Endpoint para se autenticar usando API Key e o API Secret. - Raiz > IntegraƧƵes [Obter credenciais](https://docs.paglemon.org/obter-credenciais-26133863e0.md): Endpoint para gerar credenciais. - Raiz > IntegraƧƵes [Atualizar credenciais](https://docs.paglemon.org/atualizar-credenciais-26133864e0.md): Endpoint para atualizar credenciais. - Raiz > Links de Pagamento [Criar link de pagamento](https://docs.paglemon.org/criar-link-de-pagamento-26133865e0.md): Endpoint para criar um novo link de pagamento. - Raiz > Links de Pagamento [Listar links de pagamento](https://docs.paglemon.org/listar-links-de-pagamento-26133866e0.md): Endpoint para listar links de pagamento. - Raiz > Links de Pagamento [Obter link de pagamento pelo hash](https://docs.paglemon.org/obter-link-de-pagamento-pelo-hash-26133867e0.md): - Raiz > Links de Pagamento [Excluir link de pagamento](https://docs.paglemon.org/excluir-link-de-pagamento-26133868e0.md): - Raiz > Pagamentos [Criar novo pagamento](https://docs.paglemon.org/criar-novo-pagamento-26133869e0.md): Endpoint para criar uma nova solicitação de pagamento. - Raiz > Pagamentos [Listar pagamentos](https://docs.paglemon.org/listar-pagamentos-26133870e0.md): Endpoint para listar todos os pagamentos somente do vendedor logado. - Raiz > Pagamentos [Listar pagamento por ID](https://docs.paglemon.org/listar-pagamento-por-id-26133871e0.md): Endpoint para listar pagamento pelo ID. - Raiz > UsuĆ”rios [Criar usuĆ”rio](https://docs.paglemon.org/criar-usu%C3%A1rio-26133872e0.md): Endpoint para criar novo usuĆ”rio. - Raiz > UsuĆ”rios [Listar usuĆ”rio por ID](https://docs.paglemon.org/listar-usu%C3%A1rio-por-id-26133873e0.md): Endpoint para buscar um usuĆ”rio especĆ­fico pelo seu ID. - Raiz > UsuĆ”rios [Atualizar usuĆ”rio](https://docs.paglemon.org/atualizar-usu%C3%A1rio-26133874e0.md): Endpoint para atualizar dados de um usuĆ”rio existente. - Raiz > UsuĆ”rios [Excluir usuĆ”rio](https://docs.paglemon.org/excluir-usu%C3%A1rio-26133875e0.md): Endpoint para excluir usuĆ”rio existente. - Raiz > UsuĆ”rios [Atualizar senha](https://docs.paglemon.org/atualizar-senha-26133876e0.md): Endpoint para atualizar somente a senha de um usuĆ”rio. - Raiz > Saldo [Obter saldo](https://docs.paglemon.org/obter-saldo-26133877e0.md): Endpoint que lista informaƧƵes de saldo do usuĆ”rio autenticado (*seller*). - Raiz > Clientes [Criar novo cliente vendedor](https://docs.paglemon.org/criar-novo-cliente-vendedor-26133878e0.md): Endpoint para criar um novo cliente vendedor. - Raiz > Clientes [Listar clientes vendedores](https://docs.paglemon.org/listar-clientes-vendedores-26133879e0.md): Endpoint para listar todos clientes vendedores. - Raiz > Clientes [Obter um cliente vendedor por ID](https://docs.paglemon.org/obter-um-cliente-vendedor-por-id-26133880e0.md): Endpoint para buscar por uma cliente vendedor especĆ­fico. - Raiz > Clientes [Atualizar cliente vendedor](https://docs.paglemon.org/atualizar-cliente-vendedor-26133881e0.md): Endpoint para atualizar por uma cliente vendedor especĆ­fico. - Raiz > Webhooks [Criar webhook](https://docs.paglemon.org/criar-webhook-26133882e0.md): Endpoint para criar um novo Webhook. - Raiz > Webhooks [Listar webhooks](https://docs.paglemon.org/listar-webhooks-26133883e0.md): Endpoint para listar todos os Webooks do vendedor (*seller*). - Raiz > Webhooks [Excluir webhook](https://docs.paglemon.org/excluir-webhook-26133884e0.md): Endpoint para excluir o Webhook. - Raiz > Status [Eventos de saque (exemplos)](https://docs.paglemon.org/eventos-de-saque-exemplos-26133885e0.md): Estruturas dos *payloads* (JSON) dos eventos de saque. - Raiz > Status [Status](https://docs.paglemon.org/status-26133886e0.md): Endpoint para verificar o estado da aplicação (API) e banco de dados. ## Schemas - [Admin__api_v1_admin_enterprises_By_id__POST__Response_200](https://docs.paglemon.org/admin-api-v1-admin-enterprises-by-id-post-response-200-11930796d0.md): - [Admin__api_v1_admin_enterprises_By_id__POST__Response_400](https://docs.paglemon.org/admin-api-v1-admin-enterprises-by-id-post-response-400-11930797d0.md): - [Admin__api_v1_admin_enterprises__GET__Response_200](https://docs.paglemon.org/admin-api-v1-admin-enterprises-get-response-200-11930798d0.md): - [Admin__api_v1_admin_enterprises__GET__Response_401](https://docs.paglemon.org/admin-api-v1-admin-enterprises-get-response-401-11930799d0.md): - [Admin__api_v1_admin_enterprises_request__GET__Response_200](https://docs.paglemon.org/admin-api-v1-admin-enterprises-request-get-response-200-11930800d0.md): - [Admin__api_v1_admin_enterprises_revenue__GET__Response_200](https://docs.paglemon.org/admin-api-v1-admin-enterprises-revenue-get-response-200-11930801d0.md): - [Admin__api_v1_admin_payments__GET__Response_200](https://docs.paglemon.org/admin-api-v1-admin-payments-get-response-200-11930802d0.md): - [Admin__api_v1_admin_payments_total_transactions__GET__Response_200](https://docs.paglemon.org/admin-api-v1-admin-payments-total-transactions-get-response-200-11930803d0.md): - [Admin__api_v1_admin_payments_billing__GET__Response_200](https://docs.paglemon.org/admin-api-v1-admin-payments-billing-get-response-200-11930804d0.md): - [Admin__api_v1_admin_withdrawals_request__GET__Response_200](https://docs.paglemon.org/admin-api-v1-admin-withdrawals-request-get-response-200-11930805d0.md): - [Admin__api_v1_admin_withdrawals_dashboard__GET__Response_200](https://docs.paglemon.org/admin-api-v1-admin-withdrawals-dashboard-get-response-200-11930806d0.md): - [Admin__api_v1_admin_withdrawal_configs_By_sellerId__GET__Response_200](https://docs.paglemon.org/admin-api-v1-admin-withdrawal-configs-by-sellerid-get-response-200-11930807d0.md): - [Admin__api_v1_admin_withdrawal_configs_By_sellerId__PUT__Request](https://docs.paglemon.org/admin-api-v1-admin-withdrawal-configs-by-sellerid-put-request-11930808d0.md): - [Default__api_v1_fees__POST__Request](https://docs.paglemon.org/default-api-v1-fees-post-request-11930809d0.md): - [Default__api_v1_fees__POST__Response_201](https://docs.paglemon.org/default-api-v1-fees-post-response-201-11930810d0.md): - [Admin__api_v1_admin_fees__GET__Response_200](https://docs.paglemon.org/admin-api-v1-admin-fees-get-response-200-11930811d0.md): - [Default__api_v1_fees_By_id__PUT__Response_200](https://docs.paglemon.org/default-api-v1-fees-by-id-put-response-200-11930812d0.md): - [Admin__api_v1_admin_members__GET__Response_200](https://docs.paglemon.org/admin-api-v1-admin-members-get-response-200-11930813d0.md): - [Admin__api_v1_admin_reserve_configs__GET__Response_200](https://docs.paglemon.org/admin-api-v1-admin-reserve-configs-get-response-200-11930814d0.md): - [Admin__api_v1_admin_reserve_configs_By_sellerId__GET__Response_200](https://docs.paglemon.org/admin-api-v1-admin-reserve-configs-by-sellerid-get-response-200-11930815d0.md): - [Admin__api_v1_admin_reserve_configs_By_sellerId__PUT__Request](https://docs.paglemon.org/admin-api-v1-admin-reserve-configs-by-sellerid-put-request-11930816d0.md): - [Autenticacao__api_v1_auth_register__POST__Request](https://docs.paglemon.org/autenticacao-api-v1-auth-register-post-request-11930817d0.md): - [Autenticacao__api_v1_auth_register__POST__Response_201](https://docs.paglemon.org/autenticacao-api-v1-auth-register-post-response-201-11930818d0.md): - [Autenticacao__api_v1_auth_register__POST__Response_400](https://docs.paglemon.org/autenticacao-api-v1-auth-register-post-response-400-11930819d0.md): - [Autenticacao__api_v1_auth_login__POST__Request](https://docs.paglemon.org/autenticacao-api-v1-auth-login-post-request-11930820d0.md): - [Autenticacao__api_v1_auth_login__POST__Response_200](https://docs.paglemon.org/autenticacao-api-v1-auth-login-post-response-200-11930821d0.md): - [Autenticacao__api_v1_auth_refresh__POST__Request](https://docs.paglemon.org/autenticacao-api-v1-auth-refresh-post-request-11930822d0.md): - [Autenticacao__api_v1_auth_refresh__POST__Response_200](https://docs.paglemon.org/autenticacao-api-v1-auth-refresh-post-response-200-11930823d0.md): - [Dashboard__api_v1_dashboard_overview__GET__Response_200](https://docs.paglemon.org/dashboard-api-v1-dashboard-overview-get-response-200-11930824d0.md): - [Empresas__api_v1_enterprises__POST__Request](https://docs.paglemon.org/empresas-api-v1-enterprises-post-request-11930825d0.md): - [Empresas__api_v1_enterprises__POST__Response_201](https://docs.paglemon.org/empresas-api-v1-enterprises-post-response-201-11930826d0.md): - [Empresas__api_v1_enterprises__PATCH__Response_200](https://docs.paglemon.org/empresas-api-v1-enterprises-patch-response-200-11930827d0.md): - [Empresas__api_v1_enterprises__DELETE__Response_204](https://docs.paglemon.org/empresas-api-v1-enterprises-delete-response-204-11930828d0.md): - [Empresas__api_v1_enterprises_By_id__POST__Request](https://docs.paglemon.org/empresas-api-v1-enterprises-by-id-post-request-11930829d0.md): - [Empresas__api_v1_enterprises_By_id__POST__Response_400](https://docs.paglemon.org/empresas-api-v1-enterprises-by-id-post-response-400-11930830d0.md): - [Empresas__api_v1_enterprises_By_id_documents_By_type__PATCH__Request](https://docs.paglemon.org/empresas-api-v1-enterprises-by-id-documents-by-type-patch-request-11930831d0.md): - [Empresas__api_v1_enterprises_By_id_documents_By_type__PATCH__Response_200](https://docs.paglemon.org/empresas-api-v1-enterprises-by-id-documents-by-type-patch-response-200-11930832d0.md): - [Integracoes__api_v1_api_auth_login__POST__Request](https://docs.paglemon.org/integracoes-api-v1-api-auth-login-post-request-11930833d0.md): - [Integracoes__api_v1_api_auth_login__POST__Response_200](https://docs.paglemon.org/integracoes-api-v1-api-auth-login-post-response-200-11930834d0.md): - [Integracoes__api_v1_integrations_credentials__GET__Response_201](https://docs.paglemon.org/integracoes-api-v1-integrations-credentials-get-response-201-11930835d0.md): - [Links_de_Pagamento__api_v1_payment_links__POST__Request](https://docs.paglemon.org/links-de-pagamento-api-v1-payment-links-post-request-11930836d0.md): - [Links_de_Pagamento__api_v1_payment_links__POST__Response_201](https://docs.paglemon.org/links-de-pagamento-api-v1-payment-links-post-response-201-11930837d0.md): - [Links_de_Pagamento__api_v1_payment_links__GET__Response_200](https://docs.paglemon.org/links-de-pagamento-api-v1-payment-links-get-response-200-11930838d0.md): - [Pagamentos__api_v1_payments__POST__Request](https://docs.paglemon.org/pagamentos-api-v1-payments-post-request-11930839d0.md): - [Pagamentos__api_v1_payments__POST__Response_200](https://docs.paglemon.org/pagamentos-api-v1-payments-post-response-200-11930840d0.md): - [Pagamentos__api_v1_payments_By_id__GET__Response_200](https://docs.paglemon.org/pagamentos-api-v1-payments-by-id-get-response-200-11930841d0.md): - [Default__api_v1_withdrawals__POST__Request](https://docs.paglemon.org/default-api-v1-withdrawals-post-request-11930842d0.md): - [Default__api_v1_withdrawals__POST__Response_201](https://docs.paglemon.org/default-api-v1-withdrawals-post-response-201-11930843d0.md): - [Default__api_v1_withdrawals__GET__Response_200](https://docs.paglemon.org/default-api-v1-withdrawals-get-response-200-11930844d0.md): - [Usuarios__api_v1_users__POST__Request](https://docs.paglemon.org/usuarios-api-v1-users-post-request-11930845d0.md): - [Usuarios__api_v1_users_By_id__GET__Response_200](https://docs.paglemon.org/usuarios-api-v1-users-by-id-get-response-200-11930846d0.md): - [Usuarios__api_v1_users_By_id__PATCH__Request](https://docs.paglemon.org/usuarios-api-v1-users-by-id-patch-request-11930847d0.md): - [Usuarios__api_v1_users_By_id_password__PATCH__Request](https://docs.paglemon.org/usuarios-api-v1-users-by-id-password-patch-request-11930848d0.md): - [Saldo__api_v1_seller_balances_me__GET__Response_200](https://docs.paglemon.org/saldo-api-v1-seller-balances-me-get-response-200-11930849d0.md): - [Clientes__api_v1_customers__POST__Request](https://docs.paglemon.org/clientes-api-v1-customers-post-request-11930850d0.md): - [Clientes__api_v1_customers__POST__Response_201](https://docs.paglemon.org/clientes-api-v1-customers-post-response-201-11930851d0.md): - [Clientes__api_v1_customers__GET__Response_200](https://docs.paglemon.org/clientes-api-v1-customers-get-response-200-11930852d0.md): - [Webhooks__api_v1_seller_webhooks__POST__Request](https://docs.paglemon.org/webhooks-api-v1-seller-webhooks-post-request-11930853d0.md): - [Webhooks__api_v1_seller_webhooks__POST__Response_201](https://docs.paglemon.org/webhooks-api-v1-seller-webhooks-post-response-201-11930854d0.md): - [Status__Root__GET__Response_200](https://docs.paglemon.org/status-root-get-response-200-11930855d0.md): - [Status__api_v1_status__GET__Response_200](https://docs.paglemon.org/status-api-v1-status-get-response-200-11930856d0.md): - [Error_Unauthorized](https://docs.paglemon.org/error-unauthorized-11930857d0.md): - [Error_Standard](https://docs.paglemon.org/error-standard-11930858d0.md):