Xpend | API Documentation
  1. Empresas
Xpend | API Documentation
  • Admin
    • Aprovar empresa
      POST
    • Listar empresas
      GET
    • Listar solicitações empresas
      GET
    • Receitas
      GET
    • Listar todos os pagamentos
      GET
    • Listar total de transações
      GET
    • Listar dados de faturamento
      GET
    • Aprovar saque
      POST
    • Listar todas solicitações de saques
      GET
    • Dashboard
      GET
    • Reprovar saque
      POST
    • Listar configurações de saques
      GET
    • Listar configurações de saque por ID
      GET
    • Atualizar configuração de saque por ID
      PUT
    • Listar taxas
      GET
    • Listar taxa por ID
      GET
    • Listar todas as transações
      GET
    • Listar administradores 🚧
      GET
    • Listar configurações
      GET
    • Listar configurações por ID
      GET
    • Atualizar configurações
      PUT
  • Default
    • Criar uma taxa
      POST
    • Atualizar uma taxa
      PUT
    • Criar saque 🚧
      POST
    • Listar todos saques
      GET
    • Obter saque por ID
      GET
    • Listar taxas
      GET
    • Listar todas as transações
      GET
    • Obter transações por ID
      GET
  • Autenticação
    • Registro de usuário
    • Login
    • Refresh token
  • Dashboard
    • Resumo
  • Empresas
    • Criar empresa
      POST
    • Atualizar empresa
      PATCH
    • Excluir empresa
      DELETE
    • Enviar documentos
      POST
    • Atualizar documentos
      PATCH
    • Listar empresas
      GET
  • 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
    • Listar pagamentos
    • Listar pagamento por ID
  • 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
  • Schemas
    • 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. Empresas

Criar empresa

POST
/api/v1/enterprises
Endpoint para criar uma nova empresa associada ao usuário autenticado.

💾 Estrutura de Dados#

Headers#

Content-type: application/json
Authorization: Bearer JWT_TOKEN

Body (JSON)#

PropriedadeTipoObrigatórioDescriçãoValor (exemplo)
commercialNameStringSimNome comercial da empresaJohn Doe
invoiceNameStringSimNome que aparecerá na fatura-
averageRevenueNumberSimFaturamento médio mensal.-
averageTicketStringSimTicket médio por transação-
productsServicesStringSimDescrição dos produtos/serviços-
websiteStringNãoWebsite da empresa-
contactEmailStringSimEmail de contato da empresa-
contactPhoneStringSimTelefone de contato da empresa-
sellsPhysicalProductsStringSimtrue se vende produtos físicostrue
cnpjStringSimCNPJ da empresa-
companyNameStringSimRazão social da empresa-
tradeNameStringSimNome fantasia da empresa-
phoneStringSimTelefone da empresa-
emailStringSimEmail da empresa-
addressZipCodeStringSimCEP do endereço-
addressStreetStringSimRua do endereço-
addressNumberStringSimNúmero do endereço-
addressComplementStringNãoComplemento do endereço-
addressNeighborhoodStringSimBairro do endereço-
addressCityStringSimCidade do endereço-
addressStateStringSimEstado do endereço-
legalRepNameStringSimNome do representante legal-
legalRepCpfStringSimCPF do representante legal-
legalRepRoleStringSimCargo do representante legal-
legalRepStartDateStringSimData de início do representante legal-
legalRepPhoneStringSimTelefone do representante legal-
legalRepEmailStringSimEmail do representante legal-

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Body Params application/json

Examples

Responses

🟢201
application/json
Body

🟠400
🟠401
🟠409
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://xpend-backend.onrender.com/api/v1/enterprises' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "commercialName": "Minha Loja Online",
    "invoiceName": "Minha Loja LTDA",
    "averageRevenue": 50000,
    "averageTicket": 150,
    "productsServices": "Venda de roupas e acessórios",
    "website": "https://minhaloja.com",
    "contactEmail": "contato@minhaloja.com",
    "contactPhone": "11987654321",
    "sellsPhysicalProducts": true,
    "cnpj": "79809254000105",
    "companyName": "Minha Loja LTDA",
    "tradeName": "Minha Loja",
    "phone": "1123456789",
    "email": "empresa@minhaloja.com",
    "addressZipCode": "01001000",
    "addressStreet": "Praça da Sé",
    "addressNumber": "100",
    "addressComplement": "Lado A",
    "addressNeighborhood": "Sé lorem ipsum",
    "addressCity": "São Paulo",
    "addressState": "SP",
    "legalRepName": "João da Silva",
    "legalRepCpf": "34800528003",
    "legalRepRole": "Sócio-Administrador",
    "legalRepStartDate": "2020-01-15",
    "legalRepPhone": "11912345678",
    "legalRepEmail": "joao.silva@minhaloja.com"
}'
Response Response Example
201 - Success
{
    "id": "e7e2215e-aa76-4dfc-9ab7-954810654ef9",
    "userId": "a2c7acd6-7cdd-46ba-8a55-bde40a6e78c8",
    "commercialName": "Minha Loja Online",
    "invoiceName": "Minha Loja LTDA",
    "averageRevenue": 50000,
    "averageTicket": 150,
    "productsServices": "Venda de roupas e acessórios",
    "website": "https://minhaloja.com",
    "contactEmail": "contato@minhaloja.com",
    "contactPhone": "11987654321",
    "sellsPhysicalProducts": true,
    "cnpj": "79809254000105",
    "companyName": "Minha Loja LTDA",
    "tradeName": "Minha Loja",
    "phone": "1123456789",
    "email": "empresa@minhaloja.com",
    "addressZipCode": "01001000",
    "addressStreet": "Praça da Sé",
    "addressNumber": "100",
    "addressComplement": "Lado A",
    "addressNeighborhood": "Sé lorem ipsum",
    "addressCity": "São Paulo",
    "addressState": "SP",
    "legalRepName": "João da Silva",
    "legalRepCpf": "34800528003",
    "legalRepRole": "Sócio-Administrador",
    "legalRepStartDate": "2020-01-15T00:00:00.000Z",
    "legalRepPhone": "11912345678",
    "legalRepEmail": "joao.silva@minhaloja.com",
    "createdAt": "2025-11-10T13:58:50.468Z",
    "updatedAt": "2025-11-10T13:58:50.468Z",
    "deletedAt": null,
    "documents": []
}
Modified at 2025-12-27 01:31:55
Previous
Resumo
Next
Atualizar empresa
Built with