Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Funds recovery

Cancel funds recovery [beta]

Cancel funds recovery

Statuses that allow cancellation:

StatusCan Cancel?Note
CREATEDYesBefore any processing
TRACKEDYesAfter graph creation
AWAITING_ANALYSISYesDuring analysis period (7 days)
ANALYSEDYesAfter analysis completed, before refund
REFUNDINGNoRefunds already started - irreversible process
COMPLETEDNoProcess already finished

When a recovery is cancelled:

  • Status changes to CANCELLED
  • All linked infraction notifications are automatically cancelled
  • Receiver PSPs must unblock the resources that were blocked
  • Tracking graph remains available for audit
  • Process cannot be undone (but new recovery can be created)

Thie endpoint generates a Pix funds recovery status changed event.

post/v1/pix/funds-recoveries/{funds_recovery_id}/cancel

Path parameters

funds_recovery_idstring required

Funds recovery identifier.

Returned from the Create funds recovery endpoint.

Response

OK - synchronous success

idstring

Funds recovery identifier.

Returned from the Create funds recovery endpoint.

status'CREATED' | 'AWAITING_ANALYSIS' | 'TRACKED' | 'ANALYSED' | 'REFUNDING' | 'COMPLETED' | 'CANCELLED'

Funds recovery status:

  • CREATED - For INTERACTIVE
  • AWAITING_ANALYSIS - For AUTOMATED when processed synchronously
  • CREATED - Recovery created, awaiting next action. Both flows.
  • TRACKED - Tracking graph created. INTERACTIVE only
  • AWAITING_ANALYSIS - Awaiting analysis from receiver PSPs (deadline: 7 days). Both flows.
  • ANALYSED - Analysis completed, ready for refund. Both flows
  • REFUNDING - Refund process in progress. Both flows.
  • COMPLETED - Recovery successfully completed. Both flows.
  • CANCELLED - Recovery cancelled. Both flows.
updated_atstring date-time

Updated datetime. A RFC 3339 date-time value. For example - 2023-04-12T23:20:50.52Z.

Example response

{
  "id": "53D0F66A-BAB0-49D7-B7DC-807B82AABD8D",
  "status": "CREATED",
  "updated_at": "2020-08-13T13:49:03Z"
}