Notifications

Returns previously sent notifications from Shinkansen

get

https://api.shinkansen.finance/v1https://dev.shinkansen.finance/v1

/notifications

Returns a list of notifications from the participant.

Authorizations

Shinkansen-Api-Key

Shinkansen-Api-KeystringRequired

Api Key Identifying the Client

Query parameters

destination_schema_idstringOptional

If present, filter by destination schema ID

notification_typestringOptional

If present, filter by notification type

notification_typesstring[]Optional

If present, filter by multiple notification types

debtor_accountstringOptional

If present, filter by debtor account

debtor_idstringOptional

If present, filter by debtor ID

creditor_accountstringOptional

If present, filter by creditor account

creditor_idstringOptional

If present, filter by creditor ID

shinkansen_notification_idstringOptional

If present, filter by Shinkansen notification ID

notification_idstringOptional

If present, filter by notification ID

before_datetimestring · date-timeOptional

If present, filter by notifications before this datetime. Example 2024-01-01T00:00:00Z

after_datetimestring · date-timeOptional

If present, filter by notifications after this datetime. Example 2024-01-01T00:00:00Z

before_notification_datestring · date-timeOptional

If present, filter by notifications before notification date. Example 2024-01-01T00:00:00Z

after_notification_datestring · date-timeOptional

If present, filter by notifications after notification date. Example 2024-01-01T00:00:00Z

before_mt940_datestring · date-timeOptional

If present, filter by MT940 date before MT940 date. Example 2024-01-01T00:00:00Z

after_mt940_datestring · date-timeOptional

If present, filter by MT940 date after MT940 date. Example 2024-01-01T00:00:00Z

debtor_account_schema_idstringOptional

If present, filter by debtor account financial institution ID. See docs.

creditor_account_schema_idstringOptional

If present, filter by creditor account financial institution ID. See docs.

page_sizeinteger · min: 1 · max: 100Optional

Maximum number of transactions to return per page (can't be greater than 100)

pageintegerOptional

Current page to fetch (defaults to 1 if not specified)

Responses

200

List of notifications

application/json

403

Forbidden (e.g: wrong API Key)

404

Notification not found.

get

/notifications

HTTPcURLJavaScriptPython

GET /v1/notifications HTTP/1.1
Host: api.shinkansen.finance
Shinkansen-Api-Key: YOUR_API_KEY
Accept: */*

{
  "meta": {
    "current_page": 1,
    "previous_page": null,
    "next_page": 2,
    "page_size": 20,
    "total_count": 100,
    "total_pages": 5
  },
  "data": [
    {
      "notification_id": "c5599fc3-4408-452b-9c49-da09f646e76f",
      "original_notification_id": "xyz123",
      "notification_date": "2023-08-11T08:14:41.078Z",
      "transaction_date": "2023-08-11T08:14:40.078Z",
      "transaction_accounting_id": "xyz1234567890",
      "transaction_accounting_date": "2023-08-12T09:00:00.000Z",
      "notification_type": "payin",
      "referenced_shinkansen_transaction_ids": [
        "ccf5b5b0-5b9b-4b5a-9c1a-7b1b5b9b5b9b"
      ],
      "referenced_shinkansen_notification_ids": [
        "c5599fc3-4408-452b-9c49-da09f646e76f"
      ],
      "currency": "CLP",
      "amount": "1000000.000000",
      "description": "Abono a cuenta CLP",
      "debtor": {
        "name": "Matheiu Van Der Poel",
        "identification": {
          "id_schema": "CLID",
          "id": "78527970-0"
        },
        "financial_institution": {
          "fin_id_schema": "SHINKANSEN",
          "fin_id": "SCOTIABANK_CL"
        },
        "account": "1234567890"
      },
      "creditor": {
        "name": "Buda SpA",
        "identification": {
          "id_schema": "CLID",
          "id": "88888888-8"
        },
        "financial_institution": {
          "fin_id_schema": "SHINKANSEN",
          "fin_id": "SCOTIABANK_CL"
        },
        "account": "012180000118901234"
      }
    }
  ]
}