get http://{{auth_server_host}}/banking/issuer/fundings
Esse endpoint permite listar todas os Financiadores cadastrados para o Emissor. É possível realizar filtros para restringir os dados retornados ou trocar de página caso o Emissor possua muitos Fundings cadastrados e 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 dos Financiadores cadastrados para o Emissor. 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 Fundings)
id(string uuid): Identificador único do cadastro do Funding.
taxpayer_id(string): O nº do CNPJ da empresa.
legal_name(string): A razão social da empresa.
alias(string): O nome fantasia da empresa.
email_address(string): Campo do e-mail para contato com a Empresa.
phone(objeto): Objeto contendo o número do telefone para contato com a empresa.area_code(string): Campo do código da área (DDD).
country_code(string): Código Internacional para identificação do país (DDI).
number(string): Número do telefone, somente os números.
formatted_number(string): Número do telefone formatado.
address(objeto): Objeto contendo os dados do endereço da Empresa.street_name(string): Nome do logradouro do endereço.
street_number(integer): Númeração do endereço.
extra_info(string): Campo de dados adicionais, complemento, do Endereço.
district(string): Bairro do endereço.
city(string): Cidade do endereço.
postal_code(string): Código de CEP para o endereço.
state_code(string): Sigla para identificação do estado/uf.
country_code(string): Código do país.
created_at: Data e hora que o registro do Funding foi criado.
updated_at: Data e hora da última atualização.
version: Identificador da versão do cadastro do Financiador.
Exemplo de JSON:
{
"content": [
{
"id": "<uuid>",
"legal_name": "<string>",
"taxpayer_id": "<string>",
"phone": {
"area_code": "<string>",
"country_code": "<string>",
"number": "<string>",
"formatted_number": "<string>"
},
"email_address": "<string>",
"address": {
"city": "<string>",
"country_code": "<string>",
"district": "<string>",
"postal_code": "48089799",
"state_code": "<string>",
"street_name": "<string>",
"street_number": "<integer>",
"extra_info": "<string>"
},
"relations": [
{
"person": {
"id": "<uuid>",
"full_name": "<string>",
"taxpayer_id": "<string>"
},
"signer": "<boolean>"
},
{
"person": {
"id": "<uuid>",
"full_name": "<string>",
"taxpayer_id": "<string>"
},
"signer": "<boolean>"
}
],
"metadata": {
"values": {
"in_1b": {
"value": [
"<string>",
"<string>"
],
"sensitive": "<boolean>"
},
"dolor_d2": {
"value": [
"<string>",
"<string>"
],
"sensitive": "<boolean>"
}
}
},
"created_at": "<dateTime>",
"updated_at": "<dateTime>",
"version": "<integer>",
"alias": "<string>"
},
{
"id": "<uuid>",
"legal_name": "<string>",
"taxpayer_id": "<string>",
"phone": {
"area_code": "<string>",
"country_code": "<string>",
"number": "<string>",
"formatted_number": "<string>"
},
"email_address": "<string>",
"address": {
"city": "<string>",
"country_code": "<string>",
"district": "<string>",
"postal_code": "60638577",
"state_code": "<string>",
"street_name": "<string>",
"street_number": "<integer>",
"extra_info": "<string>"
},
"relations": [
{
"person": {
"id": "<uuid>",
"full_name": "<string>",
"taxpayer_id": "<string>"
},
"signer": "<boolean>"
},
{
"person": {
"id": "<uuid>",
"full_name": "<string>",
"taxpayer_id": "<string>"
},
"signer": "<boolean>"
}
],
"metadata": {
"values": {
"esse74c": {
"value": [
"<string>",
"<string>"
],
"sensitive": "<boolean>"
}
}
},
"created_at": "<dateTime>",
"updated_at": "<dateTime>",
"version": "<integer>",
"alias": "<string>"
}
],
"total_pages": "<integer>",
"total_elements": "<long>",
"has_next": "<boolean>"
}