Update a Pix key by ID
PATCH {{baseInfraUrl}}/{{version}}/pix-key/:keyId
Update the account information or the holder's name linked to a Pix Key already owned by the participant. Pix Keys with EVP type can only be patched for branch transfer or reconciliation reasons.
| Parameter | Value Type | Description |
|---|---|---|
| id | REQUIRED | Id of the Pix Key to be patched. Example: +5511989898989 |
| reason | REQUIRED | Reason for the patch. Options: branchTransfer, reconciliationand userRequested. An EVP Pix Key does not accept user requested patches. |
| accountCreated | OPTIONAL | Opening DateTime for the account to be linked to the Pix Key. Example: accountCreated=2022-01-01 |
| accountNumber | OPTIONAL | Account number of the account to be linked to the Pix Key. Example: accountNumber=76543. |
| accountType | OPTIONAL | Account type of the account to be linked to the Pix Key. Options: checking, savings, salaryand payment. |
| branchCode | OPTIONAL | Branch code of the account to be linked to the Pix Key. Example: branchCode=1234. |
| name | OPTIONAL | Holder's name of the account to be linked to the Pix Key. Example: name=Jamie Lannister. |
Request Body
{"reason"=>"branchTransfer", "accountCreated"=>"2022-01-01T12:00:00:00", "accountNumber"=>"121212", "accountType"=>"savings", "branchCode"=>"0001", "name"=>"Jamie Lannister"}
RESPONSES
status: OK
{"key":{"accountCreated":"2022-01-02T02:59:59.999999+00:00","accountNumber":"121212","accountType":"savings","bankCode":"35547753","bankName":"","branchCode":"0001","created":"2022-05-17T19:26:03.784235+00:00","id":"+551196969696","name":"Jamie Lannister","owned":"2022-05-17T19:26:03.784235+00:00","ownerType":"individual","status":"registered","tags":[],"taxId":"012.345.678-90","type":"phone"},"message":"Key successfully updated"}