Agregar informações em alguns recursos
Em alguns momentos, pode ser importante agregar alguns tipos de informações em alguns recursos. Alguns exemplos são:
- Gravar um ID gerado no seu sistema para simplificar algum processo de consulta.
- Garantir que um recurso foi criado, caso a requisição sofra algum problema de rede e não retorne.
- Categorizar Contas, Ativos ou Transferências.
- Melhorar a filtragem no momento de buscar informações.
Para resolver todos esses casos, alguns recursos possuem um campo
fields, que permite salvar qualquer informação chave-valor.Evite agregar informações confidenciais neste campo. Na maioria dos casos, é preferível armazenar um hash do dado.
Todos os endpoints de busca que retornem uma lista de recursos suportam um parâmetro de query
fields, que espera um formato do tipo chave:valor. São estes os recursos que atualmente suportam esta funcionalidade:
- Conta
- Ativo
- Lote de Ações
- Boleto - Cash-in
- Boleto - Cash-out
- TED - Cash-out
No exemplo a seguir, buscamos todas as Contas que se encaixem em uma classificação específica, que pode ser definida de acordo com as suas necessidades:
get
https://api.swipetech.io/ledger
/accounts?fields=type:seller
Filtrando Contas pelo campo `fields`
A informações devem ser do tipo chave-valor, sendo que ambos devem ser do tipo
string. Portanto, não é possível salvar uma chave que contenha um objeto.Last modified 2yr ago