Skip to main content
GET
/
api
/
seller
curl -X GET https://api.imperiumpay.com.br/api/seller \
  -H "X-Api-Public-Key: sua_chave_publica_aqui" \
  -H "X-Api-Private-Key: sua_chave_privada_aqui" \
  -H "Content-Type: application/json"

{
  "id": 1,
  "userId": 1,
  "legalName": "João Silva",
  "blocked": false,
  "invoiceDescriptor": "João",
  "commercialName": null,
  "createdAt": "2024-01-15T10:00:00.000Z",
  "uploadedDocuments": true,
  "user": {
    "id": 1,
    "email": "joao@exemplo.com",
    "phone": "11999999999",
    "name": "João Silva",
    "isEmailVerified": true,
    "isPhoneVerified": false,
    "isAdmin": false,
    "isMaster": false,
    "createdAt": "2024-01-15T10:00:00.000Z"
  },
  "document": {
    "id": 1,
    "number": "12345678900",
    "type": "cpf"
  },
  "permissions": {
    "isCreditCardAvailable": true,
    "isBoletoAvailable": true,
    "isPixAvailable": true,
    "transferEnabled": true,
    "transferPriceCents": 0,
    "anticipationEnabled": false,
    "anticipatableVolumePercentage": 0,
    "anticipationPricePercent": 0,
    "minAnticipatableDays": 0
  },
  "details": {
    "averageRevenue": 0,
    "averageTicket": 0,
    "physicalProducts": false,
    "productsDescription": null,
    "siteUrl": null,
    "phone": null,
    "email": null
  },
  "legalRepresentative": null,
  "address": {
    "street": "Rua Exemplo",
    "streetNumber": "100",
    "zipCode": "01310100",
    "neighborhood": "Centro",
    "city": "São Paulo",
    "state": "SP",
    "country": "Brasil"
  },
  "revenue": {
    "totalAmount": 150000,
    "totalCount": 10,
    "cardAmount": 100000,
    "cardCount": 8,
    "pixAmount": 50000,
    "pixCount": 2,
    "boletoAmount": 0,
    "boletoCount": 0,
    "chargebackAmount": 0,
    "chargebackCount": 0,
    "refundAmount": 0,
    "refundCount": 0
  },
  "defaultRecipient": {
    "id": 1,
    "legalName": "João Silva",
    "document": { "number": "12345678900", "type": "cpf" },
    "transferSettings": {},
    "balance": {
      "available": 3153900,
      "updatedAt": "2024-02-01T12:00:00.000Z"
    }
  }
}
Retorna os dados completos da conta do seller autenticado pelas chaves de API (X-Api-Public-Key e X-Api-Private-Key). Inclui dados cadastrais, permissões, endereço, representante legal, receita por método de pagamento e saldo do recipient padrão.

​
Autenticação

Este endpoint requer autenticação via API Keys (mesmo esquema do saldo e transações):
​
X-Api-Public-Key
string
required
Sua chave pública da API
​
X-Api-Private-Key
string
required
Sua chave privada da API

​
Exemplo de Requisição

curl -X GET https://api.imperiumpay.com.br/api/seller \
  -H "X-Api-Public-Key: sua_chave_publica_aqui" \
  -H "X-Api-Private-Key: sua_chave_privada_aqui" \
  -H "Content-Type: application/json"

​
Estrutura da Resposta

