Sign in

v1

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

Get funds recovery [beta]

Get a funds recovery.

Customers should use this endpoint to monitor and track progress, such as checking status after asynchronous operations or audit closed cases.

get/v1/pix/funds-recoveries/{funds_recovery_id}

Path parameters

funds_recovery_idstring required

Funds recovery identifier.

Returned from the Create funds recovery endpoint.

Query parameters

useProviderboolean

Query directly from DICT or do a faster local query with automatic fallback to DICT? Default is false.

Response

OK - 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.
root_transaction_idstring

Fraudulent transaction end-to-end-id

situation_type'SCAM' | 'ACCOUNT_TAKEOVER' | 'COERCION' | 'FRAUDULENT_ACCESS' | 'OTHER' | 'UNKNOWN'

Situation type:

  • SCAM - Scam/fraud through social engineering
  • ACCOUNT_TAKEOVER - Unauthorized transaction without digital authentication
  • COERCION - Coercion crime (kidnapping, extortion)
  • FRAUDULENT_ACCESS - Fraudulent access and authorization (phishing, stolen password) |
  • OTHER - Other cases. This option REQUIRES you pass report_details.
  • UNKNOWN - Unknown state
reporter_participantstring

Reporter participant ID

report_detailsstring

Details about report

created_atstring date-time

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

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",
  "root_transaction_id": "E1234567890123456789012345678901",
  "reporter_participant": "12345678",
  "contact_information": {
    "phone": "551154874551",
    "email": "polly_ester@email.com"
  },
  "report_details": "Details that can help the receiving participant to analyze the suspected violation",
  "created_at": "2020-08-13T13:49:03Z",
  "updated_at": "2020-08-13T13:49:03Z"
}