SOBRE A "API DE PAGAMENTOS"

Visão Geral

API de Pagamento

Como consumir ?

Segue um exemplo de requisição para consumir essa API, ou clique aqui para seguir a documentação com exemplos e outras rotas.

Renegociação

Para efetuar um procedimento de renegociação seguiremos os passos:

Solicitar informações para o pagamento (Saldo das parcelas)
Simular renegociação
Formalizar contrato
Assinatura (Opcional)

1. Solicitar informações de pagamento

Requisição

application/json

{"request_info": {"persist_info": false,
"cancel_prepayment_discount": false,
"calculation_date": "2023-01-14",
"update_due_date": true,
"sum_iof_first_installment": true,
"deep_installment": false
},
"proposal_info": [{"proposal_id": 569784
},
{"operation_tracking_id": "593f33f6-6122-4624-8c1c-6602a14a730e"
}
],
"installment_info": [{"installment_id": 12345,
"installment_due_date": "2023-03-03"
}
],
"collection_policy": {"discount_d1_percent_charges": 0.1,
"discount_d2_percent_original": 0.1,
"discount_d3_amount_negotiation": 5.15,
"additional_a1_percent_after_charges": 0.1,
"additional_a2_percent_original": 0.1,
"additional_a3_amount_negotiation": 10.25
}
}

Resposta

Objeto responsável por representar resposta síncrona ao installments/negotiation

Response Schema: application/json

api_version required	string Retorna a ultima versão da api em questão.
transaction_id required	string Retorna o identificador de rastreabilidade de transação gerado pela API.
required	object Dados da resposta da API

application/json

{"value": {"api_version": "1.1.0",
"transaction_id": "707xaf60-1d8c-481d-910b-8cbe1f00a57e",
"data": {"general_info": {"response_type": "RETORNO_NEGOCIACAO_ATUALIZADA"
},
"borrower_info": {"cpf_cnpj": "12345678999",
"name": "João Silva"
},
"proposal_info": [{"proposal_status": "INADIMPLENTE",
"operation_tracking_id": "bjx837f2-d746-41fc-fd23-6d72b93d0385",
"proposal_id": 124451,
"product_id": 593,
"registration_info": [{"contract_id": "C18663W15031S12441",
"investment_amount": 2591.35,
"investor_id": "12345678999"
},
{"contract_id": "C18663W15031S12441",
"investment_amount": 2591.35,
"investor_id": "12345678999"
}
]
}
],
"general_installments_info": {"installments_number": 1,
"sum_installments_principal_amount": 1036.36,
"sum_installments_interest_amount": 27.98,
"sum_installments_amount": 1064.35,
"sum_additional_index_update": 0.56,
"sum_additional_late_fine": 21.28,
"sum_additional_late_contract_interest": 225.11,
"sum_additional_late_penalty_interest": 204.94,
"sum_additional_late_taxes": 1.45,
"sum_additional_collection_a1": 500.68,
"sum_additional_collection_a2": 904.69,
"sum_additional_collection_a3": 10.56,
"sum_discount_collection_d1": 248.24,
"sum_discount_collection_d2": 266.08,
"sum_discount_collection_d3": 10.75,
"sum_discount_pre_payment": 2.65,
"sum_installments_updated_amount": 2406.74,
"sum_installments_complement_info": {"sum_total_additional_items": 1866.72,
"sum_total_discount_items": 524.32,
"sum_additional_late_items": 451.33,
"sum_additional_not_late_items": 1415.35,
"sum_additional_collection_items": 1415.35,
"sum_discount_collection_items": 524.32
},
"sum_taxes_info": {"sum_investor_irrf": 274.07,
"sum_investor_iof": 54.67,
"sum_borrower_renegotiation_paid_iof": 3.14
}
},
"individual_installments_info": [{"proposal_id": 124451,
"installment_id": 5629033,
"deep_installment_id": 1,
"installment_status": "INADIMPLENTE",
"installment_number": 3,
"installment_due_date": "2022-07-01",
"installment_principal_amount": 1036.36,
"installment_interest_amount": 27.98,
"installment_base_amount": 1064.35,
"additional_index_update_value": 0.45,
"additional_late_fine": 21.28,
"additional_late_contract_interest": 225.11,
"additional_late_penalty_interest": 204.94,
"additional_late_taxes": 2.52,
"additional_collection_a1": 500.68,
"additional_collection_a2": 904.69,
"additional_collection_a3": 10.45,
"discount_collection_d1": 248.24,
"discount_collection_d2": 266.08,
"discount_collection_d3": 10.56,
"discount_pre_payment": 0.45,
"installment_updated_amount": 2406.74,
"installment_complement_info": {"installment_update_calculation_date": "2023-09-12",
"total_additional_items": 1866.72,
"total_discount_items": 524.32,
"additional_late_items": 451.34,
"additional_not_late_items": 1415.38,
"additional_collection_items": 1415.38,
"discount_collection_items": 524.32
},
"original_installment_info": {"original_installment_id": 132435,
"original_due_date": "2022-06-12",
"original_principal_amount": 936.31
},
"taxes_info": {"investor_irrf": 274.07,
"investor_iof": 2.34,
"borrower_renegotiation_paid_iof": 3.14
}
}
]
}
}
}

