Pular para o conteúdo principal

Consulta paginada de Pedido de Resgate

Requests​

Requisição por cotista: este endpoint retornará todos os resgates de um cotista
ENDPOINT
/quota_distributor/investor/INVESTOR_KEY/redemption_requests
MÉTODO
GET
STATUS
200
Requisição por fundo: este endpoint retornará todos os resgates de um fundo
ENDPOINT
/quota_distributor/fund_class/FUND_CLASS_KEY/redemption_requests
MÉTODO
GET
STATUS
200

Query Params​

ParâmetroDescrição
quotation_dateData de cotização dos resgates
statusLista de Redemption Request Status desejados

Responses​

Caso 01: Consulta bem-sucedida
{
    "data": [
        {
            "redemption_request_key": "UUID",
            "redemption_request_type": "gross_redemption_value" | "number_of_quotas" | "remaining_application_value",
            "status": "pending_quote" | "processing_quote" | "canceled" | "quoted",
            "quotation_date": "yyyy-mm-dd",
            "payment_date":"yyyy-mm-dd",
            "request_datetime":"yyyy-mm-dd HH:MM:SS:MS",
            "processed_value": 0.00,
            "investor_position": {
                "investor": {
                    "investor_key": "UUID",
                    "document_number": "999.999.999-99" | "99.999.999/9999-99",
                    "name": "",
                    "person_type": "natural_person" | "legal_person",
                    "account_data": {
                        "owner": {
                            "name": "",
                            "document_number": "99.999.999/9999-99"
                        },
                        "account_digit": "0",
                        "account_branch": "0000",
                        "account_number": "00000",
                        "financial_institution_code": "000",
                        "financial_institution_ispb": "00000000"
                    },
                    "distributor": {
                        "distributor_key": "UUID",
                        "document_number": "99.999.999/9999-99",
                        "name": "",
                        "account_data": {
                            "owner": {
                                "name": "",
                                "document_number": "99.999.999/9999-99"
                            },
                            "account_digit": "0",
                            "account_branch": "0000",
                            "account_number": "00000",
                            "financial_institution_code": "000",
                            "financial_institution_ispb": "00000000"
                        },
                    }
                },
                "total_net_worth": 0.00,
                "total_number_of_quotas": 0.00000000,
                "investor_position_key": "UUID",
                "issuance_serie":{
                    "name":"1",
                    "cetip_code":"0000000SN1",
                    "start_date":"YYYY-MM-DD",
                    "maturity_date":"YYYY-MM-DD",
                    "original_quota_value":0.00000000000000,
                    "remuneration_type":"yield_curve",
                    "interest_rate_type":"post_fixed",
                    "pre_fixed":{
                    "calendar_base":"workdays / calendar_360 / calendar_365",
                    "monthly_rate":0.00000000000000
                    },
                    "post_fixed":{
                    "calendar_base":"workdays / calendar_360 / calendar_365",
                    "indexer":"di / ipca",
                    "rate":1,
                    "lag":{
                        "reference":"daily / monthly",
                        "amount":1
                    }
                    },
                    "investment_category":"fidc / multi_market",
                    "condominum_type":"open_ended / close_ended",
                    "tax_classification":"short_term / long_term",
                    "investment_restriction_type":"just_professional",
                    "issuance_serie_key":"UUID",
                    "minimum_share_capital":0.0,
                    "accounting_date":"YYYY-MM-DD",
                    "sub_class":{
                    "name":"COTA SÊNIOR",
                    "sub_class_key":"UUID",
                    "subordination_level":1,
                    "fund_class":{
                        "name":"SAMPLE FUND CLASS NAME",
                        "fund_class_key":"UUID",
                        "document_number":"00.000.000/0000-00"
                    }
                    }
                }
            },
            "status_events": [
                {
                    "event_datetime": "yyyy-mm-dd HH:MM:SS:ms",
                    "status": "pending_quote" | "processing_quote" | "canceled" | "quoted",
                }
            ],
        }
    ],
    "limit": 50,
    "page": 0,
    "is_last_page": true
}

