Padrões de API
A API de Banking Gateway possui alguns padrões que se aplicam a múltiplas rotas.
Paginação 🗐
O objeto de paginação está presente nas rotas que listam recursos da API de Banking Gateway. As listagens não retornam todos os itens em uma resposta e por isso, usamos um método de paginação por página para elencar todos os itens encontrados.
Abaixo estão detalhados os campos desse objeto.
| Campo | Descrição | Observações |
|---|---|---|
page | Indica a página que o cliente está visualizando. | - |
per_page | Indica quantos itens estão sendo visualizados em uma página. | Esse valor é escolhido pelo cliente e pode variar entre 1 e 100. Caso esse numero não seja especificado, a API de Banking Gateway tem um padrão de exibir 10 itens por página. |
Data e Hora ⌚
Qualquer rota que precise exibir data e hora segue o mesmo padrão na API de Banking Gateway. No caso de data é dito o ano depois o mês e em segui da o dia (aaaa-mm-dd). No caso do horário é mostrada a hora seguida do minuto e segundo (hh:mm:ss), porém o horário sempre vem acompanhado da data. Para entender melhor veja o exemplo abaixo:
| Tipo | Padrão | Exemplo |
|---|---|---|
| Data | aaaa-mm-dd | 2023-05-29 |
| Data e Hora | aaaa-mm-dd hh:mm:ss | 2023-05-29 14:54:08 |
Valores 🧮
Por ser uma API bancárias em muitas rotas são inseridos valores, que precisam ser precisos. Por isso, em Banking Gateway temos o padrão de colocar o valor inteiros medido em centavos de reais (nn x 100) no campo de value. Um exemplo seria o valor de um boleto de R$210,85 que no campo de value da API de Banking Gateway seria escrito como: 21085 (210,85 x 100).
Juros e Mora
Em boleto e pix temos casos de juros e mora que possuem um calculo específico explicado no conceito desses dois tipos de transferência.
Updated 4 months ago