> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Cancel a funds recovery > Cancels a funds recovery within the authenticated participant scope, changing its status to CANCELLED from any non-terminal state from CREATED through REFUNDING. A recovery already in COMPLETED or CANCELLED returns 409. The request has no body and requires the X-Idempotency header. The response omits trackingGraph, trackingGraphParameters, and correlationId. When BACEN has not resolved the request yet, the operation answers 409 / PIX-0118; errors[] carries operationId and operationStatus when the provider sent valid values. The resource keeps its current status until BACEN's change arrives. Do not retry blindly: a retry can keep returning this answer after BACEN resolves the operation. If an earlier request for the same operation is still in progress at the provider, the request is rejected with 409 / PIX-0035 and nothing changes: retry after a short wait. ## OpenAPI ````yaml /pt/openapi/v3-current/pix-lerian-dict.yaml post /dict/funds-recoveries/{id}/cancel openapi: 3.1.0 info: contact: name: Lerian Studio url: https://lerian.studio description: >- Public API for Pix keys, claims, fraud markers, infraction reports, and MED funds recovery. license: name: Lerian Studio General License title: Pix Lerian — DICT version: 1.2.0 servers: - url: https://api.example.com/dict-hub/v1 description: >- Replace the example host with the URL provided during environment onboarding. security: - BearerAuth: [] tags: - description: Manage ownership and portability claims for Pix keys. name: Claims - description: Register, retrieve, list, update, and remove Pix keys. name: Entries - description: Create, query, list, and cancel DICT fraud markers. name: Fraud Markers - description: Manage participant-scoped MED 2.0 funds recoveries. name: Funds Recoveries - description: Manage MED 2.0 infraction reports for the authenticated organization. name: Infraction Reports - description: Look up Pix keys and check whether keys exist in the DICT directory. name: Keys - description: Create, query, cancel, and settle MED 2.0 refunds. name: Refunds - description: >- Read the state of key reconciliation against BACEN, and start a verification or a file reconciliation. name: VSync paths: /dict/funds-recoveries/{id}/cancel: post: tags: - Funds Recoveries summary: Cancel a funds recovery description: >- Cancels a funds recovery within the authenticated participant scope, changing its status to CANCELLED from any non-terminal state from CREATED through REFUNDING. A recovery already in COMPLETED or CANCELLED returns 409. The request has no body and requires the X-Idempotency header. The response omits trackingGraph, trackingGraphParameters, and correlationId. When BACEN has not resolved the request yet, the operation answers 409 / PIX-0118; errors[] carries operationId and operationStatus when the provider sent valid values. The resource keeps its current status until BACEN's change arrives. Do not retry blindly: a retry can keep returning this answer after BACEN resolves the operation. If an earlier request for the same operation is still in progress at the provider, the request is rejected with 409 / PIX-0035 and nothing changes: retry after a short wait. operationId: cancelFundsRecovery parameters: - description: >- REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. Resending the same key and request within 1 hour returns the original response, its status included, with X-Idempotency-Replayed: true. Reusing the key with a divergent method, path or body, or while the first request runs, is PIX-0031 @ 412. in: header name: X-Idempotency required: true schema: maxLength: 64 minLength: 1 type: string - description: Funds recovery internal ID (UUID format) in: path name: id required: true schema: description: Funds recovery internal ID (UUID format) examples: - 018f8c1d-1234-7abc-9def-000000000001 type: string - description: >- Best-effort business correlation id (observability only; never fabricated). in: header name: X-Correlation-Id schema: description: >- Best-effort business correlation id (observability only; never fabricated). examples: - 7c9e6679742540de944be07fc1f90ae7 type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CancelFundsRecoveryResponse' description: OK '400': content: application/json: example: code: PIX-0030 title: Idempotency Key Required message: >- The X-Idempotency header is required for this operation and must be within the accepted length. schema: $ref: '#/components/schemas/LegacyErrorEnvelope' application/problem+json: example: type: https://errors.lerian.studio/v1/PIX-0001 title: Bad Request status: 400 detail: Your request is missing one or more required header params. code: PIX-0001 schema: $ref: '#/components/schemas/Detail' description: >- Bad Request (PIX-0001, PIX-0002, PIX-0003, PIX-0017, PIX-0015, PIX-0020, PIX-0107). X-Idempotency absent or longer than 64 bytes (PIX-0030). Legacy {code,title,message} envelope, NOT problem+json. '404': content: application/problem+json: example: type: https://errors.lerian.studio/v1/PIX-0110 title: Not Found status: 404 detail: >- No funds recovery exists with the provided ID for this participant. code: PIX-0110 schema: $ref: '#/components/schemas/Detail' description: Not Found (PIX-0110). '409': content: application/problem+json: example: type: https://errors.lerian.studio/v1/PIX-0113 title: Conflict status: 409 detail: A funds recovery already exists for this root transaction. code: PIX-0113 schema: $ref: '#/components/schemas/Detail' description: Conflict (PIX-0113, PIX-0114, PIX-0118, PIX-0035). '412': content: application/json: example: code: PIX-0031 title: Idempotency Key Conflict message: >- The X-Idempotency header is held by a request still running or whose receipt could not be stored, or was already used with a different request. schema: $ref: '#/components/schemas/LegacyErrorEnvelope' description: >- Refused under this X-Idempotency (PIX-0031): the first request under it is still running (with Retry-After: 1), its receipt could not be stored and the key is held for the hour, or the request differs from the first (method, URL, body, or identity header among X-Account-Id / X-Reason / X-End-To-End-Id). An earlier request under this key may already have executed. Legacy {code,title,message} envelope, NOT problem+json. '422': content: application/problem+json: example: type: https://errors.lerian.studio/v1/PIX-0100 title: Unprocessable Entity status: 422 detail: Missing or malformed required fields. code: PIX-0100 schema: $ref: '#/components/schemas/Detail' description: Unprocessable Entity (PIX-0100, PIX-0117). '500': content: application/problem+json: example: type: https://errors.lerian.studio/v1/PIX-0000 title: Internal Server Error status: 500 detail: internal error code: PIX-0000 schema: $ref: '#/components/schemas/Detail' description: Internal Server Error (PIX-0000). '502': content: application/problem+json: example: type: https://errors.lerian.studio/v1/PIX-0141 title: Bad Gateway status: 502 detail: internal error code: PIX-0141 schema: $ref: '#/components/schemas/Detail' description: Bad Gateway (PIX-0141). default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error components: schemas: CancelFundsRecoveryResponse: additionalProperties: false properties: accountId: examples: - 550e8400-e29b-41d4-a716-446655440000 type: string bacenFundsRecoveryId: examples: - 9f3a8b7e-2c1d-4e5a-8b6f-1a2b3c4d5e6f type: string contactInformation: $ref: '#/components/schemas/ContactInformationOutput' createdAt: examples: - '2026-05-17T13:30:00Z' format: date-time type: string id: examples: - 018f8c1d-1234-7abc-9def-000000000001 type: string metadata: {} participantId: examples: - '12345678' type: string reportDetails: examples: - Victim of a WhatsApp scam type: string reporterParticipant: examples: - '12345678' type: string rootTransactionId: examples: - E12345678202605171530aB3xK9mWq2z type: string situationType: enum: - SCAM - ACCOUNT_TAKEOVER - COERCION - FRAUDULENT_ACCESS - OTHER - UNKNOWN examples: - SCAM type: string status: enum: - CREATED - TRACKED - AWAITING_ANALYSIS - ANALYSED - REFUNDING - COMPLETED - CANCELLED examples: - CANCELLED type: string updatedAt: examples: - '2026-05-17T13:30:00Z' format: date-time type: string required: - id - bacenFundsRecoveryId - participantId - accountId - rootTransactionId - situationType - status - reporterParticipant - contactInformation - createdAt - updatedAt type: object LegacyErrorEnvelope: additionalProperties: false properties: code: description: PIX-XXXX error code type: string message: description: Human-readable error message type: string title: description: Short error title type: string fields: additionalProperties: type: string description: Per-field detail, keyed by the field or header the refusal names type: object headers: additionalProperties: type: string description: Per-header detail, keyed by the request header the refusal names type: object required: - code - title - message type: object Detail: additionalProperties: true properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object ContactInformationOutput: additionalProperties: false properties: email: examples: - user@example.com type: string phone: examples: - '+5511999999999' type: string required: - email - phone type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.