Sign in
Infraction reports

Close infraction report

Closes an infraction report.

Only the counterparty participant can close an infraction report.

The operation is idempotent. If you try to close the report again with the same parameters, you will get the same response as the first time.

On PSP timeout, a 202 Accepted response is returned and the process continues asynchronously, eventually emitting a success or failure event.

This endpoint generates a <a href="https://developers.pismo.io/events/docs/pix-dict-infraction-status-change-1" >Pix infraction status changed</a> event.

post/v2/pix/infraction-reports/{id}/close

Path parameters

idstring uuid required

Infraction report ID

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.

Request body

analysis_result'AGREED' | 'DISAGREED' required

Infraction analysis result

fraud_type'APPLICATION_FRAUD' | 'MULE_ACCOUNT' | 'SCAMMER_ACCOUNT' | 'OTHER'

Verified fraud type. REQUIRED if analysis_result = AGREED.

analysis_detailsstring

Infraction's analysis details, which can guide the payer to next steps.

Example request

{
  "analysis_result": "AGREED",
  "fraud_type": "APPLICATION_FRAUD",
  "analysis_details": "Details about infraction analysis"
}

Response

OK

creation_datestring date-time required

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

credited_participantstring required

Credited participant's ISPB (Identifcador do Sistema de Pagamento Brazil) number - the Brazilian Payment System identifier, an 8-digit value.

debited_participantstring required

Debited participant's ISPB (Identifcador do Sistema de Pagamento Brazil) number - the Brazilian Payment System identifier, an 8-digit value.

end_to_end_idstring required

This field is a Brazil Central Bank (BCB) requirement to track all steps of Pix transactions. Basically, there are two steps to a Pix transaction: 1. Initialize a transaction 2. Confirm a transaction The end_to_end_id is sent to the BCB in both steps in order to identify all transaction information.

infraction_report_idstring uuid required

Infraction report ID (UUID)

infraction_type'FRAUD' | 'REFUND_REQUEST' | 'REFUND_CANCELLED' required

Infraction type:

  • FRAUD - Payer or payee requested.
  • REFUND_REQUEST - Initiated only by payer's payment service provider (PSP). Used to mark a key as fraudulent and asks for a refund.
  • REFUND_CANCELLED - Initiated only by payee's PSP. To indicate that a refund done thru an infraction process was a fraud and needs to be returned,
last_modifiedstring date-time required

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

reported_by'DEBITED_PARTICIPANT' | 'CREDITED_PARTICIPANT' required

Who filed the infraction report

status'OPEN' | 'ACKNOWLEDGED' | 'CLOSED' | 'CANCELLED' required

Infraction status

transaction_idstring required

Transaction ID

analysis_detailsstring

Analysis details

analysis_result'AGREED' | 'DISAGREED' | 'PARTIALLY_ACCEPTED' | 'TOTALLY_ACCEPTED' | 'REJECTED'

Analysis results

bacen_response_timestring date-time

Banco Central do Brasil (Central Bank of Brazil) response datetime. A RFC 3339 date-time value. For example - 2023-04-12T23:20:50.52Z.

correlation_idstring

The Correlation identifier field is used to link related API requests and events. The CID can help the Pismo engineering team track everything related to a call. If not passed, a random one is generated. You can find the CID in the response header.

report_detailsstring

Details about report

transaction_result'SETTLED' | 'REJECTED_PAYEE' | 'REJECTED_PAYER'

Transaction result

transaction_type'TRANSFER' | 'CHANGE' | 'WITHDRAWAL' | 'REFUND_AUTOMATIC_PIX' | 'REFUND'

Type of transaction the QR Code validation generates.

  • TRANSFER - Standard immediate transfer payment.
  • CHANGE - Occurs when the QR Code validation returns CHANGE. For example, the customer buys something and pays more than the product value to receive the difference in cash.
  • WITHDRAWAL - Occurs when the QR Code validation returns WITHDRAWAL with withdrawal object values.
  • REFUND_AUTOMATIC_PIX - Total or partial to the PSP payer user within the Automatic Pix MED (Pix return mechanism) scope (only when initiated by a MANUAL).
  • REFUND = Total or partial refund to the paying user within the scope of MED 2.0, when this refund occurs from the PI Account of the user's PSP who participated in the distribution chain of the resources of the original transaction (only when initiated by a MANUAL)

Example response

{
  "creation_date": "2020-08-13T13:49:03Z",
  "credited_participant": "99999011",
  "debited_participant": "99999011",
  "end_to_end_id": "E3030629420200808195101608910248",
  "infraction_report_id": "cfdff46e-5d58-45b8-b7aa-591a65f74444",
  "infraction_type": "FRAUD",
  "last_modified": "2020-08-13T13:49:03Z",
  "reported_by": "DEBITED_PARTICIPANT",
  "status": "CLOSED",
  "transaction_id": "E9999901012341234123412345678900",
  "analysis_details": "Details about the analysis",
  "analysis_result": "AGREED",
  "bacen_response_time": "2020-08-13T13:49:03Z",
  "correlation_id": "c737895c-8159-4c0c-a92a-a4f8600bff37",
  "infraction_data": {
    "credited_participant": "99999011",
    "debited_participant": "99999011",
    "infracting_account_data": {
      "account_number": "98765432",
      "branch": "011"
    },
    "reported_by": "DEBITED_PARTICIPANT",
    "tax_id_number": "123412341234",
    "transaction_date": "2020-01-17T10:00:00Z",
    "key": "email@email.com"
  },
  "report_details": "Details that can help the receiving participant to analyze the suspected violation",
  "transaction_result": "SETTLED",
  "transaction_type": "TRANSFER",
  "contact_information": {
    "phone": "551154874551",
    "email": "polly_ester@email.com"
  }
}

Changes

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