get http://{{auth_server_host}}/banking/issuer/billing-funding-groups
Esse endpoint permite listar todas os grupos de faturamento cadastrados para o Emissor. É possível realizar filtros para restringir os dados retornados ou trocar de página caso o Emissor possua vários registros associadas a ele.
Parâmetros da URL (opcionais)
id(string/uuid v4) : Identificador do cadastro do Financiador a ser filtrado.
page(int): Número da página a ser buscada em caso de retorno com paginação.
size(int): Quantidade de registros a serem retornados na página.
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:
content: Um objeto contendo uma lista de itens. Dependendo da quantidade de registros esse objeto será retornado paginado.
total_pages: O número total de páginas retornadas para a consulta executada.
total_elements: O número total de registros retornados.
has_next: Campo do tipo "boolean" para indicar se tem mais páginas a serem consultadas.
Objeto "content" (lista de Grupos )
id(string/uuid v4): Identificador único do cadastro do Grupo de faturamento.
fundings(object): Objeto contendo uma lista de Fundings associados 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.
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>"
}