Consulta de Portabilidade de Origem

Recupera os dados do contrato de origem de uma portabilidade — o contrato que está sendo portado da instituição credora original.

É possível consultar os dados da portabilidade do banco de origem como, por exemplo, o número do benefício, a data de início da portabilidade, o número dos contratos excluídos, os valores das parcelas desaverbadas, ultima parcela paga, data de exclusão, entre outros.

        Request

• MÉTODO
  POST
• ENDPOINT
  /social_security/reservation/external_key/CREDIT-OPERATION-KEY/portability_origin_contract

        Payload:

payload.json

{
    "request_type":"portability_number",
    "portability_number": "202402070000298096242"
}

        Response

• MÉTODO
  POST
• ENDPOINT
  /social_security/reservation/external_key/CREDIT-OPERATION-KEY/portability_origin_contract

body.json

{
    "origin_contract_request_key": "9bb68c89-4b88-400d-9359-99ad8d42a69e",
    "status": "pending_search",
    "status_events": [
        {
            "status": "pending_search"
        }
    ]
}

Em caso de sucesso na consulta do número de benefício

         Webhook

• WEBHOOK_TYPE
  social_security_portability_origin_contract_request
• STATUS
  Success

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"
    }
}

Em caso de falha na consulta do número de benefício

        Webhook

• WEBHOOK_TYPE
  social_security_portability_origin_contract_request
• STATUS
  Failure

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"
    }
}