# Xpend | API Documentation ## API Docs - Admin [Aprovar empresa](https://docs.xpend.com.br/aprovar-empresa-26056166e0.md): Endpoint para usuário administrador realizar a aprovação de uma empresa. - Admin [Listar empresas](https://docs.xpend.com.br/listar-empresas-26056167e0.md): Endpoint para usuário administrador listar todas as empresas. - Admin [Listar solicitações empresas](https://docs.xpend.com.br/listar-solicita%C3%A7%C3%B5es-empresas-26056168e0.md): Endpoint para listar todas as solicitações de empresas pendentes de aprovação. - Admin [Receitas](https://docs.xpend.com.br/receitas-26056169e0.md): - Admin [Listar todos os pagamentos](https://docs.xpend.com.br/listar-todos-os-pagamentos-26056170e0.md): Endpoint para usuário administrador listar todos os pagamentos. - Admin [Listar total de transações](https://docs.xpend.com.br/listar-total-de-transa%C3%A7%C3%B5es-26056171e0.md): Endpoint para usuário administrador obter dados de total de transações. - Admin [Listar dados de faturamento](https://docs.xpend.com.br/listar-dados-de-faturamento-26056172e0.md): Endpoint para usuário administrador obter dados de faturamento. - Admin [Aprovar saque](https://docs.xpend.com.br/aprovar-saque-26056173e0.md): Endpoint para usuário administrador realizar a aprovação de uma saque. - Admin [Listar todas solicitações de saques](https://docs.xpend.com.br/listar-todas-solicita%C3%A7%C3%B5es-de-saques-26056174e0.md): Endpoint para listar todas as solicitações de saques pendentes de aprovação. - Admin [Dashboard](https://docs.xpend.com.br/dashboard-26056175e0.md): Endpoint que obtém dados para o dashboard de saques do administrador. - Admin [Reprovar saque](https://docs.xpend.com.br/reprovar-saque-26056176e0.md): Endpoint para usuário administrador realizar a reprovação de uma saque. - Admin [Listar configurações de saques](https://docs.xpend.com.br/listar-configura%C3%A7%C3%B5es-de-saques-26056177e0.md): Endpoint para listar todas as configurações de saques dos vendedores (*seller*). - Admin [Listar configurações de saque por ID](https://docs.xpend.com.br/listar-configura%C3%A7%C3%B5es-de-saque-por-id-26056178e0.md): Endpoint para listar todas as configurações de saque de um vendedor (*seller*) específico. - Admin [Atualizar configuração de saque por ID](https://docs.xpend.com.br/atualizar-configura%C3%A7%C3%A3o-de-saque-por-id-26056179e0.md): Endpoint para atualizar as configurações de saque de um vendedor (*seller*) específico. - Admin [Listar taxas](https://docs.xpend.com.br/listar-taxas-26056180e0.md): Endpoint para usuário administrador listar todas as taxas (usuário vigente autenticado). - Admin [Listar taxa por ID](https://docs.xpend.com.br/listar-taxa-por-id-26056181e0.md): Endpoint para usuário administrador listar uma taxa por ID vendedor (*seller*). - Admin [Listar todas as transações](https://docs.xpend.com.br/listar-todas-as-transa%C3%A7%C3%B5es-26056182e0.md): Endpoint para usuário administrador listar todas as transações. - Admin [Listar administradores 🚧](https://docs.xpend.com.br/listar-administradores-26056183e0.md): - Admin [Listar configurações](https://docs.xpend.com.br/listar-configura%C3%A7%C3%B5es-26056184e0.md): Endpoint para listar as configurações dos vendedores (*seller*). - Admin [Listar configurações por ID](https://docs.xpend.com.br/listar-configura%C3%A7%C3%B5es-por-id-26056185e0.md): Endpoint para listar as configurações dos vendedores (*seller*). - Admin [Atualizar configurações](https://docs.xpend.com.br/atualizar-configura%C3%A7%C3%B5es-26056186e0.md): Endpoint para atualzar as configurações dos vendedores (*seller*). - Default [Criar uma taxa](https://docs.xpend.com.br/criar-uma-taxa-26056187e0.md): Endpoint para usuário administrador criar uma taxa (usuário vigente autenticado). - Default [Atualizar uma taxa](https://docs.xpend.com.br/atualizar-uma-taxa-26056188e0.md): Endpoint para usuário administrador atualizar parâmetros de taxa existente (usuário vigente autenticado). - Default [Criar saque 🚧](https://docs.xpend.com.br/criar-saque-26056189e0.md): Endpoint para criar um novo registro de saque. - Default [Listar todos saques](https://docs.xpend.com.br/listar-todos-saques-26056190e0.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. - Default [Obter saque por ID](https://docs.xpend.com.br/obter-saque-por-id-26056191e0.md): Retorna os detalhes de um saque específico pelo seu ID. - Default [Listar taxas](https://docs.xpend.com.br/listar-taxas-26056192e0.md): Endpoint para usuários verem suas próprias taxas (usuário vigente autenticado). - Default [Listar todas as transações](https://docs.xpend.com.br/listar-todas-as-transa%C3%A7%C3%B5es-26056193e0.md): Endpoint para listar todas as transações. - Default [Obter transações por ID](https://docs.xpend.com.br/obter-transa%C3%A7%C3%B5es-por-id-26056194e0.md): Endpoint para buscar por uma transação específica. - Autenticação [Registro de usuário](https://docs.xpend.com.br/registro-de-usu%C3%A1rio-26056195e0.md): Endpoint para criar um novo usuário. - Autenticação [Login](https://docs.xpend.com.br/login-26056196e0.md): Endpoint que autentica um usuário e retorna tokens de acesso para usuário realizar login. - Autenticação [Refresh token](https://docs.xpend.com.br/refresh-token-26056197e0.md): Endpoint para atualizar um token de acesso expirado usando um refresh token. - Dashboard [Resumo](https://docs.xpend.com.br/resumo-26056198e0.md): Endpoint para retornar dados sobre receitas. - Empresas [Criar empresa](https://docs.xpend.com.br/criar-empresa-26056199e0.md): Endpoint para criar uma nova empresa associada ao usuário autenticado. - Empresas [Atualizar empresa](https://docs.xpend.com.br/atualizar-empresa-26056200e0.md): Endpoint para atualizar os dados da empresa associada ao usuário autenticado. - Empresas [Excluir empresa](https://docs.xpend.com.br/excluir-empresa-26056201e0.md): Endpoint para excluir a empresa associada ao usuário autenticado (_soft delete_). - Empresas [Enviar documentos](https://docs.xpend.com.br/enviar-documentos-26056202e0.md): Endpoint para enviar imagem dos documentos. - Empresas [Atualizar documentos](https://docs.xpend.com.br/atualizar-documentos-26056203e0.md): Endpoint para atualizar algum dos documentos. - Empresas [Listar empresas](https://docs.xpend.com.br/listar-empresas-26056204e0.md): Endpoint para obter dados da empresa associada ao usuário autenticado. - Integrações [Login API](https://docs.xpend.com.br/login-api-26056205e0.md): Endpoint para se autenticar usando API Key e o API Secret. - Integrações [Obter credenciais](https://docs.xpend.com.br/obter-credenciais-26056206e0.md): Endpoint para gerar credenciais. - Integrações [Atualizar credenciais](https://docs.xpend.com.br/atualizar-credenciais-26056207e0.md): Endpoint para atualizar credenciais. - Links de Pagamento [Criar link de pagamento](https://docs.xpend.com.br/criar-link-de-pagamento-26056208e0.md): Endpoint para criar um novo link de pagamento. - Links de Pagamento [Listar links de pagamento](https://docs.xpend.com.br/listar-links-de-pagamento-26056209e0.md): Endpoint para listar links de pagamento. - Links de Pagamento [Obter link de pagamento pelo hash](https://docs.xpend.com.br/obter-link-de-pagamento-pelo-hash-26056210e0.md): - Links de Pagamento [Excluir link de pagamento](https://docs.xpend.com.br/excluir-link-de-pagamento-26056211e0.md): - Pagamentos [Criar novo pagamento](https://docs.xpend.com.br/criar-novo-pagamento-26056212e0.md): Endpoint para criar uma nova solicitação de pagamento. - Pagamentos [Listar pagamentos](https://docs.xpend.com.br/listar-pagamentos-26056213e0.md): Endpoint para listar todos os pagamentos somente do vendedor logado. - Pagamentos [Listar pagamento por ID](https://docs.xpend.com.br/listar-pagamento-por-id-26056214e0.md): Endpoint para listar pagamento pelo ID. - Usuários [Criar usuário](https://docs.xpend.com.br/criar-usu%C3%A1rio-26056215e0.md): Endpoint para criar novo usuário. - Usuários [Listar usuário por ID](https://docs.xpend.com.br/listar-usu%C3%A1rio-por-id-26056216e0.md): Endpoint para buscar um usuário específico pelo seu ID. - Usuários [Atualizar usuário](https://docs.xpend.com.br/atualizar-usu%C3%A1rio-26056217e0.md): Endpoint para atualizar dados de um usuário existente. - Usuários [Excluir usuário](https://docs.xpend.com.br/excluir-usu%C3%A1rio-26056218e0.md): Endpoint para excluir usuário existente. - Usuários [Atualizar senha](https://docs.xpend.com.br/atualizar-senha-26056219e0.md): Endpoint para atualizar somente a senha de um usuário. - Saldo [Obter saldo](https://docs.xpend.com.br/obter-saldo-26056220e0.md): Endpoint que lista informações de saldo do usuário autenticado (*seller*). - Clientes [Criar novo cliente vendedor](https://docs.xpend.com.br/criar-novo-cliente-vendedor-26056221e0.md): Endpoint para criar um novo cliente vendedor. - Clientes [Listar clientes vendedores](https://docs.xpend.com.br/listar-clientes-vendedores-26056222e0.md): Endpoint para listar todos clientes vendedores. - Clientes [Obter um cliente vendedor por ID](https://docs.xpend.com.br/obter-um-cliente-vendedor-por-id-26056223e0.md): Endpoint para buscar por uma cliente vendedor específico. - Clientes [Atualizar cliente vendedor](https://docs.xpend.com.br/atualizar-cliente-vendedor-26056224e0.md): Endpoint para atualizar por uma cliente vendedor específico. - Webhooks [Criar webhook](https://docs.xpend.com.br/criar-webhook-26056225e0.md): Endpoint para criar um novo Webhook. - Webhooks [Listar webhooks](https://docs.xpend.com.br/listar-webhooks-26056226e0.md): Endpoint para listar todos os Webooks do vendedor (*seller*). - Webhooks [Excluir webhook](https://docs.xpend.com.br/excluir-webhook-26056227e0.md): Endpoint para excluir o Webhook. - Status [Eventos de saque (exemplos)](https://docs.xpend.com.br/eventos-de-saque-exemplos-26056228e0.md): Estruturas dos *payloads* (JSON) dos eventos de saque. - Status [Status](https://docs.xpend.com.br/status-26056229e0.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.xpend.com.br/admin-api-v1-admin-enterprises-by-id-post-response-200-11880865d0.md): - [Admin__api_v1_admin_enterprises_By_id__POST__Response_400](https://docs.xpend.com.br/admin-api-v1-admin-enterprises-by-id-post-response-400-11880866d0.md): - [Admin__api_v1_admin_enterprises__GET__Response_200](https://docs.xpend.com.br/admin-api-v1-admin-enterprises-get-response-200-11880867d0.md): - [Admin__api_v1_admin_enterprises__GET__Response_401](https://docs.xpend.com.br/admin-api-v1-admin-enterprises-get-response-401-11880868d0.md): - [Admin__api_v1_admin_enterprises_request__GET__Response_200](https://docs.xpend.com.br/admin-api-v1-admin-enterprises-request-get-response-200-11880869d0.md): - [Admin__api_v1_admin_enterprises_revenue__GET__Response_200](https://docs.xpend.com.br/admin-api-v1-admin-enterprises-revenue-get-response-200-11880870d0.md): - [Admin__api_v1_admin_payments__GET__Response_200](https://docs.xpend.com.br/admin-api-v1-admin-payments-get-response-200-11880871d0.md): - [Admin__api_v1_admin_payments_total_transactions__GET__Response_200](https://docs.xpend.com.br/admin-api-v1-admin-payments-total-transactions-get-response-200-11880872d0.md): - [Admin__api_v1_admin_payments_billing__GET__Response_200](https://docs.xpend.com.br/admin-api-v1-admin-payments-billing-get-response-200-11880873d0.md): - [Admin__api_v1_admin_withdrawals_request__GET__Response_200](https://docs.xpend.com.br/admin-api-v1-admin-withdrawals-request-get-response-200-11880874d0.md): - [Admin__api_v1_admin_withdrawals_dashboard__GET__Response_200](https://docs.xpend.com.br/admin-api-v1-admin-withdrawals-dashboard-get-response-200-11880875d0.md): - [Admin__api_v1_admin_withdrawal_configs_By_sellerId__GET__Response_200](https://docs.xpend.com.br/admin-api-v1-admin-withdrawal-configs-by-sellerid-get-response-200-11880876d0.md): - [Admin__api_v1_admin_withdrawal_configs_By_sellerId__PUT__Request](https://docs.xpend.com.br/admin-api-v1-admin-withdrawal-configs-by-sellerid-put-request-11880877d0.md): - [Default__api_v1_fees__POST__Request](https://docs.xpend.com.br/default-api-v1-fees-post-request-11880878d0.md): - [Default__api_v1_fees__POST__Response_201](https://docs.xpend.com.br/default-api-v1-fees-post-response-201-11880879d0.md): - [Admin__api_v1_admin_fees__GET__Response_200](https://docs.xpend.com.br/admin-api-v1-admin-fees-get-response-200-11880880d0.md): - [Default__api_v1_fees_By_id__PUT__Response_200](https://docs.xpend.com.br/default-api-v1-fees-by-id-put-response-200-11880881d0.md): - [Admin__api_v1_admin_members__GET__Response_200](https://docs.xpend.com.br/admin-api-v1-admin-members-get-response-200-11880882d0.md): - [Admin__api_v1_admin_reserve_configs__GET__Response_200](https://docs.xpend.com.br/admin-api-v1-admin-reserve-configs-get-response-200-11880883d0.md): - [Admin__api_v1_admin_reserve_configs_By_sellerId__GET__Response_200](https://docs.xpend.com.br/admin-api-v1-admin-reserve-configs-by-sellerid-get-response-200-11880884d0.md): - [Admin__api_v1_admin_reserve_configs_By_sellerId__PUT__Request](https://docs.xpend.com.br/admin-api-v1-admin-reserve-configs-by-sellerid-put-request-11880885d0.md): - [Autenticacao__api_v1_auth_register__POST__Request](https://docs.xpend.com.br/autenticacao-api-v1-auth-register-post-request-11880886d0.md): - [Autenticacao__api_v1_auth_register__POST__Response_201](https://docs.xpend.com.br/autenticacao-api-v1-auth-register-post-response-201-11880887d0.md): - [Autenticacao__api_v1_auth_register__POST__Response_400](https://docs.xpend.com.br/autenticacao-api-v1-auth-register-post-response-400-11880888d0.md): - [Autenticacao__api_v1_auth_login__POST__Request](https://docs.xpend.com.br/autenticacao-api-v1-auth-login-post-request-11880889d0.md): - [Autenticacao__api_v1_auth_login__POST__Response_200](https://docs.xpend.com.br/autenticacao-api-v1-auth-login-post-response-200-11880890d0.md): - [Autenticacao__api_v1_auth_refresh__POST__Request](https://docs.xpend.com.br/autenticacao-api-v1-auth-refresh-post-request-11880891d0.md): - [Autenticacao__api_v1_auth_refresh__POST__Response_200](https://docs.xpend.com.br/autenticacao-api-v1-auth-refresh-post-response-200-11880892d0.md): - [Dashboard__api_v1_dashboard_overview__GET__Response_200](https://docs.xpend.com.br/dashboard-api-v1-dashboard-overview-get-response-200-11880893d0.md): - [Empresas__api_v1_enterprises__POST__Request](https://docs.xpend.com.br/empresas-api-v1-enterprises-post-request-11880894d0.md): - [Empresas__api_v1_enterprises__POST__Response_201](https://docs.xpend.com.br/empresas-api-v1-enterprises-post-response-201-11880895d0.md): - [Empresas__api_v1_enterprises__PATCH__Response_200](https://docs.xpend.com.br/empresas-api-v1-enterprises-patch-response-200-11880896d0.md): - [Empresas__api_v1_enterprises__DELETE__Response_204](https://docs.xpend.com.br/empresas-api-v1-enterprises-delete-response-204-11880897d0.md): - [Empresas__api_v1_enterprises_By_id__POST__Request](https://docs.xpend.com.br/empresas-api-v1-enterprises-by-id-post-request-11880898d0.md): - [Empresas__api_v1_enterprises_By_id__POST__Response_400](https://docs.xpend.com.br/empresas-api-v1-enterprises-by-id-post-response-400-11880899d0.md): - [Empresas__api_v1_enterprises_By_id_documents_By_type__PATCH__Request](https://docs.xpend.com.br/empresas-api-v1-enterprises-by-id-documents-by-type-patch-request-11880900d0.md): - [Empresas__api_v1_enterprises_By_id_documents_By_type__PATCH__Response_200](https://docs.xpend.com.br/empresas-api-v1-enterprises-by-id-documents-by-type-patch-response-200-11880901d0.md): - [Integracoes__api_v1_api_auth_login__POST__Request](https://docs.xpend.com.br/integracoes-api-v1-api-auth-login-post-request-11880902d0.md): - [Integracoes__api_v1_api_auth_login__POST__Response_200](https://docs.xpend.com.br/integracoes-api-v1-api-auth-login-post-response-200-11880903d0.md): - [Integracoes__api_v1_integrations_credentials__GET__Response_201](https://docs.xpend.com.br/integracoes-api-v1-integrations-credentials-get-response-201-11880904d0.md): - [Links_de_Pagamento__api_v1_payment_links__POST__Request](https://docs.xpend.com.br/links-de-pagamento-api-v1-payment-links-post-request-11880905d0.md): - [Links_de_Pagamento__api_v1_payment_links__POST__Response_201](https://docs.xpend.com.br/links-de-pagamento-api-v1-payment-links-post-response-201-11880906d0.md): - [Links_de_Pagamento__api_v1_payment_links__GET__Response_200](https://docs.xpend.com.br/links-de-pagamento-api-v1-payment-links-get-response-200-11880907d0.md): - [Pagamentos__api_v1_payments__POST__Request](https://docs.xpend.com.br/pagamentos-api-v1-payments-post-request-11880908d0.md): - [Pagamentos__api_v1_payments__POST__Response_200](https://docs.xpend.com.br/pagamentos-api-v1-payments-post-response-200-11880909d0.md): - [Pagamentos__api_v1_payments_By_id__GET__Response_200](https://docs.xpend.com.br/pagamentos-api-v1-payments-by-id-get-response-200-11880910d0.md): - [Default__api_v1_withdrawals__POST__Request](https://docs.xpend.com.br/default-api-v1-withdrawals-post-request-11880911d0.md): - [Default__api_v1_withdrawals__POST__Response_201](https://docs.xpend.com.br/default-api-v1-withdrawals-post-response-201-11880912d0.md): - [Default__api_v1_withdrawals__GET__Response_200](https://docs.xpend.com.br/default-api-v1-withdrawals-get-response-200-11880913d0.md): - [Usuarios__api_v1_users__POST__Request](https://docs.xpend.com.br/usuarios-api-v1-users-post-request-11880914d0.md): - [Usuarios__api_v1_users_By_id__GET__Response_200](https://docs.xpend.com.br/usuarios-api-v1-users-by-id-get-response-200-11880915d0.md): - [Usuarios__api_v1_users_By_id__PATCH__Request](https://docs.xpend.com.br/usuarios-api-v1-users-by-id-patch-request-11880916d0.md): - [Usuarios__api_v1_users_By_id_password__PATCH__Request](https://docs.xpend.com.br/usuarios-api-v1-users-by-id-password-patch-request-11880917d0.md): - [Saldo__api_v1_seller_balances_me__GET__Response_200](https://docs.xpend.com.br/saldo-api-v1-seller-balances-me-get-response-200-11880918d0.md): - [Clientes__api_v1_customers__POST__Request](https://docs.xpend.com.br/clientes-api-v1-customers-post-request-11880919d0.md): - [Clientes__api_v1_customers__POST__Response_201](https://docs.xpend.com.br/clientes-api-v1-customers-post-response-201-11880920d0.md): - [Clientes__api_v1_customers__GET__Response_200](https://docs.xpend.com.br/clientes-api-v1-customers-get-response-200-11880921d0.md): - [Webhooks__api_v1_seller_webhooks__POST__Request](https://docs.xpend.com.br/webhooks-api-v1-seller-webhooks-post-request-11880922d0.md): - [Webhooks__api_v1_seller_webhooks__POST__Response_201](https://docs.xpend.com.br/webhooks-api-v1-seller-webhooks-post-response-201-11880923d0.md): - [Status__Root__GET__Response_200](https://docs.xpend.com.br/status-root-get-response-200-11880924d0.md): - [Status__api_v1_status__GET__Response_200](https://docs.xpend.com.br/status-api-v1-status-get-response-200-11880925d0.md): - [Error_Unauthorized](https://docs.xpend.com.br/error-unauthorized-11880926d0.md): - [Error_Standard](https://docs.xpend.com.br/error-standard-11880927d0.md):