Páginas filhas
  • NGF - FINA710 - Endpoint - Banks - Configs

Versões comparadas

Chave

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

NGF - FINA710 - Endpoint - Banks - Configs

  Draft

01. OVERVIEW

Check connection, add, and list bank configurations.

02. ENDPOINT

Method used: GET
Object list of banks: /api/gfin/v1/Banks
Method used: PUT
Update configuration at the bank: /api/gfin/v1/Banks/:BankId
Method used: POST
Test connection: /api/gfin/v1/Banks/Bills/TestConnection


--------------------------v--------------------------------------------------

03. REQUEST PARAMETERS

/api/gfin/v1/Banks
Parameters: 

Attribute

Type

Description

Default

filter

character

Filter to know if a bank is configured or not

-

fields

character

The fields that must be in the return

-

Example:body

filter:A6_COD eq '001' and A6_CFGAPI ne 'S'
fields:A6_CFGBOL,A6_CFGAPI
 


filter:A6_FILIAL eq 'D MG' and A6_COD eq '001' and A6_AGENCIA eq '00001' and
A6_NUMCON eq '0000000001'
fields:A6_CFGBOL,A6_CFGAPI
 


filter:A6_FILIAL eq 'D MG' and A6_COD eq '001' and A6_AGENCIA eq '00001' and
A6_NUMCON eq '0000000001'
fields:A6_CFGBOL,A6_CFGAPI

/api/gfin/v1/Banks/D MG|001|00001|0000000001

Parameters:

Attribute

Type

Description

Default

A6_CFGAPI

character

Sets if the bank is configured or not

-

A6_CFGBOL

json

Bank configuration

-

Example:

body

{
"A6_CFGAPI":"2",
"A6_CFGBOL": "{TESTE}"
}

/api/gfin/v1/Banks/Bills/TestConnection

Parameters:

Attribute

Type

Description

Default

body

json

Credentials 

-

get

json

App key

-

url

character

Token URI

 


basic

character

Token

 


Example:body

{
"body":{"grant_type":"client_credentials",
"scope":"cobrancas.boletos-info cobrancas.boletos-requisicao"
},
"get":{"gw-dev-app-key":"d27bb77905ffab60136ee17dd0050556b991a5ba"},
"url":"https://oauth.sandbox.bb.com.br/oauth/token",
"basic":"ZXlKcFpDSTZJbVJoTVdFM1pUVXRZV0kzTXkwMFlUQTFMV0VpTENKamIyUnBaMjlRZFdKc2FXTmhaRzl5SWpvd0xDSmpiMlJwWjI5VGIyWjBkMkZ5WlNJNk1USTRPVFFzSW5ObGNYVmxibU5wWVd4SmJuTjBZV3hoWTJGdklqb3hmUTpleUpwWkNJNklqZzFORGxoTUNJc0ltTnZaR2xuYjFCMVlteHBZMkZrYjNJaU9qQXNJbU52WkdsbmIxTnZablIzWVhKbElqb3hNamc1TkN3aWMyVnhkV1Z1WTJsaGJFbHVjM1JoYkdGallXOGlPakVzSW5ObGNYVmxibU5wWVd4RGNtVmtaVzVqYVdGc0lqb3hMQ0poYldKcFpXNTBaU0k2SW1odmJXOXNiMmRoWTJGdklpd2lhV0YwSWpveE5qRXhOemd5TkRnMk5EY3hmUQ=="
}

04. API RESPONSE

/api/gfin/v1/Banks
Example:response

response

