SHshinkansen
Transactions & Responses

Returns transactions from Shinkansen

Changed on

Returns a list of transactions based on the provided filters.

get/transactions

Request

  • Base URL
    https://api.shinkansen.finance/v1
  • URL
    https://api.shinkansen.finance/v1/transactions
  • Auth
    API key in header Shinkansen-Api-Key

Response

List of transactions

shinkansen_transaction_status'pending' | 'ok' | 'error' required

The status of the transaction. Can be one of pending, ok, or error

Example response

[
  {
    "shinkansen_transaction_status": "pending",
    "transaction": {
      "amount": "200.00000",
      "creditor": {
        "account": "1513523451",
        "account_aliases": [],
        "account_type": "current_account",
        "email": "harry@shinkasen.finance",
        "financial_institution": {
          "fin_id": "BANCO_BICE_CL",
          "fin_id_schema": "SHINKANSEN"
        },
        "identification": {
          "id": "12383287-6",
          "id_schema": "CLID"
        },
        "name": "Harry Potter"
      },
      "currency": "CLP",
      "debtor": {
        "account": "123451",
        "account_aliases": [],
        "account_type": "current_account",
        "email": "payments@buk.com",
        "financial_institution": {
          "fin_id": "SHINKANSEN",
          "fin_id_schema": "SHINKANSEN"
        },
        "identification": {
          "id": "12383287-6",
          "id_schema": "CLID"
        },
        "name": "SHINKANSEN SPA"
      },
      "description": "Salary payment",
      "reference_number": "1234567",
      "tracking_key": "AAA1234567",
      "execution_date": "2022-04-11T14:30:00Z",
      "internal_id": 10,
      "metadata": null,
      "shinkansen_delivered_at": null,
      "shinkansen_received_at": "2023-09-20T16:23:26Z",
      "shinkansen_transaction_id": "b53c67c0-bb3b-4dd8-b8c9-f58862d61a43",
      "transaction_id": "2cbd5e32-ab35-4573-9073-c802d9e00580",
      "transaction_type": "payout",
      "ttl": null
    }
  }
]

Changes

  • f42261dee5a6Revision changes
    • breaking

      added the new required query request parameter transaction_type to all path's operations

    • breaking

      the response property /// became optional for the status

    • breaking

      the / response's property type changed from string to no type for status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      added the new payout enum value to the // response property for the response status

    • info

      added the new optional query request parameter after_datetime to all path's operations

    • info

      added the new optional query request parameter before_datetime to all path's operations

    • info

      added the new optional query request parameter before_internal_id to all path's operations

    • info

      added the new optional query request parameter creditor_account to all path's operations

    • info

      added the new optional query request parameter creditor_account_schema_id to all path's operations

    • info

      added the new optional query request parameter creditor_fin_id to all path's operations

    • info

      added the new optional query request parameter creditor_id to all path's operations

    • info

      added the new optional query request parameter debtor_account to all path's operations

    • info

      added the new optional query request parameter debtor_account_schema_id to all path's operations

    • info

      added the new optional query request parameter delivered to all path's operations

    • info

      added the new optional query request parameter fin_id to all path's operations

    • info

      added the new optional query request parameter limit to all path's operations

    • info

      added the new optional query request parameter order_by to all path's operations

    • info

      added the new optional query request parameter shinkansen_transaction_id to all path's operations

    • info

      added the new optional query request parameter shinkansen_transaction_status to all path's operations

    • info

      added the new optional query request parameter transaction_id to all path's operations

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added subschema #1 to the / response property allOf list for the response status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      removed the completed enum value from the / response property for the response status

    • info

      removed the failed enum value from the / response property for the response status

    • info

      removed the payin enum value from the // response property for the response status

    • info

      removed the pending enum value from the / response property for the response status

    • info

      removed the processing enum value from the / response property for the response status

    • info

      added the required property // to the response with the status