Criação de tarifa pontual

Esse endpoint possibilita a criação de tarifa pontual

Requisição(Request)

Requisição HTTP

POST https://sandbox.hiperbanco.com.br/Tariffs/create

--request POST 'https://sandbox.hiperbanco.com.br/Tariffs/create' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
   "account": "297453",
   "amount": 1,
   "description": "Teste",
   "applyImmediately": true
}'

--request POST 'https://sandbox.hiperbanco.com.br/Tariffs/create' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
    "account": "297453",
    "amount": 2,
    "description": "Tarifa Pontual",
    "duedate": "2025-09-25",
    "applyImmediately": false
}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`accounts`	`string`	Obrigatório. Número da conta que será feito a tarifa
`amount`	`number`	Obrigatório. Valor da transação
`description`	`string`	Descrição da Tarifa Pontual.
`applyImmediately`	`boolean`	Obrigatório. Indica se o débito da tarifa será realizado de forma imediata ou programada.
`duedate`	`string`	Define a data em que a cobrança da Tarifa Pontual deverá ser executada. Observação: Este campo é obrigatório quando a propriedade `applyImmediately` tiver o valor de `false`. Caso a cobrança seja imediata, não deverá ser enviado esta propriedade. Formato: YYYY-MM-DD

{
   "account": "297453",
   "amount": 1,
   "description": "Tarifa Pontual",
   "applyImmediately": true
}

{
    "account": "297453",
    "amount": 2,
    "description": "Tarifa Pontual",
    "applyImmediately": false,
    "duedate": "2025-09-25"
}

Resposta (Response)

O status code 200 indicará sucesso na requisição.

⚠️
Importante
O sucesso na requisição não significa que a transação já tenha acontecido.

Sendo bem-sucedido, o retorno irá trazer o seguinte campo em formato JSON:

Nome	Tipo	Descrição
`status`	`number`	Código HTTP que indica o resultado da requisição.
`data`	`string`	Mensagem de retorno informando que a tarifa foi cobrada com êxito.

{
    "status": 200,
    "data": "Tarifa cobrada com sucesso"
}

Erros

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

Status code	Código	Mensagem	Descrição
`404`	`CLIENT_NOT_FOUND`	Client not found with ID	Cliente não encontrado com o ID informado. Observação: Para este erro, gentileza entrar em contato com o suporte através do Service Desk
`404`	`ACCOUNT_NOT_FOUND`	Account not found with number	Conta não encontrada
`404`	`RECEIPT_ACCOUNT_NOT_FOUND`	Receipt account not found.	Conta de recebimento não encontrada. Observação: Para este erro, gentileza entrar em contato com o suporte através do Service Desk
`422`	`INSUFFICIENT_BALANCE`	The account has insufficient balance.	A conta possui saldo insuficiente.
`422`	`INVALID_TARIFF_DUE_DATE`	Invalid tariff's due date.	Data de vencimento da tarifa inválida A data está fora do formato esperado ou é anterior à data atual.

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.

Updated about 1 month ago