Cancel a PIX key claim requested by this account
POST /order/v1/banking/accounts/{accountId}/keys/claims/{claimId}/cancel
POST
/order/v1/banking/accounts/{accountId}/keys/claims/{claimId}/cancel
Cancels a claim this account requested (claimer side) while it is still PENDING. No confirmation code is required: this only aborts a request the account itself started, it does not release or move any key. To reject a claim someone else opened against a key owned by this account, use the donor confirm-request/confirm endpoints instead.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” accountId
required
string format: uuid
Identifier of the account
claimId
required
string format: uuid
Identifier of the claim to cancel
Header Parameters
Section titled “Header Parameters ” idempotency-key
required
string format: uuid
A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
Responses
Section titled “ Responses ”The resource was returned successfully
object
claimId
required
Identifier of the claim, used on subsequent operations.
string
Example
a8f2b9c4-1e6a-4c3f-9d7b-2a1e8f9c5d10 status
required
Status of the claim
string
Example
PENDINGobject
error
string
Example
INVALID_REQUEST message
string
details
Array<object>
object
field
string
issue
string
description
string
Example
[ { "field": "field_name", "issue": "INVALID", "description": "Field is invalid" }]Unauthorized Request
object
error
string
Example
UNAUTHORIZED message
string
Example
Unauthorized Request details
Array<object>
object
field
string
issue
string
description
string
Example
[]object
error
string
Example
INTERNAL_ERROR message
string
details
Array<object>
object
field
string
issue
string
description
string
Example
[]