Buscar contrato e status do fluxo
GET
/partners-api/contracts/{product}/contract/{transaction_id}
Requisição
Parâmetros de Caminho
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/partners-api/contracts//contract/' \
--header 'X-Api-Key: <api-key>'Response Response Example
200 - Exemplo 1
{
"success": true,
"contract": {
"id": "string",
"transaction_id": "string",
"product": "string",
"document": "string",
"created_at": "2019-08-24T14:15:22.123Z",
"updated_at": "2019-08-24T14:15:22.123Z",
"contract_link": "string",
"terms_link": "string",
"signed_contract": "string",
"stage": "string",
"status_description": "string",
"summary_status": "string",
"summary_status_list": [
{
"stage": "string",
"summary_status": "string",
"timestamp": "2019-08-24T14:15:22.123Z"
}
],
"installments": 0,
"installment_value": 0,
"first_payment_date": "2019-08-24",
"external_signature_id": "string",
"id_transaction_bank_provider": "string",
"contract_number": 0,
"user_id": 0,
"seller": 0,
"store": 0,
"corban": 0,
"corban_pix": "string",
"subestablishment": 0,
"subestablishment_pix": "string",
"customer_data": {
"bank_code": "string",
"bank_account_type": "CAC",
"ispb_code": "string",
"politically_exposed_person": true,
"city": "string",
"number": "string",
"district": "string",
"street_name": "string",
"postal_code": "string",
"state": "string",
"occupation": "string",
"birth_date": "2019-08-24",
"name": "string",
"document": "string",
"nationality": "string",
"gender": "string",
"email": "string",
"country_code": "string",
"pix_key_type": "aleatory_key",
"pix_key": "string",
"phone_country_code": "string",
"phone_area_code": "string",
"phone_number": "string",
"bank_branch": "string",
"bank_account": "string",
"bank_account_digit": "string"
},
"contract_data": {
"simulation_id": "string",
"tac_amount": 0,
"tac_rate": 0,
"interest_rate_monthly": 0,
"disbursement_date": "2019-08-24",
"contract_payment_date": "2019-08-24T14:15:22.123Z",
"disbursed_amount": 0,
"installments": 0,
"first_payment_date": "2019-08-24",
"insurance_amount": 0,
"success": true,
"error": "string",
"reason": [
"string"
]
},
"signature_result": {
"meta_data": {},
"success": true,
"signature_score": 0,
"status_code": 0,
"signed_contract": "string",
"signature_folder": "string",
"error": "string",
"reason": [
"string"
]
},
"balance_check_result": {
"meta_data": {},
"balance_check_id": "string",
"balance_value": 0,
"job_description": "string",
"client_name": "string",
"birth_date": "2019-08-24",
"success": true,
"status": "string",
"message": "string",
"error": "string",
"reason": [
"string"
]
},
"scr_check_result": {
"meta_data": {},
"success": true
},
"ccb_creation_result": {
"meta_data": {},
"id_transaction_bank_provider": "string",
"payment_order_id": "string",
"contract_number": 0,
"success": true,
"error": "string",
"reason": [
"string"
]
},
"signature_submission_result": {
"success": true,
"id": "string",
"contract_link": "string",
"meta_data": {}
},
"signature_send_result": {
"meta_data": {},
"success": true,
"error": "string",
"reason": [
"string"
]
},
"contract_send_result": {
"document": "string",
"id": "string",
"success": true,
"contract_link": "string",
"error": "string",
"reason": [
"string"
]
},
"terms_send_result": {
"meta_data": {},
"success": true,
"error": "string",
"reason": [
"string"
]
},
"simulation_results": [
{
"meta_data": {},
"simulation_id": "string",
"table_name": "string",
"tac_rate": 0,
"disbursed_amount": 0,
"interest_rate_monthly": 0,
"disbursement_date": "2019-08-24",
"installments": 0,
"table_id": "string",
"success": true,
"first_payment_date": "2019-08-24",
"cet_monthly_rate": 0,
"installment_value": 0,
"cet_annual_rate": 0,
"total_value": 0,
"financed_amount": 0,
"insurance_amount": 0,
"commission": {
"commission_corban_trigger": 0,
"commission_corban": "string",
"commission_corban_value": "string",
"commission_corban_profit": "string",
"commission_sub": 0,
"commission_sub_value": 0,
"commission_store": 0,
"commission_store_value": 0,
"commission_seller": 0,
"commission_seller_value": 0,
"commission_total": "string"
},
"error": "string",
"reason": [
"string"
]
}
],
"contract_simulation_results": {
"meta_data": {},
"simulation_id": "string",
"table_name": "string",
"tac_rate": 0,
"disbursed_amount": 0,
"interest_rate_monthly": 0,
"disbursement_date": "2019-08-24",
"installments": 0,
"table_id": "string",
"success": true,
"first_payment_date": "2019-08-24",
"cet_monthly_rate": 0,
"installment_value": 0,
"cet_annual_rate": 0,
"total_value": 0,
"financed_amount": 0,
"insurance_amount": 0,
"commission": {
"commission_corban_trigger": 0,
"commission_corban": "string",
"commission_corban_value": "string",
"commission_corban_profit": "string",
"commission_sub": 0,
"commission_sub_value": 0,
"commission_store": 0,
"commission_store_value": 0,
"commission_seller": 0,
"commission_seller_value": 0,
"commission_total": "string"
},
"error": "string",
"reason": [
"string"
]
},
"commission_payment_result": {
"success": true,
"message": "string",
"contract_id": 0,
"commission_payment_date": "2019-08-24T14:15:22.123Z",
"transfers": [
{
"id": 0,
"entity_id": 0,
"value": "string",
"kind": "string",
"status": "string",
"updated_at": "2019-08-24T14:15:22.123Z"
}
],
"error": "string",
"reason": [
"string"
]
},
"registry_result": {
"success": true,
"reason": [
"string"
],
"status_description": "string"
},
"disbursement_result": {
"success": true,
"disbursement_receipt": "string",
"reason": [
"string"
]
},
"disbursement_reprocessing_result": {
"success": true,
"message": "string",
"error": "string",
"reason": [
"string"
]
},
"status_list": [
{
"stage": "string",
"status_description": "string",
"timestamp": "2019-08-24T14:15:22.123Z"
}
]
}
}