Pular para o conteúdo principal

Portabilidade Out (Ataque de portabilidade)

Atenção!

Os webhooks da QI Tech não devem ser mapeadas de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.

1. Notificação de recebimento de portabilidade out (ataque de portabilidade)​

Assim que uma solicitação de portabilidade for recepcionada pela QI SCD no CTC (Central de Transferência de Crédito), o parceiro será notificado através do seguinte webhook:

WEBHOOK_TYPE
credit_transfer.received_portability
STATUS
Received
Webhook Body
{
    "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. Resposta ao ataque de portabilidade​

2.1. Retenção de contrato​

Caso haja o sucesso na retenção do cliente o parceiro realizará uma chamada informando sobre a rentenção do contrato até as 22h do 4° dia útil após o recebimento do webhook de notificação de ataque de portabilidade (credit_transfer.received_portability).

Para retenção do contrato o parceiro deverá enviar o documento comprobatório de retenção do cliente no endpoint de upload de documentos.

ENDPOINT
/credit_transfer/received_portability/[received_portability_key]
MÉTODO
PATCH
Request Body
{
	"received_portability_status": "retained",
	"retention_reason": "issuer_retention",
    "document_key": "cfbc8469-89ea-4a80-9f64-ba7b1566c68b",
    "document_url": "https://storage.googleapis.com/sandbox-doc-api/documents/cfbc8469-89ea-4a80-9f64-ba7b1566c68b/documento.jpeg",
    "document_type": "received_portability_retention_proof"
}

Enumeradores Retention Reason​

EnumeradorDescrição
issuer_retentionRetenção do Cliente
issuer_lawsuitCliente com ação judicial
portability_not_requestedO cliente não solicitou a portabilidade

2.2 Aprovação de portabilidade out​

Caso o cliente não seja retido o parceiro deve informar sobre a não retenção até as 10:00 do 4o. dia útil após o recebimento da notificação de ataque de portabilidade (credit_transfer.received_portability).

Atenção

Caso a solicitação de portabilidade não seja respondida em até 4 dias úteis, a QI Tech retornará o saldo devedor da operação ao proponente (solicitante da portabilidade).

ENDPOINT
/credit_transfer/received_portability/[received_portability_key]
MÉTODO
PATCH
Request Body
{
	"received_portability_status": "accepted_by_creditor"
}

3. Consultando solicitações de portabilidade out (ataque de portabilidade)​

3.1. Consulta de solicitação de portabilidade​

ENDPOINT
/credit_transfer/received_portability/[received_portability_key]
MÉTODO
GET
Response Body
{
	"received_portability_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036",
	"received_portability_status": "accepted",
	"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",
	"retention_reason": null,
	"canceled_reason": null,
    "corban_document_number": "08289470514408"
}

3.2. Listar solicitação de portabilidade​

ENDPOINT
/credit_transfer/received_portability
MÉTODO
GET
PARÂMETROS
settlement_date, max_portability_date, due_balance_limit_date, received_portability_status, portability_number, contract_number, credit_operation_key
Response Body
{
	"data": [{
		"received_portability_key": "e3bedf31-1e87-4ba4-a36c-d52f7f5c9036",
		"received_portability_status": "accepted",
		"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",
		"retention_reason": null,
		"canceled_reason": null
	}],
	"pagination": {
		"next_page": null,
		"current_page": 1,
		"total_rows": 0,
		"rows_per_page": 1,
		"total_pages": 0
	}
}

Enumeradores Received Portability Status​

EnumeradorDescrição
receivedRecebido
canceled_by_proponentCancelado pelo Proponente
canceled_by_creditorCancelado pelo Credor Original
retainedRetido
retention_receivedRetenção recebida
accepted_by_creditorAprovado pelo Originador
waiting_settlementPortabilidade aprovada esperando liquidação
settledLiquidado
accepted_automaticallyPortabilidade aprovada automaticamente

4. Webhooks​

Após a resposta da solicitação de portabilidade out (ataque de portabilidade) pelo parceiro, a proposta seguirá pelos seguintes status:

4.1. Aguardando pagamento do saldo devedor​

WEBHOOK_TYPE
credit_transfer.received_portability
STATUS
waiting_settlement
Webhook Body
{
  "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"
  }
}

4.2. Proposta cancelada pelo proponente​

WEBHOOK_TYPE
credit_transfer.received_portability
STATUS
canceled_by_proponent
Webhook Body
{
  "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": {}
}

4.3. Portabilidade liquidada​

WEBHOOK_TYPE
credit_transfer.received_portability
STATUS
settled
Webhook Body
{
  "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": {}
}

4.4. Portabilidade não liquidada​

Caso o proponente não realiza o pagamento do saldo devedor retornado na resposta da portabilidade out (ataque de portabilidade), a proposta será cancelada por falta de pagamento dentro do prazo.

WEBHOOK_TYPE
credit_transfer.received_portability
STATUS
canceled_by_creditor
Webhook Body
{
  "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"
   }
  }
}