Ative sua conta
Crie a senha pelo convite individual.
Ambiente realGuia do cliente · v0.9
Bem-vindo à Noryk Gateway
Seus primeiros passos.
Ative sua conta, conheça o painel e conecte seu sistema à API. Este guia reúne o que você precisa para começar.
Comece pelo convite que você recebeu.Seu link é individual, vale 24 horas e permite criar a primeira senha. Este guia é público e não substitui o convite.
Acesse o painel
Entre com seu e-mail e a nova senha.
Emita sua credencial
Defina as permissões da integração.
Conecte sua aplicação
Use a documentação e revise a operação antes do envio.
Seus acessos
Links oficiais para você e para quem desenvolve seu sistema.
Crie sua primeira senha
O administrador cadastra seu e-mail. O convite pode chegar por contato@noryk.finance ou ser compartilhado diretamente pelo responsável. A senha é escolhida por você.
- Abra o convite privado que recebeu e confira os dados da conta.
- Escolha uma senha entre 6 e 128 caracteres e confirme a mesma senha no segundo campo.
- Conclua a criação e abra o painel com seu e-mail e sua nova senha.
Convite vencido ou já usado?
Peça outro ao administrador se a conta ainda não foi ativada. Se você já criou a senha, use o login normal. Apenas abrir o link não ativa a conta.
Seu sistema, sua credencial
Emita a chave de API pelo painel
Sua senha abre o painel; a chave de API conecta o backend da sua aplicação.
- Entre em gateway.noryk.finance e abra Credenciais.
- Dê um nome à integração. O padrão inclui
readpara consulta epayments:writepara cobranças. Mantenha somente as permissões necessárias. - Confira a validade: o padrão é 30 dias, com máximo de 90. Confirme a emissão com sua senha atual.
- Guarde a chave completa, exibida uma única vez, no ambiente protegido do backend.
Não coloque a chave em frontend, grupo, prompt ou repositório. Se perder o segredo completo, revogue a credencial e emita outra. A permissão de saque pela API não vem marcada por padrão e depende de destinos e limites aprovados. No painel, informe a chave Pix de destino e confirme o valor e a tarifa conforme seu saldo.
Primeira integração
Consulte sua conta e crie uma cobrança Pix
Compartilhe a documentação com seu programador. Ele configura a chave no servidor, sem pedir sua senha.
Base da API https://gateway.noryk.finance Autenticação Authorization: Bearer SUA_CHAVE Primeiro GET /v1/me GET /v1/wallet Cobrança POST /v1/charges Idempotency-Key: CHAVE_JA_PERSISTIDA_DO_PEDIDO { "amountCents": 10000, "description": "Pedido 000001" }
10000 centavos significa R$100. No ambiente real, o Pix copia e cola retornado pelo provedor é pagável. Guarde o identificador retornado e acompanhe GET /v1/charges/{id}.
Uma resposta perdida não é um novo pedido.
Persista a Idempotency-Key antes da primeira chamada e conserve o mesmo corpo e a mesma chave ao recuperar a operação. Não repita automaticamente com outra chave. Os exemplos não fazem retry; a coleção não inclui envio de saques.
Leia sua carteira e os estados da operação
O administrador configura as tarifas da sua conta. Consulte o painel ou GET /v1/me; cada operação informa sua própria tarifa.
| O que aparece | O que significa |
|---|---|
A liberar / paid | O pagamento foi recebido, mas o líquido ainda aguarda liquidação. |
Disponível / settled | A liquidação foi confirmada. O saldo disponível fica sujeito às regras de movimentação da conta. |
| Reservado | Valor comprometido com um saque ainda sem desfecho final. |
processing / verifying | O saque está em andamento ou conferência. Não crie outro pedido para tentar resolver. |
completed / failed | Desfecho confirmado do saque. A reserva é tratada conforme o resultado comprovado. |
Os padrões iniciais são 10% por recebimento e R$10 por saque; sua conta pode ter outra condição. Alterações valem para novas operações e preservam o histórico. O acompanhamento da API é por consulta, com paginação por cursor.
Extrato: cada linha de GET /v1/ledger tem id único para persistência e deduplicação. journalId agrupa linhas da mesma movimentação e pode repetir. Percorra todas as páginas usando nextCursor. Saldos e operações de demonstração não são transferidos para a base real.
Se precisar de ajuda
Retorne ao canal em que recebeu o convite. Informe o que tentou fazer, o horário aproximado, o código do erro e o requestId, quando existir.
Não envie senha, chave completa de API ou dados desnecessários de pagadores.
Ambiente real. Recebimentos e saques movimentam dinheiro. Confira o destino, o valor e a tarifa antes de confirmar.