Page​

CampoTipoDescrição
dataarrayLista de objetos de Redemption Request
limitintLimite de objetos recuperados por página
pageintNúmero da página recuperada
is_last_pagebooleanInformação que indica se a página recuperada é a última

Redemption Request​

CampoTipoDescriçãoCaracteres
redemption_request_keystringChave única de identificação do pedido de resgate36
redemption_request_typestringEnumerador de Redemption Request Type-
statusstringEnumerador de Redemption Request Status-
quotation_datestringData da cotização-
payment_datestringData do pagamento-
request_datetimestringData da criação do pedido do resgate-
processed_valuefloatValor processado do resgate-
investor_positionJSONObjeto de Investor Position-
status_eventsarrayLista de objetos de Status Event-

Redemption Request Status​

EnumeradorDescrição
pending_quotePendente pagamento
processing_quotePendente cotização
quotedCotizado
canceledTotalmente amortizado

Redemption Request Type​

EnumeradorDescrição
gross_redemption_valueResgate por valor bruto
number_of_quotasResgate por número de cotas
remaining_application_valueResgate por valor restate

Investor Position​

CampoTipoDescrição
investorJSONObjeto de Investor
total_net_worthfloatPatrimônio Líquido da posição do investidor
total_number_of_quotasfloatNúmero de cotas da posição do investidor
issuance_serieJSONObjeto de Issuance Serie
investor_position_keyJSONChave única de identificação da posição do investidor

Investor​

CampoTipoDescriçãoCaracteres
namestringNome do investidoraté 255
investor_keystringChave única de identificação do investidor36
document_numberstringCPF/CNPJ do investidor14 ou 18
person_typestringPessoa Física / Pessoa Jurídica / Classe de Fundoaté 50
distributorJSONObjeto de Distributor-
account_dataJSONObjeto de Account Data-

Distributor​

CampoTipoDescriçãoCaracteres
namestringNome do distribuidoraté 255
distributor_keystringChave única de identificação do distribuidor-
document_numberstringCPF/CNPJ do distribuidor14 ou 18
account_dataJSONObjeto de Account Data-

Account Data​

CampoTipoDescrição
account_digitstringDígito da conta bancária
account_branchstringN° da agência da conta bancária
account_numberstringN° da conta bancária
financial_institution_codestringCódigo da instituição financeira
financial_institution_ispbstringIdentificador no Sistema de Pagamento Brasileiro da instituição financeira

Issuance Serie​

CampoTipoDescriçãoCaracteres
namestringNome da série de emissãoaté 255
issuance_serie_keystringChave única de identificação da série de emissão36
cetip_codestringCódigo da série de emissão como ativo na CETIP10
start_datestringData de início da série de emissão10
maturity_datestringData de vencimento da série de emissão10
original_quota_valuefloatValor de cota original-
remuneration_typestringCurva de rendimento / Residualaté 50
investment_categorystringFIDC / Multimercadoaté 50
condominum_typestringAberto / Fechadoaté 50
tax_classificationstringCurto prazo / Longo prazoaté 50
investment_restriction_typestringSem restrição / Qualificado / Profissionalaté 50
minimum_share_capitalfloatValor mínimo para aplicação-
accounting_datestringData contábil da série de emissão10
sub_classJSONObjeto de Sub Class-

Sub Class​

CampoTipoDescriçãoCaracteres
namestringNome da sub classeaté 255
sub_class_keystringChave única de identificação da sub classe36
subordination_levelintNível de subordinação da sub classe-
fund_classJSONObjeto de Fund Class-

Fund Class​

CampoTipoDescriçãoCaracteres
namestringNome da classe de fundoaté 255
fund_class_keystringChave única de identificação da classe de fundo36
document_numberstringCNPJ da classe de fundo-