Skip to main content

Simulating the Completion of a Portability Request

Request

ENDPOINT
/mock/pix_keys/key_claim_simulation/CLAIM_REQUEST_KEY /complete
METHOD
PATCH

Path params

FieldTypeDescription
claim_request_keystringthe key of the portability request.
Request Body
{}

Response

STATUS
204
Response Body
{}
STATUS
4XX
Response Body: Error
{
"title": "title",
"description": "description in English",
"translation": "description in Portuguese",
"code": "code",
"extra_fields": {}
}
HTTP CodeQI Code
code
Title
title
Description
Description
Translation
translation
404PIX000034Claim Request not foundClaim Request not found. claim_request_key: 7f8b67d2-d8e4-4759-85eb-e4d0ac24708c external_key: b8e25f24-4051-4b13-90a7-76be7b6e96d2.Pedido de portabilidade não encontrado.
400PIX000046Portability action not allowed in current statusAction concluded for claim request allowed only for status confirmedAção de portabilidade não permitida no status atual.
400PIX000036Action not allowed for claimerAction on claim request not allowed for claimer. Only the donor can execute this actionAção não permitida para requerente.