2. Simular renegociação

Requisição

application/json

{"request_info": {"calculation_date": "2023-06-23",
"persist_info": false,
"new_contract_product_id": 798,
"down_payment_value": 500,
"cancel_prepayment_discount": true,
"update_due_date": false,
"new_contract_maximum_iof_days": false,
"new_contract_apply_daily_iof": false,
"new_contract_apply_fixed_iof": false,
"new_contract_installment_cost_fixed": 120.00001,
"new_contract_cost_rate": 0.05001,
"new_contract_interest_monthly_rate": 0.01299,
"new_contract_anniversary_day": 12,
"new_contract_grace_period_number": 25,
"sum_iof_first_installment": true
},
"general_info_new_contract": {"installments_number_options": [{"installments_number": 3
},
{"installments_number": 4
},
{"installments_number": 6
}
]
},
"proposal_info": [{"proposal_id": 569784
},
{"operation_tracking_id": "73479fe1-f152-4943-b8d8-b3b4a5d6435"
}
],
"collection_policy": {"discount_d1_percent_charges": 0.1,
"discount_d2_percent_original": 0.1,
"discount_d3_amount_negotiation": 5.15,
"additional_a1_percent_after_charges": 0.1,
"additional_a2_percent_original": 0.1,
"additional_a3_amount_negotiation": 10.25
}
}

Resposta

Objeto responsável por representar resposta síncrona ao installments/contract/negotiation

Response Schema: application/json

api_version required	string Retorna a ultima versão da api em questão.
transaction_id required	string Retorna o identificador de rastreabilidade de transação gerado pela API.
required	object Dados da resposta da API

application/json

{"value": {"api_version": "1.1.0",
"transaction_id": "5ede6d79-f3aa-45e8-8960-dc312c372255",
"data": {"borrower_info": {"cpf_cnpj": "12345678000191",
"name": "Pizzaria do João Alegre Silva"
},
"general_info": {"response_type": "RETORNO_RENEGOCIACAO_CONTRATO_SOLICITADA"
},
"general_installments_info": {"installments_number": 14,
"sum_installments_principal_amount": 513936.7,
"sum_installments_interest_amount": 26457.14,
"sum_installments_amount": 544902.88,
"sum_additional_index_update": 888.98,
"sum_additional_late_fine": 65.95,
"sum_additional_late_contract_interest": 0.12,
"sum_additional_late_penalty_interest": 0.13,
"sum_additional_late_taxes": 316.62,
"sum_additional_collection_a1": 310.51,
"sum_additional_collection_a2": 312.13,
"sum_additional_collection_a3": 313.71,
"sum_discount_collection_d1": 311.72,
"sum_discount_collection_d2": 310.73,
"sum_discount_collection_d3": 314.74,
"sum_discount_pre_payment": 300.55,
"sum_installments_updated_amount": 371967.45,
"sum_installments_complement_info": {"sum_total_additional_items": 13134.03,
"sum_total_discount_items": 95252.3,
"sum_additional_late_items": 193.13,
"sum_additional_not_late_items": 13134.03,
"sum_additional_collection_items": 13134.03,
"sum_discount_collection_items": 95252.3
},
"sum_taxes_info": {"sum_investor_irrf": 7405.93,
"sum_investor_iof": 4167.36691,
"sum_borrower_renegotiation_paid_iof": 0
}
},
"individual_installments_info": [{"proposal_id": 15198,
"installment_id": 68220,
"installment_status": "PAGA",
"installment_number": 1,
"installment_due_date": "2023-05-20",
"installment_principal_amount": 44980.60948,
"installment_interest_amount": 200.53,
"installment_base_amount": 45488.2,
"additional_index_update_value": 280.13,
"additional_late_fine": 300.1,
"additional_late_contract_interest": 245.64,
"additional_late_penalty_interest": 245.64,
"additional_late_taxes": 362.98,
"additional_collection_a1": 123.33,
"additional_collection_a2": 124.44,
"additional_collection_a3": 122.22,
"discount_collection_d1": 100.02,
"discount_collection_d2": 111.13,
"discount_collection_d3": 112.13,
"discount_pre_payment": 150.35,
"installment_updated_amount": 142.35,
"installment_complement_info": {"installment_update_calculation_date": "2023-06-01",
"total_additional_items": 242.35,
"total_discount_items": 442.35,
"additional_late_items": 42.35,
"additional_not_late_items": 49.95,
"additional_collection_items": 41.95,
"discount_collection_items": 0
},
"original_installment_info": {"original_installment_id": 1,
"original_due_date": "2023-06-01",
"original_principal_amount": 0
},
"taxes_info": {"investor_irrf": 12.91,
"investor_iof": 13.12,
"borrower_renegotiation_paid_iof": 12.13
}
}
],
"installments_options_new_contract": [{"new_general_installments_info": {"installments_number": 2,
"sum_installments_principal_amount": 777286.48639,
"sum_installments_interest_amount": 27446.67361,
"sum_installments_amount": 804733.16
},
"new_individual_installments_info": [{"installments_number": 1,
"installment_due_date": "2023-07-01",
"installment_principal_amount": 393147.27544,
"installment_interest_amount": 9219.30456,
"installment_base_amount": 402366.58
}
]
}
],
"proposal_info": [{"proposal_id": 15198,
"operation_tracking_id": "1675dc2f-ea44-456b-8427-f7dade081d9c"
}
]
}
}
}

