Detalhes da tarifa pontual

Esse endpoint exibe os detalhes de uma tarifa pontual

Requisição(Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/Tariffs/get/{id}

--request GET 'https://sandbox.hiperbanco.com.br/Tariffs/get/{id}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

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)

Nome	Tipo	Descrição
`id`	`path`	Identificador da tarifa pontual

Corpo da requisição (Body)

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

Resposta (Response)

O status code 200 indicará que a requisição foi feita com sucesso e trará um objeto contendo as informações da tarifa pontual.

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

Campo	Tipo	Descrição
`id`	`string`	Identificador da tarifa pontual
`amount`	`number`	Valor da transação
`description`	`string`	Descrição da transação
`paid`	`boolean`	Indica se a transação foi paga
`duedate`	`string`	Data de vencimento da transação
`paidAt`	`string`	Data/hora em que a transação foi paga
`createdAt`	`string`	Data de criação da transação
`updatedAt`	`string`	Data da última atualização da transação
`deletedAt`	`string`	Data de exclusão
`userAccount`	`object`	Dados da conta do usuário vinculada
`userAccount.id`	`string`	Identificador da conta
`userAccount.status`	`string`	Status da conta
`userAccount.branch`	`string`	Agência da conta
`userAccount.number`	`string`	Número da conta
`userAccount.user_transaction_night_limit`	`number`	Limite de transação noturna
`userAccount.user_transaction_limit`	`number`	Limite de transação individual
`userAccount.user_transaction_overall_limit`	`number`	Limite total de transações
`userAccount.user_transaction_night_overall_limit`	`number`	Limite total de transações noturnas
`userAccount.acceptedTermsId`	`string`	Identificador dos termos aceitos
`userAccount.termsAcceptedAt`	`string`	Data de aceite dos termos
`userAccount.createdAt`	`string`	Data de criação da conta
`userAccount.updatedAt`	`string`	Data da última atualização da conta
`userAccount.deletedAt`	`string`	Data de exclusão da conta
`userAccount.type`	`string`	Tipo da conta
`userAccount.escrowAccountEnabledAt`	`string`	Data de habilitação de conta escrow

{
    "id": "841b49a5-8451-4186-9950-6bab4280d82f",
    "amount": 1,
    "description": "Teste agendado",
    "paid": true,
    "duedate": "2025-09-25T00:00:00.000Z",
    "paidAt": "2025-09-25T03:00:19.000Z",
    "createdAt": "2025-09-24T17:15:54.639Z",
    "updatedAt": "2025-09-25T03:00:18.000Z",
    "deletedAt": null,
    "userAccount": {
        "id": "f275bfea-df78-42a6-9ef6-57531a3dc7d2",
        "status": "ACTIVE",
        "branch": "0001",
        "number": "297453",
        "user_transaction_night_limit": null,
        "user_transaction_limit": null,
        "user_transaction_overall_limit": null,
        "user_transaction_night_overall_limit": null,
        "acceptedTermsId": "aae3ada7-9c4a-4184-b46e-1ab8d8009a4b",
        "termsAcceptedAt": "2023-07-06T17:55:10.000Z",
        "createdAt": "2022-11-12T14:42:10.491Z",
        "updatedAt": "2025-09-04T13:11:07.000Z",
        "deletedAt": null,
        "type": "MAIN",
        "escrowAccountEnabledAt": null
    }
}

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.

Updated about 1 month ago