v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB

Funds recovery

List account fund recoveries [beta]

Get all fund recoveries for an account

get/v1/pix/funds-recoveries

Query parameters

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.

Example:CREATED

modified_afterstring date-time

Only return fund recoveries modified at this datetime or after. Format = RFC 3339. For example - 2023-04-12T23:20:50.52Z.

modified_beforestring date-time

Only return fund recoveries modified at this datetime or before. Format = RFC 3339. For example - 2023-04-12T23:20:50.52Z.

limitinteger

Maximum results to return. Default is 20. Maximum is 200.

Headers

Authorizationstring required

Example:Bearer eyJhbGci...IUzUx

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message.

Response

OK - success

has_more_elementsboolean

Are there more items?

Example response

{
  "has_more_elements": true,
  "items": [
    {
      "id": "53D0F66A-BAB0-49D7-B7DC-807B82AABD8D",
      "status": "CREATED",
      "root_transaction_id": "E1234567890123456789012345678901",
      "reporter_participant": "12345678",
      "report_details": "Details that can help the receiving participant to analyze the suspected violation",
      "contact_information": {
        "phone": "551154874551",
        "email": "polly_ester@email.com"
      },
      "created_at": "2020-08-13T13:49:03Z",
      "updated_at": "2020-08-13T13:49:03Z"
    }
  ]
}