PIpismo
Funds recovery

Update funds recovery

Update some funds recovery fields.

Note: The update is only possible when the record is in CREATED, TRACKED, or AWAITING_ANALYSIS states.

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

Request

  • Base URL
    https://sandbox.pismolabs.io/pix-dict
  • URL
    https://sandbox.pismolabs.io/pix-dict/v1/pix/funds-recoveries/{funds_recovery_id}
  • Auth
    HTTP bearer

Path parameters

funds_recovery_idstring required

Funds recovery identifier.

Returned from the Create funds recovery endpoint.

Headers

Authorizationstring required
Example:Bearer eyJhbGci...IUzUx

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

x-tenantstring required

Organization/tenant ID

x-account-idstring

Pismo account ID

Idempotency-Keystring required

A unique UUID identifier to ensure the operation remains idempotent, allowing for operation repitition without causing unintended effects or duplication. An idempotent operation is one that can be applied multiple times, yet the outcome remains the same. it ensures that network errors, retries, or failures can occur without introducing inconsistencies.

x-cidstring

The Correlation IDentifier UUID field links related API requests and events. The x-cid can help the Pismo engineering team track everything related to a call. If not passed, this field is automatically generated.

Request body

idstring required

Funds recovery identifier.

Returned from the Create funds recovery endpoint.

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

When the contested transaction is a reversal, the DICT operating manual requires situation_type to be OTHER, which in turn makes report_details mandatory.

report_detailsstring

Details about report

Example request

{
  "id": "53D0F66A-BAB0-49D7-B7DC-807B82AABD8D",
  "contact_information": {
    "phone": "551154874551",
    "email": "polly_ester@email.com"
  },
  "report_details": "Details that can help the receiving participant to analyze the suspected violation"
}

Response

OK - success

Changes

No recorded changes to this operation across all 1 revision of this API.