Usando a Secret Key Retornada

A Secret Key recebida no response pertence a conta recem-criada e pode ser usada imediatamente no header x-api-key de qualquer endpoint do gateway. Exemplo gerando uma transacao PIX em nome dessa conta:

Consulte a documentacao completa do gateway para a lista de endpoints disponiveis (transacoes, saques, split de pagamento, webhooks).

Autentica uma conta com e-mail e senha e retorna a Secret Key da conta. Util quando a Secret Key original foi perdida, ou quando voce precisa recupera-la apos o cliente ter definido a senha. Se a conta ainda nao tiver nenhuma chave ativa, uma nova e gerada e retornada.

POST /api/v1/v1-lumopay/accounts/login

Headers

Header	Valor	Obrigatorio
`x-api-key`	Secret Key do parceiro	Sim
`Content-Type`	`application/json`	Sim

Body (JSON)

Campo	Tipo	Obrigatorio	Descricao
`email`	`string`	Sim	E-mail da conta.
`password`	`string`	Sim	Senha da conta, definida pelo cliente via `set_password_url`.

Exemplo de Requisicao

cURL:

Body (JSON):

{
  "email": "[email protected]",
  "password": "senhaDoClienteDefinidaNoSetPassword"
}

Resposta de Sucesso

200 — Secret Key retornada.

{
  "status": "success",
  "message": "Autenticacao bem-sucedida.",
  "data": {
    "account_id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
    "name": "Joao Silva",
    "email": "[email protected]",
    "api_key": {
      "id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
      "name": "API Partner",
      "secret_key": "f2aae0788c108dea1d2332ceb2d4c75446fb1db7666280a1...",
      "created_at": "2026-04-28T12:00:00.000Z",
      "created_now": false
    }
  }
}

O campo api_key.created_now indica se a chave foi gerada agora (true, quando a conta nao tinha nenhuma ativa) ou recuperada de uma ja existente (false). A Secret Key pode ser consultada novamente pelo mesmo login enquanto estiver ativa.

Respostas de Erro

`401` — Credenciais invalidas

{
  "statusCode": 401,
  "message": "Credenciais invalidas"
}

`403` — Parceiro sem permissao ou conta inativa

{
  "statusCode": 403,
  "message": "Conta sem permissao para autenticar contas via API"
}

`429` — Muitas tentativas

{
  "statusCode": 429,
  "message": "Muitas tentativas falhas. Tente novamente em 15 minuto(s)."
}

Usando a Secret Key Retornada

Endpoint — Login e Recuperacao de Secret Key#

Headers#

Body (JSON)#

Exemplo de Requisicao#

Resposta de Sucesso#

Respostas de Erro#

401 — Credenciais invalidas#

403 — Parceiro sem permissao ou conta inativa#

429 — Muitas tentativas#

Endpoint — Login e Recuperacao de Secret Key