Consultar as Solicitações da Empresa

Esse endpoint permite consultar as solicitações realizadas pela Empresa. É possível realizar a paginação dos resultados que forem retornados para a Empresa.

Parâmetros da URL

  • business_id (string, uuid v4): Identificador do cadastro da Empresa a ser consultada.

Parâmetros para filtros e paginação dos resultados:

  • page (integer, opcional): O nº da página para paginação.
  • size (integer, opcional): A quantidade de itens a serem retornados na paginação.

Parâmetros da Requisição

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

Resposta

Em caso de sucesso será retornado um status 200 e um arquivo JSON no seguinte formato:

  • sucesso (bool

Exemplo de Json:

{
  "type": "object",
  "properties": {
    "content": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "product": {
            "type": "object",
            "properties": {
              "id": { "type": "string" }
            }
          },
          "borrower": {
            "type": "object",
            "properties": {
              "id": { "type": "string" }
            }
          },
          "requested_amount": { "type": "string" },
          "interest_rate": { "type": "string" },
          "tac_amount": { "type": "string" },
          "finance_fee": { "type": "string" },
          "num_payments": { "type": "string" },
          "first_payment_date": { "type": "string" },
          "disbursement_date": { "type": "string" },
          "issue_date": { "type": "string" },
          "status": { "type": "string" },
          "status_description": { "type": "string" },
          "loan_details": {
            "type": "object",
            "properties": {
              "total_processing_cost": { "type": "string" },
              "annual_interest_rate": { "type": "string" },
              "annual_effective_interest_rate": { "type": "string" },
              "monthly_effective_interest_rate": { "type": "string" },
              "total_amount_owed": { "type": "string" },
              "disbursement_amount": { "type": "string" },
              "financed_amount": { "type": "string" },
              "iof_daily_rate": { "type": "string" },
              "iof_amount": { "type": "string" },
              "iof_base_rate": { "type": "string" },
              "payment_amount": { "type": "string" },
              "issue_date": { "type": "string" },
              "schedule": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "payment": { "type": "string" },
                    "iof": { "type": "string" },
                    "balance": { "type": "string" },
                    "interest": { "type": "string" },
                    "principal": { "type": "string" },
                    "period": { "type": "string" },
                    "running_day": { "type": "string" },
                    "payment_date": { "type": "string" }
                  }
                }
              },
              "last_payment_date": { "type": "string" }
            }
          },
          "custom_variables": {
            "type": "object",
            "properties": {
              "values": {
                "type": "object",
                "properties": {
                  "dolor0": { "type": "string" },
                  "adipisicing_d31": { "type": "string" }
                }
              }
            }
          },
          "canceled_at": { "type": "string" },
          "sequential_id": { "type": "string" },
          "funding": {
            "type": "object",
            "properties": {
              "id": { "type": "string" },
              "legal_name": { "type": "string" },
              "alias": { "type": "string" },
              "metadata": {
                "type": "object",
                "properties": {
                  "values": {
                    "type": "object",
                    "properties": {
                      "ea_a6f": {
                        "type": "object",
                        "properties": {
                          "value": { "type": "array" },
                          "sensitive": { "type": "string" }
                        }
                      },
                      "cupidatat8d7": {
                        "type": "object",
                        "properties": {
                          "value": { "type": "array" },
                          "sensitive": { "type": "string" }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "payment_method": { "type": "string" },
          "backoffice_import_status": { "type": "string" },
          "guarantors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "guarantor_id": { "type": "string" },
                "type": { "type": "string" }
              }
            }
          },
          "co_signers": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "co_signer_id": { "type": "string" },
                "type": { "type": "string" }
              }
            }
          },
          "signature_collect_method": { "type": "string" },
          "issuer_disbursement_type": { "type": "string" },
          "signature_collect_options": {
            "type": "object",
            "properties": {
              "require_self_photo": { "type": "string" },
              "require_document_photo": { "type": "string" },
              "require_selfie_validation": { "type": "string" }
            }
          },
          "base_premium_amount": { "type": "string" },
          "additional_premium_amount": { "type": "string" },
          "loan": {
            "type": "object",
            "properties": {
              "id": { "type": "string" }
            }
          },
          "borrower_employer": {
            "type": "object",
            "properties": {
              "id": { "type": "string" }
            }
          },
          "disbursement": {
            "type": "object",
            "properties": {
              "requested_at": { "type": "string" },
              "processed_at": { "type": "string" },
              "receipt": { "type": "string" }
            }
          },
          "beneficiary_account": {
            "type": "object",
            "properties": {
              "registered_account_id": { "type": "string" },
              "holder": {
                "type": "object",
                "properties": {
                  "name": { "type": "string" },
                  "taxpayer_id": { "type": "string" }
                }
              },
              "external_bank_account": {
                "type": "object",
                "properties": {
                  "bank_account": { "type": "string" },
                  "bank_account_digit": { "type": "string" },
                  "bank_branch": { "type": "string" },
                  "bank_code": { "type": "string" },
                  "bank_account_type": { "type": "string" },
                  "ispb_code": { "type": "string" }
                }
              },
              "pix": {
                "type": "object",
                "properties": {
                  "key": { "type": "string" },
                  "key_type": { "type": "string" }
                }
              },
              "baas": {
                "type": "object",
                "properties": {
                  "account_number": { "type": "string" }
                }
              }
            }
          },
          "created_at": { "type": "string" },
          "updated_at": { "type": "string" },
          "version": { "type": "string" },
          "managed_account_for_issuer_disbursement": {
            "type": "object",
            "properties": {
              "baas": {
                "type": "object",
                "properties": {
                  "account_number": { "type": "string" },
                  "holder_type": { "type": "string" }
                }
              },
              "product_configuration": {
                "type": "object",
                "properties": {
                  "if_existing": { "type": "string" },
                  "type": { "type": "string" }
                }
              }
            }
          },
          "disbursement_attempts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": { "type": "string" },
                "status": { "type": "string" },
                "status_description": { "type": "string" },
                "payment_orders": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": { "type": "string" },
                      "amount": { "type": "string" },
                      "type": { "type": "string" },
                      "status": { "type": "string" },
                      "beneficiary_account": {
                        "type": "object",
                        "properties": {
                          "registered_account_id": { "type": "string" },
                          "holder": {
                            "type": "object",
                            "properties": {
                              "name": { "type": "string" },
                              "taxpayer_id": { "type": "string" }
                            }
                          },
                          "external_bank_account": {
                            "type": "object",
                            "properties": {
                              "bank_account": { "type": "string" },
                              "bank_account_digit": { "type": "string" },
                              "bank_branch": { "type": "string" },
                              "bank_code": { "type": "string" },
                              "bank_account_type": { "type": "string" },
                              "ispb_code": { "type": "string" }
                            }
                          },
                          "pix": {
                            "type": "object",
                            "properties": {
                              "key": { "type": "string" },
                              "key_type": { "type": "string" }
                            }
                          },
                          "baas": {
                            "type": "object",
                            "properties": {
                              "account_number": { "type": "string" }
                            }
                          }
                        }
                      },
                      "beneficiary_type": { "type": "string" }
                    }
                  }
                },
                "requested_at": { "type": "string" },
                "processed_at": { "type": "string" },
                "application_managed_account_for_issuer_disbursement": {
                  "type": "object",
                  "properties": {
                    "baas": {
                      "type": "object",
                      "properties": {
                        "account_number": { "type": "string" },
                        "holder_type": { "type": "string" }
                      }
                    },
                    "product_configuration": {
                      "type": "object",
                      "properties": {
                        "if_existing": { "type": "string" },
                        "type": { "type": "string" }
                      }
                    }
                  }
                },
                "created_at": { "type": "string" },
                "updated_at": { "type": "string" },
                "version": { "type": "string" }
              }
            }
          },
          "payment_orders": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": { "type": "string" },
                "amount": { "type": "string" },
                "type": { "type": "string" },
                "status": { "type": "string" },
                "beneficiary_account": {
                  "type": "object",
                  "properties": {
                    "registered_account_id": { "type": "string" },
                    "holder": {
                      "type": "object",
                      "properties": {
                        "name": { "type": "string" },
                        "taxpayer_id": { "type": "string" }
                      }
                    },
                    "external_bank_account": {
                      "type": "object",
                      "properties": {
                        "bank_account": { "type": "string" },
                        "bank_account_digit": { "type": "string" },
                        "bank_branch": { "type": "string" },
                        "bank_code": { "type": "string" },
                        "bank_account_type": { "type": "string" },
                        "ispb_code": { "type": "string" }
                      }
                    },
                    "pix": {
                      "type": "object",
                      "properties": {
                        "key": { "type": "string" },
                        "key_type": { "type": "string" }
                      }
                    },
                    "baas": {
                      "type": "object",
                      "properties": {
                        "account_number": { "type": "string" }
                      }
                    }
                  }
                },
                "beneficiary_type": { "type": "string" }
              }
            }
          },
          "total_pages": { "type": "string" },
          "total_elements": { "type": "string" },
          "has_next": { "type": "string" }
        }
      }
    }
  }
}

Language
URL
Click Try It! to start a request and see the response here!