Shopee - Debt Query and Creation
Debt Query by Contract Number
Request
ENDPOINT
/v2/credit_operation/contract_number/CONTRACT-NUMBERMETHOD
GETResponse
STATUS
200Response Body
{
"credit_operation_key": "6ca8b2d3-b3e7-4788-955a-518c931c279a",
"issue_amount": 202.08,
"origin_key": "6ca8b2d3-b3e7-4788-955a-518c931c279a",
"total_iof": 2.08,
"assigned_at": null,
"disbursement_start_date": "2025-09-15",
"disbursement_end_date": "2025-09-15",
"issue_date": "2025-09-15",
"requester_identifier_key": "6ca8b2d3-b3e7-4788-955a-518c931c279a",
"installments": [
{
"business_due_date": "2025-10-15",
"due_date": "2025-10-15",
"calendar_days": 30,
"due_interest": 0,
"due_principal": 202.08,
"fine_amount": 10.54,
"has_interest": true,
"post_fixed_amount": 0,
"pre_fixed_amount": 16.17,
"principal_amortization_amount": 44.99,
"tax_amount": 0.11,
"total_amount": 71.7,
"workdays": 22,
"accrual_reference_date": null,
"advanced_paid_amount": 0,
"bank_slip_key": null,
"digitable_line": null,
"installment_key": "f068962e-b3b4-4aaa-a2e4-05afdeaac99f",
"installment_status": "overdue",
"installment_type": "principal",
"original_due_principal": 202.08,
"original_pre_fixed_amount": 16.17,
"original_principal_amortization_amount": 44.99,
"paid_amount": 0,
"original_total_amount": 61.16,
"qr_code_key": "ce754fbc-39e3-408a-914a-032de781d15f",
"qr_code_url": "00020126930014br.gov.bcb.pix2571qrcode-h.sandbox.qitech.app/bacen/cobv/ce754fbc39e3408a914a032de781d15f5204000053039865802BR5925QISOCIEDADEDECREDITODIRET6008SaoPaulo61080145200062070503***6304ED46",
"renegotiation_proposal_key": null,
"total_accrual_amount": 0,
"total_paid_amount": 0,
"installment_number": 1,
"paid_at": null,
"updated_at": "2025-12-03T08:18:19",
"principal_amortization_payment_amount": 0,
"prefixed_interest_payment_amount": 0
},
{
"business_due_date": "2025-11-17",
"due_date": "2025-11-15",
"calendar_days": 31,
"due_interest": 0,
"due_principal": 157.08639993,
"fine_amount": 4.49,
"has_interest": true,
"post_fixed_amount": 0,
"pre_fixed_amount": 13,
"principal_amortization_amount": 48.16,
"tax_amount": 0.24,
"total_amount": 65.65,
"workdays": 22,
"accrual_reference_date": null,
"advanced_paid_amount": 0,
"bank_slip_key": null,
"digitable_line": null,
"installment_key": "6b5ef215-58ba-4ce4-85a4-e30b2ba3cd82",
"installment_status": "overdue",
"installment_type": "principal",
"original_due_principal": 157.09,
"original_pre_fixed_amount": 13,
"original_principal_amortization_amount": 48.16,
"paid_amount": 0,
"original_total_amount": 61.16,
"qr_code_key": "ebb1cf13-77dd-4c94-8c61-60726c7959b0",
"qr_code_url": "00020126930014br.gov.bcb.pix2571qrcode-h.sandbox.qitech.app/bacen/cobv/ebb1cf1377dd4c948c6160726c7959b05204000053039865802BR5925QISOCIEDADEDECREDITODIRET6008SaoPaulo61080145200062070503***6304B622",
"renegotiation_proposal_key": null,
"total_accrual_amount": 0,
"total_paid_amount": 0,
"installment_number": 2,
"paid_at": null,
"updated_at": "2025-12-03T08:18:19",
"principal_amortization_payment_amount": 0,
"prefixed_interest_payment_amount": 0
},
{
"business_due_date": "2025-12-15",
"due_date": "2025-12-15",
"calendar_days": 30,
"due_interest": 0,
"due_principal": 108.92909379,
"fine_amount": 0,
"has_interest": true,
"post_fixed_amount": 0,
"pre_fixed_amount": 8.71,
"principal_amortization_amount": 52.45,
"tax_amount": 0.39,
"total_amount": 61.16,
"workdays": 20,
"accrual_reference_date": null,
"advanced_paid_amount": 0,
"bank_slip_key": null,
"digitable_line": null,
"installment_key": "154595c6-52d4-4941-b548-382a7da8006e",
"installment_status": "opened",
"installment_type": "principal",
"original_due_principal": 108.93,
"original_pre_fixed_amount": 8.71,
"original_principal_amortization_amount": 52.45,
"paid_amount": 0,
"original_total_amount": 61.16,
"qr_code_key": "c32afaef-5079-4f80-8f22-84d69bad7c80",
"qr_code_url": "00020126930014br.gov.bcb.pix2571qrcode-h.sandbox.qitech.app/bacen/cobv/c32afaef50794f808f2284d69bad7c805204000053039865802BR5925QISOCIEDADEDECREDITODIRET6008SaoPaulo61080145200062070503***6304ED7D",
"renegotiation_proposal_key": null,
"total_accrual_amount": 0,
"total_paid_amount": 0,
"installment_number": 3,
"paid_at": null,
"updated_at": "2025-12-02T02:12:19",
"principal_amortization_payment_amount": 0,
"prefixed_interest_payment_amount": 0
},
{
"business_due_date": "2026-01-15",
"due_date": "2026-01-15",
"calendar_days": 31,
"due_interest": 0,
"due_principal": 56.48342126,
"fine_amount": 0,
"has_interest": true,
"post_fixed_amount": 0,
"pre_fixed_amount": 4.68,
"principal_amortization_amount": 56.48,
"tax_amount": 0.57,
"total_amount": 61.16,
"workdays": 21,
"accrual_reference_date": null,
"advanced_paid_amount": 0,
"bank_slip_key": null,
"digitable_line": null,
"installment_key": "277ba1ea-c70d-47fa-af47-484d5d52ac6a",
"installment_status": "opened",
"installment_type": "principal",
"original_due_principal": 56.48,
"original_pre_fixed_amount": 4.68,
"original_principal_amortization_amount": 56.48,
"paid_amount": 0,
"original_total_amount": 61.16,
"qr_code_key": "293b6596-2653-41df-a545-02f3f4cf31ad",
"qr_code_url": "00020126930014br.gov.bcb.pix2571qrcode-h.sandbox.qitech.app/bacen/cobv/293b6596265341dfa54502f3f4cf31ad5204000053039865802BR5925QISOCIEDADEDECREDITODIRET6008SaoPaulo61080145200062070503***6304BA51",
"renegotiation_proposal_key": null,
"total_accrual_amount": 0,
"total_paid_amount": 0,
"installment_number": 4,
"paid_at": null,
"updated_at": "2025-12-02T02:12:19",
"principal_amortization_payment_amount": 0,
"prefixed_interest_payment_amount": 0
}
],
"first_due_date": "2025-10-15",
"requester_key": "3e69b448-9afb-4aef-9c0d-0a3059350d80",
"original_total_iof": null,
"contract_number": "0000482688/Q",
"credit_operation_status_enumerator": "opened",
"operation_type_enumerator": "structured_operation",
"disbursement_date": "2025-09-15",
"issuer_name": "teste",
"issuer_document_number": "31057466093",
"external_contract_fees": [],
"cet": 8.58,
"annual_cet": 168.63,
"final_disbursement_amount": 200,
"number_of_installments": 4,
"disbursement_issue_amount": 200,
"prefixed_interest_rate": {
"annual_rate": 1.5181701168,
"daily_rate": 0.0025686614,
"interest_base": {
"enumerator": "calendar_days",
"year_days": 360
},
"monthly_rate": 0.08
},
"fine_configuration": {
"contract_fine_rate": 0.02,
"fine_delay_rate": {
"annual_rate": 0.12682503,
"daily_rate": 0.00032719,
"interest_base": {
"enumerator": "calendar_days_365",
"year_days": 365
},
"monthly_rate": 0.01
}
},
"attached_documents": [
{
"document_key": "c51169f0-40b6-4c71-8ad0-20450ece226e",
"document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/c51169f0-40b6-4c71-8ad0-20450ece226e/CASTELLOBNPLC-CCB-0000482688-20251202021216.pdf",
"signature_url": "https://storage.googleapis.com/sandbox-doc-api/documents/c51169f0-40b6-4c71-8ad0-20450ece226e/CASTELLOBNPL-CCB-0000482688-20251202021216_signed.pdf",
"document_type": "ccb_pre_price_days",
"signature_required": true,
"signed": true
}
],
"related_parties": [
{
"related_party_key": "78d191a8-9d3c-4b96-b440-c6e3b81a7e67",
"role_type": "issuer",
"person_type": "natural",
"name": "teste",
"email": "teste@test.com",
"individual_document_number": "31057466093"
}
]
}
STATUS
404Response Body
{
"data": "{\"title\": \"Not Found\", \"description\": \"Credit Operation not found\", \"translation\": \"Operacao nao encontrada\", \"extra_fields\": {}, \"code\": \"COP000027\"}",
"title": "Not Found",
"description": "Credit Operation not found",
"translation": "Operacao nao encontrada",
"extra_fields": {},
"code": "COP000027"
}
Credit Operation Status
Enumerator credit_operation_status
| Enum | Description |
|---|---|
| opened | The debt/loan has been successfully disbursed and is active |
Debt creation/disbursement endpoint
Request
ENDPOINT
/signed_debtMETHOD
POSTRequest Body
{
"disbursement_bank_accounts": [
{
"account_number": "5176921",
"bank_code": "329",
"percentage_receivable": 100,
"document_number": "38372267000182",
"branch_number": "0001",
"name": "SHPP BRASIL SERVICOS DE PAGAMENTOS LTDA",
"account_digit": "3"
}
],
"additional_data": {
"contract": {
"signatures": [
{
"signer": {
"name": "BRUNA GRAZIELE COUTINHO DE SOUZA",
"document_number": "40259074888",
"phone": {
"area_code": "12",
"country_code": "055",
"number": "982519264"
},
"email": "bruna.coutinho25@outlook.com"
},
"signature": {
"signature_file": {
"file_url": "http://qitech.com.br/signature.pdf",
"file_type": "pdf"
},
"fingerprint_device": null,
"geolocation": {
"long": "",
"lat": ""
},
"timestamp": "03-12-2025 20:01:00",
"ip_address": "143.92.93.162"
}
}
],
"signed": true,
"contract_number": "BCL0029600071"
}
},
"borrower": {
"mother_name": "JULIANA COUTINHO",
"document_identification_back": "ec54280f-16ee-4714-8bb0-44108a2c6176",
"document_identification_number": "",
"nationality": "",
"document_identification": "e8a339c2-0550-409e-bb6d-3236dca905d0",
"address": {
"street": "José Gonçalves Diniz",
"state": "SP",
"neighborhood": "Vila Carmem",
"number": "355",
"complement": "José Gonçalves Diniz, 355",
"city": "Cachoeira Paulista",
"postal_code": "12630000"
},
"individual_document_number": "40259074888",
"profession": "Autonomous",
"person_type": "natural",
"phone": {
"area_code": "12",
"number": "982519264",
"country_code": "055"
},
"marital_status": "single",
"birth_date": "1990-12-11",
"name": "BRUNA GRAZIELE COUTINHO DE SOUZA",
"email": "bruna.coutinho25@outlook.com"
},
"simplified": true,
"financial": {
"annual_interest_rate": 2.59418341,
"interest_grace_period": 0,
"principal_grace_period": 0,
"disbursement_date": "2025-12-03",
"rebates": null,
"interest_type": "pre_price_days",
"issue_date": "2025-12-03",
"disbursed_amount": 30,
"fine_configuration": {
"monthly_rate": 0.1225,
"interest_base": "calendar_days",
"contract_fine_rate": 0.02
},
"credit_operation_type": "ccb",
"first_due_date": "2026-01-03",
"number_of_installments": 3
},
"purchaser_document_number": "42922136000107"
}
Response
STATUS
200Response Body
{
"origin_type": "lego-api",
"status": "opened",
"signature_data": {
"signed_contract_url": "https://storage.googleapis.com/live-doc-api/documents/1fcf546b-d309-47ae-9bbb-1e81224f6d63/SHPPBRASILINSTITUICAODEPAGAMENTOESERVICOSDEPAGAMENTOSLTDABCL-MARCIA_CRISTINA_DE_SOUZA-CCB-BCL0029573482-20251203190639_signed.pdf"
},
"transaction_receipts": [],
"key": "4e47ab1a-68a0-4e91-875f-338eaa83ed75",
"installments": [
{
"installment_number": 1,
"pre_fixed_amount": 18.78472086,
"total_amount": 28.56,
"due_date": "2026-01-03",
"installment_key": "bb8ceccc-c294-4aa6-866e-81db7f4d85d5",
"principal_amortization_amount": 9.77527914
},
{
"due_date": "2026-02-03",
"pre_fixed_amount": 17.88732134,
"installment_key": "e2260eaf-6cca-4366-9f7a-3d0aeb9b540c",
"installment_number": 2,
"total_amount": 28.56,
"principal_amortization_amount": 10.67267866
},
{
"due_date": "2026-03-03",
"pre_fixed_amount": 15.20566117,
"installment_key": "82b9fb55-c382-4fe8-a028-b2e65ce7e40e",
"installment_number": 3,
"total_amount": 28.56,
"principal_amortization_amount": 13.35433883
},
{
"total_amount": 28.56,
"installment_key": "3ae244dc-423b-44a4-bfb3-85fb4b10459d",
"pre_fixed_amount": 15.68157011,
"principal_amortization_amount": 12.87842989,
"installment_number": 4,
"due_date": "2026-04-03"
},
{
"due_date": "2026-05-03",
"installment_number": 5,
"total_amount": 28.56,
"pre_fixed_amount": 14.01142391,
"principal_amortization_amount": 14.54857609,
"installment_key": "80c9da75-2c10-4db4-a9f5-13dab80c7ce6"
},
{
"pre_fixed_amount": 13.16368988,
"principal_amortization_amount": 15.39631012,
"due_date": "2026-06-03",
"total_amount": 28.56,
"installment_key": "af9b14e8-dc18-48b6-bce7-0066e54e66af",
"installment_number": 6
},
{
"installment_number": 7,
"principal_amortization_amount": 17.20510658,
"pre_fixed_amount": 11.35489342,
"total_amount": 28.56,
"due_date": "2026-07-03",
"installment_key": "5b90c9a6-1eac-4896-baf1-32b5f321496b"
},
{
"total_amount": 28.56,
"pre_fixed_amount": 10.17078346,
"principal_amortization_amount": 18.38921654,
"installment_number": 8,
"installment_key": "0a83929d-cb28-43ee-9b08-88373a150d40",
"due_date": "2026-08-03"
},
{
"total_amount": 28.56,
"installment_number": 9,
"principal_amortization_amount": 20.07740098,
"due_date": "2026-09-03",
"pre_fixed_amount": 8.48259902,
"installment_key": "5584f2f7-8fd0-4818-aca3-b2e86f0145b5"
},
{
"due_date": "2026-10-03",
"installment_number": 10,
"total_amount": 28.56,
"pre_fixed_amount": 6.41603237,
"principal_amortization_amount": 22.14396763,
"installment_key": "09bfddd5-2fbf-47f5-8b30-e78a3153d0b7"
},
{
"total_amount": 28.56,
"due_date": "2026-11-03",
"installment_key": "c81d2d15-c275-488c-b117-d657555976cb",
"pre_fixed_amount": 4.60655258,
"principal_amortization_amount": 23.95344742,
"installment_number": 11
},
{
"pre_fixed_amount": 2.33475188,
"installment_number": 12,
"installment_key": "6f57f7de-4d13-4567-84af-31792fa24149",
"principal_amortization_amount": 26.22524812,
"due_date": "2026-12-03",
"total_amount": 28.56
}
]
}
STATUS
400Response Body
{
"code": "QIT000001",
"translation": "Payload Inválido",
"description": "'R Ademar C da Silva, 111, Perto poção, caso eu não estiver en casa deixar na vizinha da frente ou do lado esquerdo' does not match \"^[a-zA-Z0-9à-üÀ-Ü\\\\s';.ªº',_`´°:\\\\(\\\\)/-]{0,100}$\" in related_party_list.0.address.complement",
"title": "Schema Validator Error"
}
STATUS
500Response Body
{
"translation": "Um erro interno aconteceu e está sendo investigado.",
"title": "Internal Server Error",
"description": "An internal error has occurred and its being investigated.",
"code": "QIT000753"
}