Payins Blocklist

Get a blocklist entry

Returns the blocklist entry with the given ID, scoped to the authenticated fin. Returns 404 if the entry does not exist or belongs to a different fin.

get/payins-blocklist/{id}

Request

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

Path parameters

idinteger required
Example:123

The ID of the blocklist entry to retrieve. Must be a positive integer.

Response

Blocklist entry found.

idinteger

Unique identifier of the blocklist entry.

created_atstring date-time

ISO 8601 timestamp of when the entry was created.

Example response

{
  "id": 123,
  "criteria": {
    "creditor": {
      "account_type": "clabe",
      "account": "646180157042875167"
    }
  },
  "created_at": "2026-01-21T16:15:00Z"
}

Changes

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