3. Formalizar renegociação

Requisição

application/json

{"request_info": {"calculation_date": "2023-06-23",
"new_contract_product_id": 798,
"cancel_prepayment_discount": false,
"down_payment_value": 500,
"update_due_date": false,
"new_contract_maximum_iof_days": false,
"new_contract_apply_daily_iof": false,
"new_contract_apply_fixed_iof": false,
"new_contract_installment_cost_fixed": 120.00001,
"new_contract_cost_rate": 0.05001,
"new_contract_interest_monthly_rate": 0.01299,
"new_contract_anniversary_day": 12,
"new_contract_grace_period_number": 25,
"contract_settlement": false,
"new_contract_settlement_is_financial": false,
"sum_iof_first_installment": true
},
"proposal_info": [{"replicate_guarantor": true,
"proposal_id": 569784
},
{"replicate_guarantor": true,
"operation_tracking_id": "73479fe1-f152-4943-b8d8-465d32bcd3cc"
}
],
"general_info_new_contract": {"installments_number_options": [{"installments_number": 3
},
{"installments_number": 4
},
{"installments_number": 6
}
]
},
"collection_policy": {"discount_d1_percent_charges": 0.1,
"discount_d2_percent_original": 0.1,
"discount_d3_amount_negotiation": 5.15,
"additional_a1_percent_after_charges": 0.1,
"additional_a2_percent_original": 0.1,
"additional_a3_amount_negotiation": 10.25
}
}

Resposta

Objeto responsável por representar resposta síncrona ao installments/general/negotiation

Response Schema: application/json

api_version required	string Retorna a ultima versão da api em questão.
transaction_id required	string Retorna o identificador de rastreabilidade de transação gerado pela API.
required	object Dados da resposta da API

application/json

