INSS Webhooks
查询（福利列表与福利数据）
1. 查询福利列表
- WEBHOOK_TYPEsocial_security_benefits_request
- STATUSsuccess
Body:
body.json
{
"key": "d6c193f9-ed5e-42cc-9480-e48338766eb7",
"data": [
{
"grant_date": [
"2015-05-07"
],
"benefit_number": 7015686016,
"benefit_status": "elegible"
}
],
"status": "success",
"webhook_type": "social_security_benefits_request",
"event_datetime": "2024-09-19T22:11:30"
}
- WEBHOOK_TYPEsocial_security_benefits_request
- STATUSfailure
Body:
body.json
{
"key": "e571385f-06e7-4277-b2e6-b1ee0522ae44",
"data": {
"enumerator": "not_found_legal_representative",
"description": "beneficiary has a legal representative, but was not informed"
},
"status": "failure",
"webhook_type": "social_security_benefits_request",
"event_datetime": "2024-09-19T22:11:46"
}
2. 查询福利数据
- WEBHOOK_TYPEsocial_security_balance_request
- STATUSsuccess
Body:
body.json
{
"key": "720fc2b3-0fa7-4fb0-bea9-3c798ca8e595",
"data": {
"name": "NOME BENEFICIARIO",
"state": "RS",
"alimony": "not_payer",
"birth_date": "18021978",
"block_type": "not_blocked",
"grant_date": "2006-05-22",
"credit_type": "checking_account",
"benefit_card": {
"limit": 2259.2,
"balance": 0
},
"benefit_number": "1377902789",
"benefit_status": "elegible",
"payroll_card": {
"limit": 2259.2,
"balance": 0
},
"assistance_type": "retirement_invalidity_social_security",
"document_number": "81442882034",
"benefit_end_date": null,
"consigned_credit": {
"balance": 0
},
"benefit_situation": "active",
"last_inquiry_date": "2018-06-18",
"max_total_balance": 635.4,
"used_total_balance": 635.4,
"politically_exposed": {
"type": "not_politically_exposed",
"is_politically_exposed": false
},
"has_power_of_attorney": false,
"available_total_balance": 0,
"has_judicial_concession": false,
"number_of_portabilities": 0,
"disbursement_bank_account": {
"bank_code": "748",
"account_digit": "4",
"account_branch": "0155",
"account_number": "000070963"
},
"has_entity_representation": false,
"social_benefit_max_balance": 635.4,
"social_benefit_used_balance": 635.4,
"benefit_quota_expiration_date": null,
"number_of_active_reservations": 3,
"number_of_suspended_reservations": 0,
"number_of_refinanced_reservations": 0,
"number_of_active_suspended_reservations": 3
},
"status": "success",
"webhook_type": "social_security_balance_request",
"event_datetime": "2024-09-02T18:49:02"
}
- WEBHOOK_TYPEsocial_security_balance_request
- STATUSfailure
Body:
body.json
{
"key": "70130c68-7e91-41a9-8dc5-11ad876f36d2",
"data": {
"enumerator": "not_found_legal_representative",
"description": "beneficiary has a legal representative, but was not informed"
},
"status": "failure",
"webhook_type": "social_security_balance_request",
"event_datetime": "2024-09-02T18:57:25"
}
可携性 IN + 再融资
1. 发行可携性 + 再融资债务
- WEBHOOK_TYPEcredit_transfer.proposal.credit_operation
- CREDIT_OPERATION_TYPEportability
- CREDIT_OPERATION_STATUSissued
Body:
body.json
{
"data": {
"document_key": "91210cb0-2cd2-4508-98b5-ff16dbda27af",
"signed_document_url": "https://storage.googleapis.com/live-doc-api/documents/91210cb0-2cd2-4508-98b5-ff16dbda27af/contrato_signed.pdf",
"credit_operation_key": "6f71be3f-3814-4f1d-b015-c234755935f8",
"credit_operation_type": "portability",
"credit_operation_status": "issued"
},
"proposal_key": "22191e35-5d29-4d55-92db-0920f90b5747",
"webhook_type": "credit_transfer.proposal.credit_operation",
"event_datetime": "2024-10-01T10:10:32"
}
- WEBHOOK_TYPEcredit_transfer.proposal.credit_operation
- CREDIT_OPERATION_TYPErefinancing
- CREDIT_OPERATION_STATUSissued
Body:
body.json
{
"data": {
"document_key": "91210cb0-2cd2-4508-98b5-ff16dbda27af",
"signed_document_url": "https://storage.googleapis.com/live-doc-api/documents/91210cb0-2cd2-4508-98b5-ff16dbda27af/CONTRATO_signed.pdf",
"credit_operation_key": "cbaaa1da-7610-4eba-9a48-8728b0be8f34",
"credit_operation_type": "refinancing",
"credit_operation_status": "issued"
},
"proposal_key": "91210cb0-2cd2-4508-98b5-ff16dbda27af",
"webhook_type": "credit_transfer.proposal.credit_operation",
"event_datetime": "2024-10-01T10:10:38"
}
2. 可携性状态
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSpending_acceptance
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "6bd4f3cc-5787-4e4c-a6ba-3748883394cd",
"proposal_status": "pending_acceptance",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"portability_number": "202211230000246536429",
"inclusion_date": "2022-11-24",
"due_balance_expected_return_date": "2022-12-01"
}
}
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSaccepted
Body:
body.json
{
"data": {
"final_due_balance": 5558.4,
"original_contract": {
"cet": 26.11,
"interest": 22.1311,
"total_iof": 218.4,
"contract_date": "2022-06-15",
"last_due_date": "2029-07-07",
"final_due_date": "2024-10-08",
"first_due_date": "2024-11-07",
"amortization_type": "pre_price",
"final_due_balance": 5558.4,
"effective_interest": 22.1311,
"installment_number": 84,
"origin_ispb_number": "00360305",
"origin_operation_type": "payroll",
"corban_document_number": null,
"installment_face_value": 148.07,
"origin_contract_number": "0000000000000000000000000000000001899642",
"opened_installment_number": 57,
"overdue_installment_number": 0
},
"portability_number": "202410010000341749111"
},
"proposal_key": "1860a994-a3aa-4456-9b14-3aa35c97797a",
"webhook_type": "credit_transfer.proposal",
"event_datetime": "2024-10-08T07:18:23",
"proposal_status": "accepted"
}
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUScanceled
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_status": "canceled",
"proposal_key": "3130d43f-4f60-49c6-806e-61b4c9cb3a14",
"event_datetime": "2022-11-24T15:42:12"
}
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSretained
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "3130d43f-4f60-49c6-806e-61b4c9cb3a14",
"proposal_status": "retained",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"retained_reason": {
"reason": "issuer_retention",
"description": "Retenção do Cliente"
}
}
}
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSrejected
Body:
body.json
{
"webhook_type": "credit_transfer.proposal",
"proposal_key": "91210cb0-2cd2-4508-98b5-ff16dbda27af",
"proposal_status": "rejected",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"error": {
"code": "ECTC0023",
"reason": "Contrato com portabilidade em andamento"
}
}
}
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSsettlement_sent
Body:
body.json
{
"data": {
"receipt": {
"fee": 0,
"amount": 5558.4,
"origin": {
"name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.",
"type": "payment_account",
"branch": "0001",
"document": "32402502000135",
"bank_code": "329",
"account_key": "792e04a3-566d-489d-9c5a-8385f7dc76b0",
"branch_digit": null,
"account_digit": "6",
"account_number": "1000111"
},
"timestamp": "2024-10-08T07:19:39",
"description": "104 1620 - 00360305000104 - CAIXA ECONOMICA FEDERAL",
"destination": {
"name": "CAIXA ECONOMICA FEDERAL",
"type": "checking_account",
"branch": "1620",
"purpose": "Saída Liquidação de Portabilidade",
"document": "00360305000104",
"bank_code": "104",
"branch_digit": null,
"account_digit": null,
"account_number": null
},
"ted_receipt_url": "https://storage.googleapis.com/live-doc-api/documents/5aa5026.pdf",
"transaction_key": "8a76b511-96c9-4b0f-a9b3-5405d400e00a",
"ted_receipt_document_key": "5aa5026d-e78f-4781-9c4e-e2cf21425a3c"
}
},
"proposal_key": "3130d43f-4f60-49c6-806e-61b4c9cb3a14",
"webhook_type": "credit_transfer.proposal",
"event_datetime": "2024-10-08T07:19:39",
"proposal_status": "settlement_sent"
}
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSpending_settlement_confirmation
Body:
body.json
{
"proposal_key": "3130d43f-4f60-49c6-806e-61b4c9cb3a14",
"webhook_type": "credit_transfer.proposal",
"event_datetime": "2024-10-08T07:20:18",
"proposal_status": "pending_settlement_confirmation"
}
- WEBHOOK_TYPEcredit_transfer.proposal
- STATUSpaid
Body:
body.json
{
"proposal_key": "1860a994-a3aa-4456-9b14-3aa35c97797a",
"webhook_type": "credit_transfer.proposal",
"event_datetime": "2024-10-09T09:14:19",
"proposal_status": "paid"
}
3. 批注状态（尝试与成功）
可携性
- WEBHOOK_TYPEcredit_transfer.proposal.collateral
- CREDIT_OPERATION_TYPEportability
- STATUSpending_reservation
- COLLATERAL_CONSTITUTEDfalse
- RESERVATION_METHODnew_credit
Body:
body.json
{
"data": {
"collateral_data": {
"status": "pending_reservation",
"last_response": {
"errors": [
{
"enumerator": "consignable_margin_excceded"
}
]
},
"reservation_method": "new_credit",
"last_response_event_datetime": "2024-10-08T10:19:32Z"
},
"collateral_type": "social_security",
"credit_operation_key": "6f71be3f-3814-4f1d-b015-c23475593987",
"credit_operation_type": "portability",
"collateral_constituted": false
},
"proposal_key": "6bd4f3cc-5787-4e4c-a6ba-3748883394cd",
"webhook_type": "credit_transfer.proposal.collateral",
"event_datetime": "2024-10-08T07:19:32"
}
- WEBHOOK_TYPEcredit_transfer.proposal.collateral
- STATUSpending_reservation
- CREDIT_OPERATION_TYPEportability
- COLLATERAL_CONSTITUTEDfalse
- RESERVATION_METHODportability
Body:
body.json
{
"data": {
"collateral_data": {
"status": "pending_reservation",
"last_response": {
"errors": [
{
"enumerator": "consignable_margin_excceded"
}
]
},
"reservation_method": "portability",
"last_response_event_datetime": "2024-10-09T00:00:26Z"
},
"collateral_type": "social_security",
"credit_operation_key": "6f71be3f-3814-4f1d-b015-c234755935f8",
"credit_operation_type": "portability",
"collateral_constituted": false
},
"proposal_key": "3130d43f-4f60-49c6-806e-61b4c9cb3a14",
"webhook_type": "credit_transfer.proposal.collateral",
"event_datetime": "2024-10-08T21:02:29"
}
- WEBHOOK_TYPEcredit_transfer.proposal.collateral
- STATUSpending_reservation
- CREDIT_OPERATION_TYPEportability
- COLLATERAL_CONSTITUTEDtrue
- RESERVATION_METHODportability
Body:
body.json
{
"data": {
"collateral_data": {
"reservation_method": "portability"
},
"collateral_type": "social_security",
"credit_operation_key": "6f71be3f-3814-4f1d-b015-c234755935f8",
"credit_operation_type": "portability",
"collateral_constituted": true
},
"proposal_key": "3130d43f-4f60-49c6-806e-61b4c9cb3a14",
"webhook_type": "credit_transfer.proposal.collateral",
"event_datetime": "2024-10-09T16:49:50"
}
再融资
- WEBHOOK_TYPEcredit_transfer.proposal.collateral
- STATUSpending_reservation
- CREDIT_OPERATION_TYPErefinancing
- COLLATERAL_CONSTITUTEDtrue
- RESERVATION_METHODrefinancing
Body:
body.json
{
"data": {
"collateral_data": {
"reservation_method": "refinancing"
},
"collateral_type": "social_security",
"credit_operation_key": "cbaaa1da-7610-4eba-9a48-8728b0be8f34",
"credit_operation_type": "refinancing",
"collateral_constituted": true
},
"proposal_key": "3130d43f-4f60-49c6-806e-61b4c9cb3a14",
"webhook_type": "credit_transfer.proposal.collateral",
"event_datetime": "2024-10-09T16:50:12"
}
4. 再融资放款（找零）
- WEBHOOK_TYPEcredit_transfer.proposal.credit_operation
- CREDIT_OPERATION_TYPErefinancing
- CREDIT_OPERATION_STATUSdisbursed
Body:
body.json
{
"data": {
"credit_operation_key": "cbaaa1da-7610-4eba-9a48-8728b0be8111",
"transaction_receipts": [
{
"fee": 0,
"url": "https://storage.googleapis.com/live-doc-api/documents/26ff118e-52c0-4092-bdbd-9d8253.pdf",
"amount": 924.61,
"origin": {
"name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.",
"type": "payment_account",
"branch": "0001",
"document": "32402502000135",
"bank_code": "329",
"account_key": "792e04a3-566d-489d-9c5a-8385f7dc76b0",
"branch_digit": null,
"account_digit": "6",
"account_branch": "0001",
"account_number": "1000789",
"financial_institution_name": "QI SCD S.A."
},
"timestamp": "2024-10-09T19:51:34",
"description": "DESCRICAO",
"destination": {
"name": "JOSE HENRIQUE DA SILVA",
"type": "checking_account",
"branch": "1621",
"purpose": "Crédito PIX em Conta",
"document": "79202603022",
"bank_ispb": "00360305",
"branch_digit": null,
"account_digit": "3",
"account_number": "763804111",
"financial_institution_name": "CAIXA ECONOMICA FEDERAL"
},
"end_to_end_id": "E32402502202410091950saI7VCHPrlB",
"transaction_key": "2109e1d6-8c89-401b-9ff0-751d42b45e43",
"origin_transaction_key": "d99f633b-1cec-4469-8ae6-61642931b475"
}
],
"credit_operation_type": "refinancing",
"credit_operation_status": "disbursed"
},
"proposal_key": "3130d43f-4f60-49c6-806e-61b4c9cb3a14",
"webhook_type": "credit_transfer.proposal.credit_operation",
"event_datetime": "2024-10-09T16:51:34"
}
- WEBHOOK_TYPEcredit_transfer.proposal.credit_operation
- CREDIT_OPERATION_TYPErefinancing
- CREDIT_OPERATION_STATUScanceled
Body:
body.json
{
"webhook_type": "credit_transfer.proposal.credit_operation",
"proposal_key": "3130d43f-4f60-49c6-806e-61b4c9cb3a14",
"event_datetime": "2022-11-24T15:42:12",
"data": {
"credit_operation_status": "canceled",
"credit_operation_type": "refinancing",
"credit_operation_key": "1a1a44df-29b6-431c-89af-53657d906333",
"pix_refusal": {
"reason_enumerator": "invalid_document_number",
"reason": "CPF/CNPJ do usuário recebedor não é compatível com o titular da conta de destino."
},
"cancel_reason": "pix_refusal"
}
}
5. 查询来源可携性合同
- WEBHOOK_TYPEsocial_security_portability_origin_contract_request
- statussuccess
Body:
body.json
{
"webhook": {
"key": "25e93655-4713-488b-8800-7ac4fddf745f",
"data": {
"portability_number": 9223372036854776000,
"portability_status": "open",
"benefit_number": 1544326820,
"portability_start_date": "2024-02-22",
"deleted_contracts": [
{
"origin_bank": {
"bank_code": 752,
"name": "CETELEM-BNP"
},
"contract_number": "22-844817807/20",
"last_installment_paid": 84,
"exclusion_date": "22022024",
"period_amount": 165.73
}
]
},
"status": "success",
"webhook_type": "social_security_portability_origin_contract_request",
"event_datetime": "2024-02-26T21:36:22"
}
}
- WEBHOOK_TYPEsocial_security_portability_origin_contract_request
- statusfailure
Body:
body.json
{
"webhook": {
"key": "522b5d7d-2dfc-4e92-99b7-d4df3d97edb2",
"data": {
"enumerator": "invalid_bank_code",
"description": "Invalid bank code"
},
"status": "failure",
"webhook_type": "social_security_portability_origin_contract_request",
"event_datetime": "2024-02-26T21:36:22"
}
}
新信贷
1. 债务状态
- WEBHOOK_TYPEdebt
- STATUSsignature_finished
Body:
body.json
{
"key": "ebe12ca1-ec34-4674-bd62-24c0bc204e81",
"status": "signature_finished",
"webhook_type": "debt",
"event_datetime": "2024-09-02 18:39:49",
"signed_contract_url": "https://storage.googleapis.com/live-doc-api/documents/6099edd7-1c83-4890-998e-ce60e218523cb/S_signed.pdf"
}
- WEBHOOK_TYPEdebt
- STATUSdisbursed
Body:
body.json
{
"key": "b91ee4cd-85fd-4548-b03f-31024fc5d285",
"data": {
"installments": [
{
"due_date": "2024-12-10",
"total_amount": 116.76,
"installment_key": "dc3a5877-6860-42cd-b885-c4ca84b69546",
"pre_fixed_amount": 116.76,
"principal_amortization_amount": 0
},
{
"due_date": "2025-01-10",
"total_amount": 116.76,
"installment_key": "1ca2c016-1bc4-4f64-a681-17699a90e27d",
"pre_fixed_amount": 79.96557434,
"principal_amortization_amount": 36.79442566
},
{
"due_date": "2025-02-10",
"total_amount": 116.76,
"installment_key": "9f11bd0e-60f1-4d0c-9882-e6196e279f7a",
"pre_fixed_amount": 66.16762896,
"principal_amortization_amount": 50.59237104
},
{
"due_date": "2025-03-10",
"total_amount": 116.76,
"installment_key": "0ed43a28-9324-41d1-84b3-fb41940c02e2",
"pre_fixed_amount": 57.20192546,
"principal_amortization_amount": 59.55807454
},
{
"due_date": "2025-04-10",
"total_amount": 116.76,
"installment_key": "1da0b291-9e15-41a5-8aa6-86d733af6195",
"pre_fixed_amount": 60.33833893,
"principal_amortization_amount": 56.42166107
},
{
"due_date": "2025-05-10",
"total_amount": 116.76,
"installment_key": "e884d447-31ea-4847-b479-eac11baeac96",
"pre_fixed_amount": 55.45582536,
"principal_amortization_amount": 61.30417464
},
{
"due_date": "2025-06-10",
"total_amount": 116.76,
"installment_key": "ab16369b-c551-4a0e-84e4-b5f2a6161c1d",
"pre_fixed_amount": 54.10815043,
"principal_amortization_amount": 62.65184957
},
{
"due_date": "2025-07-10",
"total_amount": 116.76,
"installment_key": "64db51eb-47c9-4f44-86e0-35ca054fc2f8",
"pre_fixed_amount": 49.1128602,
"principal_amortization_amount": 67.6471398
},
{
"due_date": "2025-08-10",
"total_amount": 116.76,
"installment_key": "5035ee8e-8462-4b54-9598-de7a269103a4",
"pre_fixed_amount": 47.21257597,
"principal_amortization_amount": 69.54742403
},
{
"due_date": "2025-09-10",
"total_amount": 116.76,
"installment_key": "233da01d-8ec4-4c60-8096-01a702af9b71",
"pre_fixed_amount": 43.53204519,
"principal_amortization_amount": 73.22795481
},
{
"due_date": "2025-10-10",
"total_amount": 116.76,
"installment_key": "1d4bf5b2-5ff1-49c3-8a4a-ddf90fe5c370",
"pre_fixed_amount": 38.34531007,
"principal_amortization_amount": 78.41468993
},
{
"due_date": "2025-11-10",
"total_amount": 116.76,
"installment_key": "a5211802-15b6-4245-afe2-8e5dcfde2e96",
"pre_fixed_amount": 35.5069396,
"principal_amortization_amount": 81.2530604
},
{
"due_date": "2025-12-10",
"total_amount": 116.76,
"installment_key": "886e7907-f46e-45c7-bb9c-c66dd87050e0",
"pre_fixed_amount": 30.17493687,
"principal_amortization_amount": 86.58506313
},
{
"due_date": "2026-01-10",
"total_amount": 116.76,
"installment_key": "4e82409c-1769-4555-86bd-527d585d0f88",
"pre_fixed_amount": 26.62475039,
"principal_amortization_amount": 90.13524961
},
{
"due_date": "2026-02-10",
"total_amount": 116.76,
"installment_key": "e226d32f-33ec-4a20-ad60-96a0ec3216d7",
"pre_fixed_amount": 21.85468788,
"principal_amortization_amount": 94.90531212
},
{
"due_date": "2026-03-10",
"total_amount": 116.76,
"installment_key": "710e51e3-9720-4b6a-a383-569736781e28",
"pre_fixed_amount": 15.16506862,
"principal_amortization_amount": 101.59493138
},
{
"due_date": "2026-04-10",
"total_amount": 116.76,
"installment_key": "88cba573-627d-4ca0-b39e-0fcc20f22422",
"pre_fixed_amount": 11.45566586,
"principal_amortization_amount": 105.30433414
},
{
"due_date": "2026-05-10",
"total_amount": 116.76,
"installment_key": "0e51f217-21c8-4897-baee-2bd2aad43d22",
"pre_fixed_amount": 5.59829551,
"principal_amortization_amount": 111.16170449
}
],
"ted_receipt_list": [
{
"fee": 0,
"url": "https://storage.googleapis.com/live-doc-api/documents/304b5b46-08e5-4.pdf",
"amount": 1000,
"origin": {
"name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.",
"type": "payment_account",
"branch": "0001",
"document": "32402502000135",
"bank_code": "329",
"account_key": "836ce4ef-855b-4672-bc52-36e32e22ec05",
"branch_digit": null,
"account_digit": "1",
"account_branch": "0001",
"account_number": "00852",
"financial_institution_name": "QI SCD S.A."
},
"timestamp": "2024-10-14T03:09:17",
"description": "DESCRICAO",
"destination": {
"name": "DEVEDOR",
"type": "checking_account",
"branch": "0648",
"purpose": "Crédito PIX em Conta",
"document": "04973666068",
"bank_ispb": "90400888",
"branch_digit": null,
"account_digit": "7",
"account_number": "25252",
"financial_institution_name": "BCO SANTANDER (BRASIL) S.A."
},
"end_to_end_id": "E3240250220241014030292IkYMOt523",
"transaction_key": "797ab666-07c4-4702-a68b-1d67afb34534",
"origin_transaction_key": "af8aa38f-8a49-45bd-9878-101cefe9bdd4"
}
],
"requester_identifier_key": "70675b9fe09da90c8b5c992"
},
"status": "disbursed",
"webhook_type": "debt",
"event_datetime": "2024-10-14 03:09:17"
}
- WEBHOOK_TYPEdebt
- STATUScanceled
Body:
body.json
{
"webhook": {
"key": "dfdf8cde-eb49-437a-a798-bb90eec03af8",
"data": {
"cancel_reason": "Operacao cancelada manualmente",
"cancel_reason_enumerator": "manual"
},
"status": "canceled",
"webhook_type": "debt",
"event_datetime": "2024-09-02 18:40:12"
}
}
body_pix_refusal.json
{
"key": "3fee13aa-a193-4444-a39a-097de8f824bf",
"data": {
"pix_refusal": {
"reason": "A conta de destino encontra-se bloqueada.",
"reason_enumerator": "blocked_account",
"cancel_reason_enumerator": "blocked_account"
},
"cancel_reason": "pix_refusal",
"cancel_reason_enumerator": "pix_refusal"
},
"status": "canceled",
"webhook_type": "debt",
"event_datetime": "2024-09-02 18:40:40"
}
body_ted_refusal.json
{
"status": "canceled",
"key": "3fee13aa-a193-4444-a39a-097de8f824bf",
"data": {
"ted_refusal": {
"transaction_key": "16faabfc-3876-437d-a4f6-aae17a1d68c9",
"description": "341 0000 000000-7 12345678900 - NOME BENEFICIÁRIO",
"origin": {
"account_key": "a1d2dea5-fa90-4676-a125-da355fdc3ed0",
"account_number": "00086",
"bank_code": "329",
"name": "ACCOUNT TRANSITORY",
"type": "payment_account",
"document": "32402502000135",
"branch_digit": null,
"account_digit": "8",
"branch": "0001"
},
"fee": 0,
"reason_enumerator": "agencia_conta_invalida",
"timestamp": "2022-11-07T14:36:05",
"amount": 483.6,
"reason": "Agência ou Conta Destinatária do Crédito Inválida",
"destination": {
"branch": "0000",
"account_number": "000000",
"name": "NOME BENEFICIÁRIO",
"purpose": "Crédito em Conta",
"type": "checking_account",
"branch_digit": null,
"document": "12345678900",
"bank_code": "341",
"account_digit": "7"
}
},
"cancel_reason": "ted_refusal"
}
}
- WEBHOOK_TYPEdebt
- STATUScanceled_permanently
Body:
body.json
{
"key": "cf416a66-8e4c-4ac9-a3ee-d529e49acaf4",
"status": "canceled_permanently",
"webhook_type": "debt",
"event_datetime": "2024-09-02 18:39:56"
}
2. 批注状态
- WEBHOOK_TYPEdebt
- STATUScredit_operation.collateral
- COLLATERAL_CONSTITUTEDtrue
Body:
body.json
{
"key": "2dabec49-780d-4742-a81b-a5b40a837386",
"data": {
"collateral_data": {},
"collateral_type": "social_security",
"collateral_constituted": true
},
"event_time": "2024-10-14 02:46:01",
"webhook_type": "credit_operation.collateral"
}
- WEBHOOK_TYPEdebt
- STATUScredit_operation.collateral
- COLLATERAL_CONSTITUTEDfalse
Body:
body.json
{
"key": "2dabec49-780d-4742-a81b-a5b40a837386",
"data": {
"collateral_data": {},
"collateral_type": "social_security",
"collateral_constituted": false
},
"event_time": "2024-10-14 08:46:01",
"webhook_type": "credit_operation.collateral"
}
可 携性 Out
1. 接收可携性攻击通知
- WEBHOOK_TYPEcredit_transfer.received_portability
- RECEIVED_PORTABILITY_STATUSreceived
Body:
body.json
{
"webhook_type": "credit_transfer.received_portability",
"received_portability_status": "received",
"received_portability_key": "673d2872-c6c9-4075-b9ab-4525bcbe4aa1",
"event_datetime": "2022-07-24T18:29:45",
"data": {
"annual_interest_rate": 1,
"annual_effective_interest_rate": 1,
"number_of_installments": 6,
"installment_face_value": 201.71,
"phone_number": "(05)541997558",
"address": {
"street": "Rua Longe de Casa",
"city": "Rio de Janeiro",
"state": "RJ",
"number": "112",
"postal_code": "38300569"
},
"due_balance": 1000,
"due_balance_date": "2022-07-29",
"issuer_name": "A Random Name",
"issuer_document_number": "37197645832",
"reference_date": "2022-08-01",
"contract_number": "0000049045/UO",
"origin_credit_operation_key": "key",
"retention_limit_date": "2022-08-03",
"due_balance_limit_date": "2022-08-08",
"portability_number": "202207150000001642808",
"corban_document_number": "08289470514408",
"source_ispb_number": "0"
}
}
2. 状态
- WEBHOOK_TYPEcredit_transfer.received_portability
- RECEIVED_PORTABILITY_STATUSwaiting_settlement
Body:
body.json
{
"webhook_type": "credit_transfer.received_portability",
"received_portability_key": "673d2872-c6c9-4075-b9ab-4525bcbe4aa1",
"received_portability_status": "waiting_settlement",
"event_datetime": "2022-07-24T18:29:45",
"data": {
"settlement_due_balance": 120.00,
"settlement_date": "2022-08-02"
}
}
- WEBHOOK_TYPEcredit_transfer.received_portability
- RECEIVED_PORTABILITY_STATUScanceled_by_proponent
Body:
body.json
{
"webhook_type": "credit_transfer.received_portability",
"received_portability_key": "673d2872-c6c9-4075-b9ab-4525bcbe4aa1",
"received_portability_status": "canceled_by_proponent",
"event_datetime": "2022-07-24T18:29:45",
"data": {}
}
- WEBHOOK_TYPEcredit_transfer.received_portability
- RECEIVED_PORTABILITY_STATUSsettled
Body:
body.json
{
"webhook_type": "credit_transfer.received_portability",
"received_portability_key": "673d2872-c6c9-4075-b9ab-4525bcbe4aa1",
"received_portability_status": "settled",
"event_datetime": "2022-07-24T18:29:45Z",
"data": {}
}
- WEBHOOK_TYPEcredit_transfer.received_portability
- RECEIVED_PORTABILITY_STATUScanceled_by_creditor
Body:
body.json
{
"webhook_type": "credit_transfer.received_portability",
"received_portability_key": "673d2872-c6c9-4075-b9ab-4525bcbe4aa1",
"received_portability_status": "canceled_by_creditor",
"event_datetime": "2022-07-24T18:29:45",
"data": {
"canceled_reason": {
"enumerator": "not_paid",
"description": "Decurso de prazo por STR não paga dentro do prazo"
}
}
}