{

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1ef12c21-953c-4f21-96d6-a32efa8a6139"><ac:plain-text-body><![CDATA[

{
    "items": [
        {
            "a6_agencia": "00001",
            "a6_cfgapi": "",
            "a6_nreduz": "",
            "a6_cod": "001",
            "a6_nome": "BANK 001/00001/0000000001",
            "a6_filial": "D MG",
            "a6_cfgbol": "",
            "a6_numcon": "0000000001"
        }
    ],
    "hasNext": false,
    "struct": [
        {
            "field": "A6_FILIAL",
            "type": "C",
            "title": "Filial      "
        },
        {
            "field": "A6_COD",
            "type": "C",
            "title": "Code      "
        },
        {
            "field": "A6_AGENCIA",
            "type": "C",
            "title": "Branch no"
        },
        {
            "field": "A6_NUMCON",
            "type": "C",
            "title": "Account no  "
        },
        {
            "field": "A6_NOME",
            "type": "C",
            "title": "Bank name  "
        },
        {
            "field": "A6_NREDUZ",
            "type": "C",
            "title": "Bank sh. name"
        },
        {
            "field": "A6_CFGBOL",
            "type": "M",
            "title": "Bank slip conf"
        },
        {
            "field": "A6_CFGAPI",
            "type": "C",
            "title": "API Config  "
        }
    ]
}

]]></ac:plain-text-body></ac:structured-macro>


/api/gfin/v1/Banks/D MG|001|00001|0000000001

Example:

response

{

    "status": "Ok"

}

/api/gfin/v1/Banks/Bills/TestConnection

Example:

response

{
    "token_type": "Bearer",
    "access_token": "M2YKbZxbdPE_PQPC4GXX7aWeShaWnYJvokc5jXPm75xFDBG5TvB2s8CJJmbgCoPSuQI3rnhQkDH99lMrCBloZA.nfytrWS69SDcvwJNhoEIIIHC87br7hMMqMjrkDuAGRy685vxRd7mATf6BYEZPRJnOnT6QiAMwNULUWhnE4RxR2KmmpZhNPXCp80f6PFENOw7PMIo7b5oi1o9I63TG4PiCSQdotdZn45OFrTCZobfsHtb1Wz5HYvoDCbEeT4G1tfJKroyBbSHKq_a-O_0rN8MnduGhHSzdsW0Dx-G-TCMbYSHqXmLdmh5uB2-Zo2qSVmQMaIK5udNaZlA26gN6RjiudTltDigF1EWwvIOV7U01lHru23WYuSAeGAm_0Y9eN7wESixGzumYvcjNse_n9kqfRo6HIcmkCkPq7tspUoz1ZxCbCCET6qqAsA5xgYRNM4XnpnJz62Bqpx1X-fo7pHQvOnHwplKMIvvRyGACyHhAtu02LzLdl0TaWvwRDcCArJsa5u1wiZlwkwgPt8FuVbgVJwBUQxufNOghKK0ye4DPHp3f63RnAz3g0sUA98vp1xcb-ZlLO8iz4kpjqyNl2NiGhwPH7CgKNFPk-D5Z6J147fbonrCwunLF9nLC1U0p6Diq_3gQxQtkYDkTVUR7nI8u6-EBTrYPBHMfXtfqIl34Vx8ddALxP4R8dcaoohF36xa9f0Px-Hd7rlgAMRUpQVgqTPGhcMSTC5rNNGIzRE8QoIAucDQ3oezREjtr7qWPv1rWnKW7tj-GI6Y_X9RtwJos6ZNqynaODEGQZeFigpywbC7M1cucmJGR0hK6K7RrGLDcwb59Ke8esU5hqwdHvJ3NTA_OqLgWOohNSARz5C4iggjeOMONsTxmzbXlNBDKhq-xC_0isNUrwNN5Tf17RYlkim8TOSNG2vJP9vNbRmZBsqo_nptO_6-1y6CwwaxUDhoRn54O8EE2CkkWNYiENZZpD0FfNakeiktgNSqFLiv3ChjeFNuH3R97L8zfnbaw6IpAuloSzYeiFILhawEOVwxpCAHkWLLV94ruDd5Ee2B00cJS9GXgVPahIc26XgZruaNCiKdwFkm_LOPh6p6Onjsm7oEvHrL9aM6xKcgCjiPpRCv75H2RnlHLhXBaL1aL1c.A4O7kkWLIeqkyvgS8tPMbQSRA6hyBmjb6YkV_N_sUSvJv01FjOPDw8nqHRCvt7znG-O7TzQlrqrtYYGQc7up3Q",
    "expires_in": 600
}