SHshinkansen
Payins Blocklist

List blocklist entries

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

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

Query parameters

pageinteger

Page number to retrieve. Must be a positive integer. Defaults to 1.

page_sizeinteger

Number of entries per page. Must be a positive integer, max 100. Defaults to 20.

creditor_accountstring
Example:646180157042875167

Filter entries by creditor account number (partial match supported).

Response

Paginated list of blocklist entries.

Example response

{
  "data": [
    {
      "id": 123,
      "criteria": {
        "creditor": {
          "account_type": "clabe",
          "account": "646180157042875167"
        }
      },
      "created_at": "2026-01-21T16:15:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "next_page": 2,
    "page_size": 20,
    "total_count": 42,
    "total_pages": 3
  }
}

Changes

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