A resposta inclui os seguintes blocos principais:
​
id
integer
required
ID do usuário seller
​
userId
integer
required
ID do usuário (igual a id)
​
legalName
string
required
Nome legal ou razão social (KYC ou nome do usuário)
​
user
object
required
Dados do usuário: id, email, phone, name, isEmailVerified, isPhoneVerified, isAdmin, isMaster, createdAt
​
document
object
Documento (CPF/CNPJ): id, number, type (cpf | cnpj). Pode ser null se não cadastrado
​
permissions
object
required
Permissões e configurações: isCreditCardAvailable, isBoletoAvailable, isPixAvailable, transferEnabled, transferPriceCents, anticipationEnabled, anticipatableVolumePercentage, anticipationPricePercent, minAnticipatableDays
​
details
object
Detalhes comerciais: averageRevenue, averageTicket, physicalProducts, productsDescription, siteUrl, phone, email
​
address
object
Endereço: street, streetNumber, zipCode, neighborhood, city, state, country. Pode ser null
​
revenue
object
required
Receita agregada: totalAmount/totalCount (centavos), cardAmount/cardCount, pixAmount/pixCount, boletoAmount/boletoCount, chargebackAmount/chargebackCount, refundAmount/refundCount
​
defaultRecipient
object
required
Recipient padrão: id, legalName, document, transferSettings, balance (available em centavos, updatedAt)
​
blocked
boolean
required
Se a conta está bloqueada
​
createdAt
string
required
Data de criação da conta (ISO 8601)

​
Exemplo de Resposta (resumido)

{
  "id": 1,
  "userId": 1,
  "legalName": "João Silva",
  "blocked": false,
  "invoiceDescriptor": "João",
  "commercialName": null,
  "createdAt": "2024-01-15T10:00:00.000Z",
  "uploadedDocuments": true,
  "user": {
    "id": 1,
    "email": "joao@exemplo.com",
    "phone": "11999999999",
    "name": "João Silva",
    "isEmailVerified": true,
    "isPhoneVerified": false,
    "isAdmin": false,
    "isMaster": false,
    "createdAt": "2024-01-15T10:00:00.000Z"
  },
  "document": {
    "id": 1,
    "number": "12345678900",
    "type": "cpf"
  },
  "permissions": {
    "isCreditCardAvailable": true,
    "isBoletoAvailable": true,
    "isPixAvailable": true,
    "transferEnabled": true,
    "transferPriceCents": 0,
    "anticipationEnabled": false,
    "anticipatableVolumePercentage": 0,
    "anticipationPricePercent": 0,
    "minAnticipatableDays": 0
  },
  "details": {
    "averageRevenue": 0,
    "averageTicket": 0,
    "physicalProducts": false,
    "productsDescription": null,
    "siteUrl": null,
    "phone": null,
    "email": null
  },
  "legalRepresentative": null,
  "address": {
    "street": "Rua Exemplo",
    "streetNumber": "100",
    "zipCode": "01310100",
    "neighborhood": "Centro",
    "city": "São Paulo",
    "state": "SP",
    "country": "Brasil"
  },
  "revenue": {
    "totalAmount": 150000,
    "totalCount": 10,
    "cardAmount": 100000,
    "cardCount": 8,
    "pixAmount": 50000,
    "pixCount": 2,
    "boletoAmount": 0,
    "boletoCount": 0,
    "chargebackAmount": 0,
    "chargebackCount": 0,
    "refundAmount": 0,
    "refundCount": 0
  },
  "defaultRecipient": {
    "id": 1,
    "legalName": "João Silva",
    "document": { "number": "12345678900", "type": "cpf" },
    "transferSettings": {},
    "balance": {
      "available": 3153900,
      "updatedAt": "2024-02-01T12:00:00.000Z"
    }
  }
}
Valores monetários em revenue e defaultRecipient.balance.available estão em centavos (inteiros). Para converter para reais, divida por 100.

​
Códigos de Erro

​
401 Unauthorized

Não autorizado — API Key ou API Secret inválidos ou ausentes. 
{
  "error": "Não autorizado",
  "message": "Autenticação necessária. Verifique suas chaves de API."
}

​
404 Not Found

Conta não encontrada para as chaves informadas. 
{
  "error": "Conta não encontrada",
  "message": "Nenhuma conta associada às chaves de API informadas."
}

​
500 Internal Server Error

Erro interno do servidor. 
{
  "error": "Erro interno do servidor",
  "message": "Falha ao obter dados do seller. Tente novamente mais tarde."
}

​
Observações

  • Autenticação: O mesmo par de chaves usado em /api/public/balance e /api/sales deve ser usado aqui.
  • Valores em centavos: revenue.*Amount e defaultRecipient.balance.available são inteiros em centavos.
  • Campos opcionais: document, address, legalRepresentative podem ser null se não cadastrados no KYC.