Metadata
Objeto que permite a consulta de operações de crédito através de chaves e valores personalizados.
1. Criar Metadata
Objeto Request Body
| Campo | Tipo | Descrição | Máx. Caract. |
|---|---|---|---|
| metadata_key * | string | Chave metadata | 100 |
| metadata_value * | string | Valor metadata | 100 |
Request
ENDPOINT
/credit_operation/[CREDIT-OPERATION-KEY]/metadataMÉTODO
POSTRequest Body
{
"metadata_key": "key",
"metadata_value": "value"
}
2. Remover Metadata
Request
ENDPOINT
/credit_operation/[CREDIT-OPERATION-KEY]/metadataMÉTODO
DELETERequest Body
{
"metadata_key": "key",
"metadata_value": "value"
}
3. Consulta de operação de crédito utilizando Metadata
cuidado
Na consulta por metadata, os dois campos 'metadata_key' e 'metadata_value' devem ser informados.
Request
ENDPOINT
/credit_operationsMÉTODO
GETPARAMETERS
page, page_size, metadata_key, metadata_value, credit_operation_statusResponse
Response Body
{
"data": [
{
"credit_operation_key": "cc217253-e89f-4d14-bf89-fb29afaa2895",
"contract_number": "0000000007/WO",
"credit_operation_status": "waiting_signature",
"additional_iof": 3.817322,
"total_iof": 7.19,
"original_total_iof": 7.2,
"attached_documents": [
{
"document_key": "2f7bfc50-d7c0-4d4e-a5ce-d8bba2aeb348",
"document_url": "https://storage.googleapis.com/dev-doc-api/documents/2f7bfc50-d7c0-4d4e-a5ce-d8bba2aeb348/sample.pdf",
"signature_url": null,
"document_type": "document_identification",
"signature_required": false,
"signed": false
},
{
"document_key": "568ca6b7-45a8-42e5-a383-e93641625040",
"document_url": "b",
"signature_url": null,
"document_type": "ccb_pre_price",
"signature_required": true,
"signed": false
}
],
"annual_cet": 316.4973,
"assigned": false,
"assigned_at": null,
"assignment_amount": 1007.19,
"issue_amount": 1007.19,
"disbursed_issue_amount": 1000,
"final_disbursement_amount": 1000,
"base_iof": 3.37226774,
"calculus_correction": null,
"central_depository": null,
"cet": 12.62,
"collateral_constituted": true,
"collateral_type": null,
"contract_fee_amount": 0,
"external_contract_fee_amount": 0,
"credit_operation_type": "ccb",
"operation_type": "structured_operation",
"creditor_bank_account_key": null,
"custodian": "qi_scd",
"disbursement_date": "2022-08-08",
"disbursement_start_date": "2022-08-08",
"disbursement_end_date": "2022-08-08",
"first_due_date": "2022-08-18",
"disbursement_accounts": [
{
"account_branch": "0001",
"account_digit": "3",
"account_number": "94134",
"account_type": null,
"disbursement_type": "pix",
"amount_receivable": null,
"digitable_line": null,
"financial_institutions_code_number": 329,
"ispb": "32402502",
"name": "Teste",
"percentage_receivable": 100,
"pix_key": "qitech@qitech.com.br",
"pix_transfer_key": "0956cf37-5ef6-4a63-9c01-f29b259e1993",
"pix_type": "key",
"qr_code_key": null
}
],
"document_certifier": "clicksign",
"number_of_installments": 3,
"installments": [
{
"accrual_reference_date": null,
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2022-08-19",
"due_date": "2022-08-18",
"calendar_days": 10,
"digitable_line": null,
"due_interest": 0,
"due_principal": 1007.19,
"fine_amount": null,
"has_interest": true,
"installment_key": "5f45b7b4-f7f0-464b-94a7-cdea47f3811b",
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 1007.19,
"original_pre_fixed_amount": 38.24205854,
"original_principal_amortization_amount": 351.17794146,
"paid_amount": 0,
"post_fixed_amount": 0,
"original_total_amount": 389.42,
"pre_fixed_amount": 38.24205854,
"principal_amortization_amount": 351.17794146,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 0.28796591,
"total_accrual_amount": null,
"total_amount": 389.42,
"total_paid_amount": 0,
"workdays": 8
},
{
"accrual_reference_date": null,
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2022-09-20",
"due_date": "2022-09-19",
"calendar_days": 32,
"digitable_line": null,
"due_interest": 0,
"due_principal": 656.01205854,
"fine_amount": null,
"has_interest": true,
"installment_key": "f844a3ea-bde3-4f94-ada1-607e799b9095",
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 656.01205854,
"original_pre_fixed_amount": 80.33658151,
"original_principal_amortization_amount": 309.08341849,
"paid_amount": 0,
"post_fixed_amount": 0,
"original_total_amount": 389.42,
"pre_fixed_amount": 80.33658151,
"principal_amortization_amount": 309.08341849,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 1.06448329,
"total_accrual_amount": null,
"total_amount": 389.42,
"total_paid_amount": 0,
"workdays": 21
},
{
"accrual_reference_date": null,
"advanced_paid_amount": 0,
"bank_slip_key": null,
"business_due_date": "2022-10-19",
"due_date": "2022-10-18",
"calendar_days": 29,
"digitable_line": null,
"due_interest": 0,
"due_principal": 346.92864005,
"fine_amount": null,
"has_interest": true,
"installment_key": "e6d67f54-8827-40c4-ade0-1b9b8fd03689",
"installment_status": "created",
"installment_type": "principal",
"original_due_principal": 346.92864005,
"original_pre_fixed_amount": 42.49135995,
"original_principal_amortization_amount": 346.92864005,
"paid_amount": 0,
"post_fixed_amount": 0,
"original_total_amount": 389.42,
"pre_fixed_amount": 42.49135995,
"principal_amortization_amount": 346.92864005,
"qr_code_key": null,
"qr_code_url": null,
"renegotiation_proposal_key": null,
"tax_amount": 2.01981854,
"total_accrual_amount": null,
"total_amount": 389.42,
"total_paid_amount": 0,
"workdays": 20
}
],
"interest_grace_period": 0,
"interest_payment_month_period": 1,
"interest_subsidy_amount": 0,
"interest_subsidy_percentage": 0,
"interest_type": "pre_price",
"iof_charge_method": "financed",
"ipoc_code": "3240250202021371976458320000000007/WO",
"issue_date": "2022-08-08",
"issuer_document_number": "37197645832",
"issuer_name": "Wilker Oliveira\u00e7o",
"modality": "0202",
"origin_key": "52539e23-5c01-4b9c-8a68-6ed750ec7bc5",
"payment_and_settlement_agent": "qi_scd",
"post_fixed_interest_rate": null,
"prefixed_interest_rate": {
"annual_rate": 3,
"daily_rate": 0.00385824,
"monthly_rate": 0.12246205,
"interest_base": "calendar_days"
},
"fine_configuration": {
"contract_fine_rate": 0.02,
"fine_delay_rate": {
"annual_rate": 0.12682503,
"daily_rate": 0.00033173,
"interest_base": "calendar_days",
"monthly_rate": 0.01
}
},
"principal_amortization_month_period": 1,
"principal_grace_period": 0,
"purchaser_document_number": "04113929151550",
"requester_key": "52f36417-368e-4f5b-8841-71e3b9caa72f",
"requester_identifier_key": null,
"settlement_bank_account_key": "e7e60779-6605-4af5-bd00-1f465f2c5da5",
"share_quantity": 2,
"tax_configuration": {
"iof_additional_rate": 0.000082,
"iof_rate": 0.0038
},
"third_party_account_key": "96015228-4905-42fc-bda6-e70e0e552b6b",
"disbursement_options": [
{
"additional_iof": 3.817322,
"annual_cet": 316.4973,
"assignment_amount": 1007.19,
"base_iof": 3.37226774,
"calculus_correction": null,
"cet": 12.62,
"contract_fee_amount": 0,
"disbursed_issue_amount": 1000,
"disbursement_date": "2022-08-08",
"external_contract_fee_amount": 0,
"first_due_date": "2022-08-18",
"installments": [
{
"business_due_date": "2022-08-19",
"due_date": "2022-08-18",
"calendar_days": 10,
"due_interest": 0,
"due_principal": 1007.19,
"fine_amount": null,
"has_interest": true,
"post_fixed_amount": 0,
"pre_fixed_amount": 38.24205854,
"principal_amortization_amount": 351.17794146,
"tax_amount": 0.28796591,
"total_amount": 389.42,
"workdays": 8
},
{
"business_due_date": "2022-09-20",
"due_date": "2022-09-19",
"calendar_days": 32,
"due_interest": 0,
"due_principal": 656.01205854,
"fine_amount": null,
"has_interest": true,
"post_fixed_amount": 0,
"pre_fixed_amount": 80.33658151,
"principal_amortization_amount": 309.08341849,
"tax_amount": 1.06448329,
"total_amount": 389.42,
"workdays": 21
},
{
"business_due_date": "2022-10-19",
"due_date": "2022-10-18",
"calendar_days": 29,
"due_interest": 0,
"due_principal": 346.92864005,
"fine_amount": null,
"has_interest": true,
"post_fixed_amount": 0,
"pre_fixed_amount": 42.49135995,
"principal_amortization_amount": 346.92864005,
"tax_amount": 2.01981854,
"total_amount": 389.42,
"workdays": 20
}
],
"interest_subsidy_amount": 0,
"issue_amount": 1007.19,
"net_external_contract_fee_amount": 0,
"share_quantity": 2,
"total_iof": 2,
"prefixed_interest_rate": {
"annual_rate": 3,
"daily_rate": 0.00385824,
"monthly_rate": 0.12246205,
"interest_base": "calendar_days"
}
}
],
"related_parties": [
{
"company_document_number": null,
"email": "teste.teste@yopmail.com",
"foundation_date": null,
"gender": "male",
"individual_document_number": "61592798071",
"is_pep": null,
"marital_status": null,
"mother_name": null,
"nationality": null,
"person_type": "natural",
"related_party_key": "16e3b6a8-bec0-4bd2-8b23-caaad54afd8c",
"role_type": "issuer",
"trading_name": null,
"simples_nacional_participant": null,
"spouse_document_number": null,
"profession": null,
"address": {
"city": "Bauru",
"complement": null,
"neighborhood": "Centro",
"number": "343",
"postal_code": "17057770",
"state": "SP",
"street": "Av Um"
},
"phone": {
"area_code": "14",
"country_code": "055",
"number": "936180266"
},
"attached_documents": [
{
"document_key": "2f7bfc50-d7c0-4d4e-a5ce-d8bba2aeb348",
"document_url": "https://storage.googleapis.com/dev-doc-api/documents/2f7bfc50-d7c0-4d4e-a5ce-d8bba2aeb348/sample.pdf",
"signature_url": null,
"document_type": "document_identification",
"signature_required": false,
"signed": false
}
]
}
]
}
],
"pagination": {
"current_page": 1,
"next_page": 2,
"rows_per_page": 10,
"total_pages": 1,
"total_rows": 1,
"contain_last_page": true
}
}