---
title: "List blocklist entries"
method: GET
path: "/payins-blocklist"
tags: ["Payins Blocklist"]
---

# List blocklist entries

`GET /payins-blocklist`

## Request

- Base URL: `https://api.shinkansen.finance/v1`
- URL: `https://api.shinkansen.finance/v1/payins-blocklist`
- Auth: API key in header `Shinkansen-Api-Key`

Returns a paginated list of all blocklist entries for the authenticated fin. Optionally filter by creditor account number.

## Query parameters

- `page` integer
- `page_size` integer
- `creditor_account` string

## Response `200`

Paginated list of blocklist entries.

- object
  - `data` BlocklistBlock[]
    - `id` integer: Unique identifier of the blocklist entry.
    - `criteria` BlocklistBlockCriteria: Matching criteria that identifies an account to block.
      - `creditor` object, required
        - `account_type` string, required: The type of account number (e.g. `clabe`, `cuenta`).
        - `account` string, required: The account number to block.
    - `created_at` string, date-time: ISO 8601 timestamp of when the entry was created.
  - `meta` BlocklistPaginationMeta
    - `current_page` integer
    - `previous_page` integer, nullable
    - `next_page` integer, nullable
    - `page_size` integer
    - `total_count` integer
    - `total_pages` integer

## Other responses

- `400`: Invalid `page` or `page_size` parameter.
- `403`: Forbidden (e.g: wrong API Key)

---

[API](https://skmtc.dev/shinkansen/apis/payin-transactions-shinkansen-endpoints.md) - [All operations](https://skmtc.dev/shinkansen/apis/payin-transactions-shinkansen-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/shinkansen/apis/payin-transactions-shinkansen-endpoints/revisions/208e04fad4a5?raw)