{"value": {"api_version": "1.0.0",
"transaction_id": "593f33f6-6122-4624-8c1c-6602a14a730e",
"data": {"general_info": {"response_type": "RETORNO_RENEGOCIACAO_CONTRATO_CONSOLIDADO_SOLICITADA",
"operation_tracking_id": "23584256-6122-4624-8c1c-6602a14a533g"
},
"borrower_info": {"cpf_cnpj": "12345678000191",
"name": "Pizzaria do João Alegre Silva"
},
"proposal_info": [{"proposal_id": 569784,
"operation_tracking_id": "73479fe1-f152-4943-b8d8-465d32bcd3cc"
}
],
"general_installments_info": {"installments_number": 13,
"sum_installments_principal_amount": 485.85,
"sum_installments_interest_amount": 35.25,
"sum_installments_amount": 869.58,
"sum_additional_index_update": 888.98,
"sum_additional_late_fine": 65.95,
"sum_additional_late_contract_interest": 0.11,
"sum_additional_late_penalty_interest": 0.13,
"sum_additional_late_taxes": 0.14,
"sum_additional_collection_a1": 13.13,
"sum_additional_collection_a2": 13.12,
"sum_additional_collection_a3": 13.11,
"sum_discount_collection_d1": 15.15,
"sum_discount_collection_d2": 15.16,
"sum_discount_collection_d3": 15.17,
"sum_discount_pre_payment": 200.55,
"sum_installments_updated_amount": 869.58,
"sum_installments_complement_info": {"sum_total_additional_items": 132.12,
"sum_total_discount_items": 132.12,
"sum_additional_late_items": 134.12,
"sum_additional_not_late_items": 135.13,
"sum_additional_collection_items": 145.13,
"sum_discount_collection_items": 133.13
},
"sum_taxes_info": {"sum_investor_irrf": 0.15,
"sum_investor_iof": 0.14,
"sum_borrower_renegotiation_paid_iof": 0.13
}
},
"individual_installments_info": [{"proposal_id": 569784,
"installment_id": 12,
"installment_status": "A VENCER",
"installment_number": 14,
"installment_due_date": "2023-07-26",
"installment_principal_amount": 162.85,
"installment_interest_amount": 6.58,
"installment_base_amount": 169.44,
"additional_index_update_value": 280.13,
"additional_late_fine": 300.13,
"additional_late_contract_interest": 245.64,
"additional_late_penalty_interest": 245.64,
"additional_late_taxes": 362.98,
"additional_collection_a1": 123.33,
"additional_collection_a2": 124.44,
"additional_collection_a3": 122.22,
"discount_collection_d1": 100.15,
"discount_collection_d2": 111.41,
"discount_collection_d3": 112.32,
"discount_pre_payment": 150.35,
"installment_updated_amount": 142.35,
"installment_complement_info": {"installment_update_calculation_date": "2022-11-19",
"total_additional_items": 33.11,
"total_discount_items": 33.03,
"additional_late_items": 42.35,
"additional_not_late_items": 49.95,
"additional_collection_items": 41.95,
"discount_collection_items": 33.11
},
"original_installment_info": {"original_installment_id": 12,
"original_due_date": "2018-08-11",
"original_principal_amount": 350.5
},
"taxes_info": {"investor_irrf": 1.06,
"investor_iof": 1,
"borrower_renegotiation_paid_iof": 1
}
}
],
"installments_options_new_contract": [{"new_general_installments_info": {"installments_number": 5,
"sum_installments_principal_amount": 485.85,
"sum_installments_interest_amount": 35.25,
"sum_installments_amount": 869.58,
"new_general_installments_complement_info": {"interest_monthly_rate": 0.012,
"interest_annual_rate": 0.043,
"gross_costs_monthly_rate": 56.1,
"gross_costs_annual_rate": 3.22,
"operation_total_taxes": 45.31,
"operation_total_costs": 499.01,
"operation_gross_amount": 500.01
}
},
"new_individual_installments_info": [{"proposal_id": 569784,
"installment_number": 12,
"installment_due_date": "2011-05-20",
"installment_principal_amount": 328.31,
"installment_interest_amount": 200.51,
"installment_base_amount": 350.13
}
]
}
],
"bar_code_info": {"bar_code": "23793.38128 60005.706373 03000.050801 7 90770000168088",
"bar_code_url": "https://faturas.iugu.com/ee81ec24-351a-407a-9cf7-11985609ee76-3b9d"
},
"pix_info": {"pix_code": "00020101021226880014br.gov.bcb.pixXXX",
"pix_qrcode_url": "https://faturas.iugu.com/ee81ec24XXX"
},
"down_payment_info": {"down_payment_value": 500.01,
"down_payment_due_date": "2023-06-23",
"down_payment_installment_id_link": [{"installment_id": 10,
"installment_number": 3
}
]
}
}
}
}

4. Assinatura

Requisição

application/json

{"request_info": {"operation_tracking_id": "23584256-6122-4624-8c1c-6602a14a533g"
},
"token_info": {"token_number": "01010101010101"
},
"sign_info": {"cpf": "12345678910",
"email": "[email protected]",
"cell_phone": "11944785147",
"date": "2023-05-23T19:13:34Z",
"ip_address": "187.28.212.118",
"city": "Poços de Caldas",
"state": "MG",
"country": "Brasil",
"geolocation": "-2000.00,5000.22",
"device_manufacturer": "Marca",
"device_model": "Phone 13",
"device_os": "iOS",
"device_os_version": "15.5",
"signature_description": "Assinatura via app",
"document_description": "Cédula de Crédito Bancário",
"terms_content": "Ao avançar, eu declaro assinada, neste ato, a Cédula de Crédito Bancário deste link, considerando preenchidas as condições do crédito apresentadas",
"external_signature_id": "AJ48YH4"
}
}

Resposta

Histórico de edições

Version	Data	Notes
1.11	2023-05-25	Ajuste Payload Parcela Baixada Pagamento campos negotiation_original_proposal_id_1 e negotiation_original_proposal_id_2 como exemplos
1.12	2023-05-25	Ajuste dos descritivos dos campos da api de pagamentos.
1.13	2023-06-07	Ajuste dos descritivos mensagem 403 - endpoint:. installments [split negotiation contract/negotiation general/negotiation]