Skip to main content
GET
List judicial blockages for a specific merchant

Authorizations

x-api-key
string
header
required

Company API key for authentication

Path Parameters

merchantId
string
required

The merchant ID

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:20

Number of items per page

Required range: 1 <= x <= 100
type
enum<string>[]

Filter by movement type (array)

Available options:
BLOCK,
RELEASE
affiliation_bank_account_id
string

Filter by affiliation bank account ID

process_number
string

Filter by judicial process number

occurred_at_from
string<date-time>

Filter movements from this date

occurred_at_to
string<date-time>

Filter movements to this date

sort
string

Sort by field(s) (e.g., "occurred_at", "-amount", "created_at")

Response

Judicial blockages retrieved successfully

Paginated judicial blockage list response

data
object[]
required

List of judicial blockages

pagination
object
required