OnnixPay

Conta

Consultar merchant

Retorna os dados da identidade comercial dona da chave de API: nome, documento, contato e situação operacional/KYC.

GET/v1/merchant

Headers

x-api-keystringobrigatório
Sua chave de API com escopo merchant:read.

Campos da resposta

typestringopcional
individual (pessoa física) ou company (pessoa jurídica).
namestringopcional
Nome de exibição (fantasia).
legal_namestringopcional
Razão social / nome completo.
documentstringopcional
CPF (11) ou CNPJ (14), só dígitos. null se ainda não cadastrado.
emailstringopcional
E-mail de contato. Pode ser null.
phonestringopcional
Telefone de contato. Pode ser null.
statusstringopcional
Situação operacional: pending, active, suspended ou closed.
kyc_statusstringopcional
Situação do KYC: pending, in_review, approved, rejected ou suspended.
created_atstringopcional
Data de criação (ISO 8601).

Conta operacional

Cobranças e pagamentos só são liquidados quando o kyc_status é approved e o status é active.
Requisição
curl https://apiv2.onnixpay.com/v1/merchant \
  -H "x-api-key: sk_live_sua_chave_aqui"
Resposta
{
  "id": "019e6ae7-7945-7c29-b346-341f14a86a7a",
  "object": "merchant",
  "type": "individual",
  "name": "Loja do João",
  "legal_name": "João Cardoso",
  "document": "62363692322",
  "email": "contato@lojadojoao.com",
  "phone": "+5585996889121",
  "status": "active",
  "kyc_status": "approved",
  "created_at": "2026-05-27T19:26:55.299Z"
}
AnteriorConsultar saldoPróximo Visão geral