Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Índice

01. VISÃO GERAL

Retornar informações de bancos e seu saldo bancários

02. ENDPOINT

O método utilizado:POST

Bancos : /api/gfin/v1/Banks/Balances

03. PARÂMETROS DA REQUISIÇÃO

Parâmetros do body:

Atributo

Tipo

Descrição

Padrão

branchesarrayfiliais do sistema para considerar na consulta-
banksarray(opcional) bancos a serem considerados na buscatodos
invertedlogical(opcional) define se os bancos a serem considerados terão um conceito invertido, caso true os bancos recebidos serão desconsiderados na buscafalse
referenceDatedata(opicional) data de referência do Saldo Bancáriodata atual
pagenumeric(opcional) número da página1
limitnumeric(opcional) limite de bancos por páginatodos

...

body =
{
    "referenceDate": "2019-10-01",
    "banks": [
        {
            "id": "000",
            "agency": "00000",
            "account": "0000000000"
        },
        {
            "id": "001",
            "agency": "00001",
            "account": "0000000001"
        },
        {
            "id": "002",
            "agency": "00002",
            "account": "0000000002"
        }
    ]
}

04. RESPOSTA DA API

Objeto Json

Atributo

Tipo

Descrição

itemsArraylista de Bancos
hasNextLogicaltrue se existir nova página

...