/gateway/user
POST
/gateway/userRequest
Parâmetros Header
Authorization
string
opcional
Exemplo:
Bearer {Token JWT}
Parâmetros Bodyapplication/json
name
string
requerido
Exemplo: João da Silva
username
string
requerido
Exemplo: joao.silva
email
string
requerido
Exemplo: joao.silva@preambulobank.com.br
password
string
requerido
Senha de acesso.
confirmPassword
string
requerido
Confirmação da senha de acesso
pin
string
requerido
Código de 4 dígitos para realizar operações.
pixKey
string
requerido
Chave PIX.
webhookPixUrl
string
requerido
Url de webhook para receber os eventos de atualização do PIX.
Exemplo
{
"name": "string",
"username": "string",
"email": "string",
"password": "string",
"confirmPassword": "string",
"pin": "string",
"pixKey": "string",
"webhookPixUrl": "string"
}
Request samples
Respostas
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Esquema de Dados
retorno
object | null
opcional
Objeto com os dados de retorno.
name
string | null
opcional
Nome do usuário criado.
username
string | null
opcional
Usuario de acesso criado.
email
string | null
opcional
E-mail do usuário criado.
webhookChaveAcesso
string | null
opcional
Código para gerar a chave de assinatura HMAC do webhook.
alertas
array [object {2}]
opcional
mensagem
string | null
opcional
tipo
opcional
erros
array [object {4}]
opcional
mensagem
string | null
opcional
tipo
opcional
campoNome
string | null
opcional
elemento
string | null
opcional
ExemploSucesso
{
"retorno": {
"name": "string",
"username": "string",
"email": "string",
"webhookChaveAcesso": "086d98c8-f5a7-41c0-800c-193b6e5f4b45"
},
"alertas": [],
"erros": []
}
Modificado em 3 months ago