Consultar um Grupo de Faturamento

get https://sandbox.auth.flowfinance.com.br/banking/issuer/billing-funding-groups/{funding_group_id}

Esse endpoint permite consultar os dados de configuração de um determinado grupo de faturamento.

Parâmetros da URL

funding_group_id (string): ID do grupo de faturamento a ser consultado.

Parâmetros da Requisição

Não é necessário o envio de nenhum dado no corpo da requisição.

Resposta

Se a requisição for processada com sucesso será retornado um status 200 e um JSON com o seguinte formato:

id (string/uuid v4): Identificador único do cadastro do Grupo de faturamento.
fundings (object): Objeto contendo uma lista de Fundings associados ao grupo.
underwriting_fees (object list): Objeto contendo uma lista de taxas de bancarização para ser aplicada ao grupo.

Objeto "fundings"

id (string/uuid v4): Identificador do Funding.
legal_name (string): A razão social da empresa.
alias (string): O nome fantasia da empresa.

Objeto "underwriting_fees"

underwriting_fees -> fee (float): Taxa a ser aplicada.
underwriting_fees -> upper_limit (float): Limite máximo para aplicação da taxa.

Exemplo de JSON:

{
    "content": [
        {
            "id": "<uuid>",
            "fundings": [
                {
                    "id": "<uuid>",
                    "legal_name": "<string>",
                    "alias": "<string>",
                    "metadata": {
                        "values": {
                            "reprehenderit_f": {
                                "value": [
                                    "<string>",
                                    "<string>"
                                ],
                                "sensitive": "<boolean>"
                            },
                            "ea_5": {
                                "value": [
                                    "<string>",
                                    "<string>"
                                ],
                                "sensitive": "<boolean>"
                            },
                            "cupidatat1a": {
                                "value": [
                                    "<string>",
                                    "<string>"
                                ],
                                "sensitive": "<boolean>"
                            }
                        }
                    }
                },
                {
                    "id": "<uuid>",
                    "legal_name": "<string>",
                    "alias": "<string>",
                    "metadata": {
                        "values": {
                            "eiusmod_d71": {
                                "value": [
                                    "<string>",
                                    "<string>"
                                ],
                                "sensitive": "<boolean>"
                            },
                            "adipisicing8": {
                                "value": [
                                    "<string>",
                                    "<string>"
                                ],
                                "sensitive": "<boolean>"
                            }
                        }
                    }
                }
            ],
            "underwriting_fees": [
                {
                    "fee": "<number>",
                    "upper_limit": "<number>"
                },
                {
                    "fee": "<number>",
                    "upper_limit": "<number>"
                }
            ],
            "created_at": "<dateTime>",
            "updated_at": "<dateTime>",
            "version": "<integer>"
        },
        {
            "id": "<uuid>",
            "fundings": [
                {
                    "id": "<uuid>",
                    "legal_name": "<string>",
                    "alias": "<string>",
                    "metadata": {
                        "values": {
                            "irure_c0e": {
                                "value": [
                                    "<string>",
                                    "<string>"
                                ],
                                "sensitive": "<boolean>"
                            }
                        }
                    }
                },
                {
                    "id": "<uuid>",
                    "legal_name": "<string>",
                    "alias": "<string>",
                    "metadata": {
                        "values": {
                            "laboris6": {
                                "value": [
                                    "<string>",
                                    "<string>"
                                ],
                                "sensitive": "<boolean>"
                            },
                            "sint_40": {
                                "value": [
                                    "<string>",
                                    "<string>"
                                ],
                                "sensitive": "<boolean>"
                            },
                            "sint_0": {
                                "value": [
                                    "<string>",
                                    "<string>"
                                ],
                                "sensitive": "<boolean>"
                            }
                        }
                    }
                }
            ],
            "underwriting_fees": [
                {
                    "fee": "<number>",
                    "upper_limit": "<number>"
                },
                {
                    "fee": "<number>",
                    "upper_limit": "<number>"
                }
            ],
            "created_at": "<dateTime>",
            "updated_at": "<dateTime>",
            "version": "<integer>"
        }
    ],
    "total_pages": "<integer>",
    "total_elements": "<long>",
    "has_next": "<boolean>"
}

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox.auth.flowfinance.com.br/banking/issuer/billing-funding-groups/funding_group_id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200OK

403Forbidden