Versões comparadas

Chave

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

Índice

01. 

...

VISIÓN GENERAL

Devolver información de bancos y sus saldos bancarios

...

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

02. ENDPOINT

O método Método utilizado:POST

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

03. 

...

PARÁMETROS DE LA SOLICITUD

Parámetros del

...

Parâmetros do body:

Atributo

TipoDescrição

Descripción

PadrãoEstándar

branchesarrayfiliais do sistema para considerar na consulta

sucursales del sistema para considerar en la consulta

-
banksarray

(opcional) bancos

a serem considerados na busca

que se considerarán en la búsqueda

todos
invertedlogical

(opcional) define

se os bancos a serem considerados terão um conceito invertido, caso true os bancos recebidos serão desconsiderados na busca

si los bancos que se considerarán tendrán un concepto invertido, si fuera true los bancos recibidos no se considerarán en la búsqueda

false
referenceDatedata

(

opicional

opcional)

data de referência do Saldo Bancáriodata atual

fecha de referencia del saldo bancario

facha actual
pagenumeric

(opcional) número

da

de la página

1
limitnumeric

(opcional)

limite

límite de bancos por página

todos

ExemploEjemplo:
body

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. 

...

RESPUESTA DE LA API

Objeto Json

Atributo

Tipo

DescriçãoDescripción

itemsArraylista de Bancos
hasNextLogicaltrue se existir nova si existiera nueva página

Lista de Camposcampos

Atributo

DescriçãoDescripción

idA6_COD
agencyA6_AGENCIA
accountA6_NUMCON
nameA6_NOME
balanceE8_SALATUA


ExemploEjemplo:
response

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