List the realm's Pix infractions

curl --request GET \
  --url https://api.banking.v2.portao3.com.br/realms/{realmId}/pix-infraction

const options = {method: 'GET'};

fetch('https://api.banking.v2.portao3.com.br/realms/{realmId}/pix-infraction', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.banking.v2.portao3.com.br/realms/{realmId}/pix-infraction",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.banking.v2.portao3.com.br/realms/{realmId}/pix-infraction"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/pix-infraction")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

[
  {
    "_id": "6727d4e1b4d3e80012c9a5a3",
    "environment": "LIVE",
    "realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
    "organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
    "accountId": "66f2a1c7b4d3e80012c9a0b4",
    "walletId": "66f2a3d1b4d3e80012c9a0d2",
    "transactionId": "6726b1c2b4d3e80012c9a4f7",
    "direction": "RECEIVED",
    "reason": "REFUND_REQUEST",
    "situationType": "SCAM",
    "reportDetails": "Paguei por um produto que nunca recebi. O vendedor parou de responder.",
    "external": {
      "infractionId": "3f9c2a71-8d4e-4b6a-9e15-2c7d0b8a4f63",
      "fraudMarkerId": "b7e14c90-2f3a-4d8b-a6c5-91e0d3f72b48"
    },
    "status": "CLOSED",
    "analysisResult": "AGREED",
    "analysisDetails": "Recebedor notificado; valor bloqueado e devolvido ao pagador.",
    "effectiveAt": "2026-10-28T17:20:11.000Z",
    "changedAt": "2026-11-03T12:05:42.318Z",
    "createdAt": "2026-10-28T17:20:13.402Z",
    "updatedAt": "2026-11-03T12:05:42.320Z",
    "__v": 0,
    "endToEndId": "E12345678202610281415a1B2c3D4e5F",
    "reportParticipant": {
      "id": "",
      "bankIspb": "12345678",
      "name": "Mariana Souza",
      "email": "",
      "phone": ""
    },
    "counterpartyParticipant": {
      "id": "",
      "bankIspb": "87654321",
      "name": "Gráfica Aurora Ltda"
    }
  }
]

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "USER_NOT_HAVE_WALLET_PERMISSION",
  "origin": "BANKING",
  "message": "You do not have permission to perform this action"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "BAD_REQUEST",
  "origin": "BANKING",
  "message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
  "fields": [
    {
      "field": "realmId",
      "message": "Invalid UUID",
      "code": "REALMID_UUID"
    }
  ]
}

GET

realms

{realmId}

pix-infraction

List the realm's Pix infractions

curl --request GET \
  --url https://api.banking.v2.portao3.com.br/realms/{realmId}/pix-infraction

const options = {method: 'GET'};

fetch('https://api.banking.v2.portao3.com.br/realms/{realmId}/pix-infraction', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.banking.v2.portao3.com.br/realms/{realmId}/pix-infraction",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.banking.v2.portao3.com.br/realms/{realmId}/pix-infraction"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.banking.v2.portao3.com.br/realms/{realmId}/pix-infraction")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

[
  {
    "_id": "6727d4e1b4d3e80012c9a5a3",
    "environment": "LIVE",
    "realmId": "f495ff0c-ab54-4f99-8e92-ca8682e4de9b",
    "organizationId": "c4bd3f21-dfbd-44e8-8055-68ba15bed410",
    "accountId": "66f2a1c7b4d3e80012c9a0b4",
    "walletId": "66f2a3d1b4d3e80012c9a0d2",
    "transactionId": "6726b1c2b4d3e80012c9a4f7",
    "direction": "RECEIVED",
    "reason": "REFUND_REQUEST",
    "situationType": "SCAM",
    "reportDetails": "Paguei por um produto que nunca recebi. O vendedor parou de responder.",
    "external": {
      "infractionId": "3f9c2a71-8d4e-4b6a-9e15-2c7d0b8a4f63",
      "fraudMarkerId": "b7e14c90-2f3a-4d8b-a6c5-91e0d3f72b48"
    },
    "status": "CLOSED",
    "analysisResult": "AGREED",
    "analysisDetails": "Recebedor notificado; valor bloqueado e devolvido ao pagador.",
    "effectiveAt": "2026-10-28T17:20:11.000Z",
    "changedAt": "2026-11-03T12:05:42.318Z",
    "createdAt": "2026-10-28T17:20:13.402Z",
    "updatedAt": "2026-11-03T12:05:42.320Z",
    "__v": 0,
    "endToEndId": "E12345678202610281415a1B2c3D4e5F",
    "reportParticipant": {
      "id": "",
      "bankIspb": "12345678",
      "name": "Mariana Souza",
      "email": "",
      "phone": ""
    },
    "counterpartyParticipant": {
      "id": "",
      "bankIspb": "87654321",
      "name": "Gráfica Aurora Ltda"
    }
  }
]

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "USER_NOT_HAVE_WALLET_PERMISSION",
  "origin": "BANKING",
  "message": "You do not have permission to perform this action"
}

{
  "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
  "code": "BAD_REQUEST",
  "origin": "BANKING",
  "message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
  "fields": [
    {
      "field": "realmId",
      "message": "Invalid UUID",
      "code": "REALMID_UUID"
    }
  ]
}

