NGF - FINA710 - Endpoint Banks

branches

array

system branches to be considered in the query

-

banks

array

(optional) banks to be considered in the search

all

inverted

logical

(optional) defines if the banks to be considered will have an inverted concept. If true, the banks received will be ignored in the search

false

referenceDate

data

(optional) reference date of the bank balance

current date

page

numeric

(optional) page number

1

limit

numeric

(optional) limit of banks per page

all

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

items

Array

list of banks

hasNext

Logical

true if there is a new page

id

A6_COD

agency

A6_AGENCIA

account

A6_NUMCON

name

A6_NOME

balance

E8_SALATUA

{
    "hasNext": false,
    "items": [
        {
            "id": "000",
            "agency": "00000",
            "account": "0000000000",
            "name": "BANK 0000000000",
            "balance": -271317.25
        },
        {
            "id": "001",
            "agency": "00001",
            "account": "0000000001",
            "name": "BANK 0000000001",
            "balance": 123.45
        },
        {
            "id": "002",
            "agency": "00002",
            "account": "0000000002",
            "name": "BANK 0000000002",
            "balance": 16563.02
        }
    ]
}