Upload de logomarca do boleto

Este endpoint possibilita o envio da logomarca do parceiro para exibição no boleto.

Pré-requisito

Para que seja possível utilizar este endpoint, é necessário que:

O usuário esteja utilizando a Autenticação Gestão do Banco.

Requisição (Request)

Requisição HTTP

PUT https://sandbox.hiperbanco.com.br/dashboard/logo

curl --location --request PUT 'https://sandbox.hiperbanco.com.br/dashboard/logo' \
--header 'version: cutting-edge' \
--header 'Content-Type: multipart/form-data' \
--header 'Authorization: Bearer {{accessToken}}' \
--form 'image=@"/path/to/file"'

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Obrigatório> Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer {{accessToken}}`	Obrigatório: Token de autenticação do parceiro.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato de formulário (formData):

Nome	Tipo	Descrição
`image`	`file`	Obrigatório. Arquivo da logomarca. Formatos aceitos: `.png`, `.svg`, `.jpeg`, `.jpg`. Tamanho máximo: 3MB.

Resposta (Response)

O status code 201 indicará sucesso na operação.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`message`	`string`	Mensagem de confirmação da operação.

{
    "message": "Logo updated successfully."
}

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status Code	Código	Mensagem	Descrição
`400`	`INVALID_INPUT`	A requisição apresenta dados inválidos. Apresente este código no suporte: `código`.	Ocorre quando os parâmetros enviados não atendem às validações esperadas.
`404`	`CLIENT_NOT_FOUND`	Client not found.	Cliente não encontrado.
`422`	`FILE_MIME_TYPE_NOT_ALLOWED`	File type `tipo` is not allowed. Allowed types: image/png, image/svg, image/jpeg, image/jpg.	O tipo MIME do arquivo enviado não é permitido.
`422`	`FILE_SIZE_EXCEEDED`	File size exceeds the maximum allowed limit of 3MB.	O arquivo excede o tamanho máximo permitido de 3MB.
`422`	`INVALID_FILE_NAME`	Invalid file name. File name contains dangerous characters.	O nome do arquivo contém caracteres perigosos ou extensão não permitida.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.