Returns transactions from Shinkansen

​

Returns a list of transactions based on the provided filters.

Query Parameters

  • transaction_type
    Type: string
    required

    Must be "payout"

  • fin_id
    Type: string

    If present, filter by financial institution ID

  • creditor_account
    Type: string

    If present, filter by creditor account

  • debtor_account
    Type: string

    If present, filter by debtor account

  • creditor_fin_id
    Type: string

    If present, filter by creditor financial institution ID

  • creditor_id
    Type: string

    If present, filter by creditor ID

  • shinkansen_transaction_id
    Type: stringFormat: uuid

    If present, filter by Shinkansen transaction ID

  • transaction_id
    Type: stringFormat: uuid

    If present, filter by transaction ID

  • shinkansen_transaction_status
    Type: string

    If present, filter by transaction status

  • limit
    Type: integer
    min:  
    1

    Maximum number of transactions to return (defaults to 1000)

  • order_by
    Type: string

    Field to order results by

  • before_internal_id
    Type: integer
    min:  
    1

    If present, filter by transactions before this internal ID

  • before_datetime
    Type: stringFormat: date-time

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

  • after_datetime
    Type: stringFormat: date-time

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

  • delivered
    Type: boolean

    If present, filter by delivery status

  • debtor_account_schema_id
    Type: string

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

  • creditor_account_schema_id
    Type: string

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

Responses

  • application/json
  • 400

    Invalid message (e.g: invalid signature)

  • 403

    Forbidden (e.g: wrong API Key)

Request Example for get/transactions
curl 'https://api.shinkansen.finance/v1/transactions?transaction_type=&limit=1000' \
  --header 'Shinkansen-Api-Key: YOUR_SECRET_TOKEN'

[
  {
    "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": "11111111-1",
          "id_schema": "CLID"
        },
        "name": "Harry Potter"
      },
      "currency": "CLP",
      "debtor": {
        "account": "123451",
        "account_aliases": [],
        "account_type": "current_account",
        "email": "pagos@empresa-a.example.com",
        "financial_institution": {
          "fin_id": "SHINKANSEN",
          "fin_id_schema": "SHINKANSEN"
        },
        "identification": {
          "id": "11111111-1",
          "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
    }
  }
]

List of transactions

Previous
Sends a payout message
Next
Returns the transaction status