Sign in

v1

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

Initiate refund funds recovery [beta]

Initiate funds recovery refund stage, after the recipient PSPs have analyzed (status = ANALYSED) all the infraction notifications. This is the process' final step where funds are effectively returned to the victim's account.

Before requesting the refund, make sure that:

  • The recovery status = ANALYSED
  • You are the creator recovery participant
  • You are within the 72-hour deadline after receiving the FUNDS_RECOVERY_ANALYSED event
  • There is at least one accepted infraction notification (status = ACCEPTED)

Thie endpoint generates a Pix funds recovery status changed event.

For more information refer to Pix funds recovery.

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

Path parameters

funds_recovery_idstring required

Funds recovery identifier.

Returned from the Create funds recovery endpoint.

Response

OK - synchronous success

funds_recovery_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.
total_refunds_createdinteger

Total refunds created

updated_atstring date-time

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

Example response

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