Each infraction follows its report at the bank: status moves from OPEN to ACKNOWLEDGED while the receiver’s institution analyzes it, and ends CLOSED (with its conclusion in analysisResult) or CANCELLED. The list is not paginated and comes in no guaranteed order. Only the infractions of the environment in x-environment are listed, so send x-environment: LIVE for production ones. Only Portão 3’s own services and back office can read Pix infractions.

Headers

x-environment

enum<string>

Environment whose infractions you list: LIVE (production) or TEST (sandbox). When you omit it, you get the TEST infractions; any other value is rejected.

Available options:

LIVE,

TEST

Path Parameters

realmId

string<uuid>

required

ID of the realm.

Format: UUID

Response

Successful response

_id

string

required

ID of the infraction (24 hexadecimal characters).

Example:

"6727d4e1b4d3e80012c9a5a3"

environment

enum<string>

required

Environment of the infraction: LIVE (production) or TEST (sandbox).

Available options:

LIVE,

TEST

Example:

"LIVE"

realmId

string

required

ID of the realm.

Example:

"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"

organizationId

string

required

ID of the organization.

Example:

"c4bd3f21-dfbd-44e8-8055-68ba15bed410"

accountId

string

required

ID of the organization's account.

Example:

"66f2a1c7b4d3e80012c9a0b4"

walletId

string

required

ID of the wallet that sent or received the Pix.

Example:

"66f2a3d1b4d3e80012c9a0d2"

transactionId

string

required

ID of the Pix transaction in the wallet's statement.

Example:

"6726b1c2b4d3e80012c9a4f7"

direction

enum<string>

required

Which side the wallet is on: RECEIVED — another institution reported a Pix the wallet received (the payer says it was a fraud); SENT — Portão 3 reported a Pix the wallet sent, at the organization's request.

Available options:

SENT,

RECEIVED

Example:

"RECEIVED"

reason

enum<string>

required

REFUND_REQUEST — the report asks for the money back; REFUND_CANCELLED — the bank marked the request as cancelled. On a report Portão 3 just opened, until the bank's first update, it is the value sent with it, and cancels nothing. Some older cancelled reports still say REFUND_REQUEST. Read status to know whether a report was cancelled.

Available options:

REFUND_REQUEST,

REFUND_CANCELLED

Example:

"REFUND_REQUEST"

situationType

enum<string>

required

What the report says happened: SCAM — the payer was deceived into paying; ACCOUNT_TAKEOVER — someone took over the payer's account; COERCION — the payer was forced to pay; FRAUDULENT_ACCESS — someone used the payer's account without permission; OTHER — anything else, or not stated. UNKNOWN appears only on a report you just opened with it, until the bank's first update (it is reported as OTHER).

Available options:

SCAM,

ACCOUNT_TAKEOVER,

COERCION,

FRAUDULENT_ACCESS,

OTHER,

UNKNOWN

Example:

"SCAM"

reportDetails

string | null

required

What happened, in the reporter's words. Empty or null on some older reports.

Example:

"Paguei por um produto que nunca recebi. O vendedor parou de responder."

external

object

required

References of the report at the bank.

Show child attributes

status

enum<string>

required

Where the report stands: CREATED — just opened by Portão 3, until the bank's first update; OPEN — opened, waiting for the receiver's institution; ACKNOWLEDGED — the receiver's institution is analyzing it; CLOSED — the analysis is over (see analysisResult); CANCELLED — the report was withdrawn. CLOSED and CANCELLED are final.

Available options:

OPEN,

ACKNOWLEDGED,

CLOSED,

CANCELLED,

CREATED

Example:

"CLOSED"

analysisResult

enum<string>

required

The receiver's institution's conclusion: AGREED — it agrees the Pix was a fraud; DISAGREED — it doesn't; PENDING — no conclusion recorded. Final only once status is CLOSED: on a report you received it can already say AGREED while the report is OPEN or ACKNOWLEDGED.

Available options:

AGREED,

DISAGREED,

PENDING

Example:

"AGREED"

analysisDetails

string

required

Notes of the analysis, when the receiver's institution wrote any. Empty otherwise.

Example:

"Recebedor notificado; valor bloqueado e devolvido ao pagador."

effectiveAt

string

required

When the report was opened at the bank (ISO 8601, UTC). Not always the bank's time: on a report Portão 3 just opened (until the bank's first update) and on the records written when a wallet is blocked for fraud, it is when the record was written — on some older ones, a moment before it.

Example:

"2026-10-28T17:20:11.000Z"

changedAt

string

required

When the report's last change was recorded (ISO 8601, UTC). On a few older reports that never recorded one, the time of your request.

Example:

"2026-11-03T12:05:42.318Z"

createdAt

string<date-time>

required

When the infraction was recorded (ISO 8601, UTC).

Example:

"2026-10-28T17:20:13.402Z"

updatedAt

string<date-time>

required

When the infraction was last updated (ISO 8601, UTC).

Example:

"2026-11-03T12:05:42.320Z"

__v

number

required

Internal version of the record.

Example:

0

endToEndId

string

End-to-end ID of the Pix (32 characters). Absent or empty on a few older reports.

Example:

"E12345678202610281415a1B2c3D4e5F"

reportParticipant

object

The side that opened the report (the payer's).

Show child attributes

counterpartyParticipant

object

The side the report is against (the receiver's).

Show child attributes

Overview

Identity

Banking

Billing

Accounting

Registry

Platform

Notification

Rule Engine

Scheduling

Travel

Vehicles

Attachments

List the realm's Pix infractions

Headers

Path Parameters

Response