Consulta de portabilidade por conta

Request

ENDPOINT

/baas/pix/key_claim_request/account/ACCOUNT_KEY

MÉTODO

GET

Request Body

Path Params

Campo	Tipo	Descrição	Caracteres
account_key	string	chave de identificação da QIConta.	36

Query Params

Campo	Tipo	Descrição	Caracteres
page_number	integer	Página atual que está sendo consultada.	-
page_size	integer	Quantidade de resultados por página.	-
claim_status	string	Status da portabilidade. Caso não seja enviado, todas as portabiliades não concluidas serão listadas	Enumeradores

Enumeradores pix_key_type

Enumerador	Tradução
pending	pendente
opened	aberto
pending_confirmation	confirmação pendente
confirmed	confirmado
cancelled	cancelado
concluded	concluído
failed	falha
pending_donator_validation	validação de doador pendente
pending_claimer_validation	validaçao de pedinte pendente

Response

STATUS

200

Response Body

{
  "data": [
    {
        "account_key": "be0884bc-44a4-4907-8627-ef976e477aef",
        "cancellation_reason": null,
        "cancelled_by": null,
        "claim_flow_type": "donator",
        "claim_request_key": "be0884bc-44a4-4907-8627-ef976e477aef",
        "claim_status": "pending_confirmation",
        "claim_type": "portability",
        "claimant_account_branch": "9999",
        "claimant_account_number": "0",
        "claimant_document_number": "37059093800",
        "claimant_person_type": "natural",
        "confirmation_reason": null,
        "created_at": "2023-11-06T17:30:11",
        "donator_ispb": 32402502,
        "limit_conclusion_date": null,
        "limit_resolve_date": "2023-11-13T17:29:00",
        "max_conclusion_date": null,
        "max_resolution_date": "2023-11-13T17:29:00",
        "pix_key": "45574823098",
        "pix_key_claim_id": "205c72ab-c03e-43b7-a43d-2409e21fa5be",
        "pix_key_type": "cpf",
        "requester_key": "be0884bc-44a4-4907-8627-ef976e477aef"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": null,
    "rows_per_page": 10
  }
} 

STATUS

4XX

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

Código HTTP	Código QI code	Título title	Descrição (eng) Description	Descrição (ptbr) translation
400	PIX000071	Unknown Claim Request Status	Unknown claim_status {claim_status}.	claim_status {claim_status} não reconhecido.
403	PIX000054	Invalid Permission	Person {person_key} does not have administration roles for account {account_key}.	Pessoa {person_key} não tem credencial de administrador para a conta {account_key}.