Update a Pix claim by ID
PATCH {{baseInfraUrl}}/{{version}}/pix-claim/:claimId
A Pix Claim can be patched for two distinct reasons.
A received Pix Claim can be confirmed or canceled by patching its status. A received Pix Claim must be confirmed by the donor to be completed. Ownership Pix Claims can only be canceled by the donor if the reason is fraud.
A sent Pix Claim can also be canceled by patching its status.
| Parameters | Value Type | Description |
|---|---|---|
| id | REQUIRED | Id of the Pix Claim to be patched. |
| status | REQUIRED | Patched status for Pix Claim. Options: confirmedand canceled |
| reason | OPTIONAL | Reason for the change in Pix Claim. Options: fraudand userRequested. Default = userRequested |
Request Body
{"reason"=>"userRequested", "status"=>"canceled"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"claim":{"accountCreated":"2022-02-02T02:59:59.999999+00:00","accountNumber":"5692908409716736","accountType":"checking","agent":"claimer","bankCode":"35547753","branchCode":"0000","claimedBankCode":"31804966","claimerBankCode":"35547753","created":"2022-05-17T19:31:21.972149+00:00","id":"5961418104897536","keyId":"postmanteste@starkbank.com","keyType":"email","name":"testKey","status":"delivered","taxId":"012.345.678-90","type":"ownership","updated":"2022-05-17T19:32:00.656440+00:00"},"message":"Key claim cancellation successfully requested."}