SHshinkansen
Transactions & Responses

Returns transactions from Shinkansen

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": "500.00000",
      "creditor": {
        "account": "987654321",
        "account_type": "current_account",
        "email": "payments@startech.com",
        "financial_institution": {
          "fin_id": "BANCO_STELLAR_CL",
          "fin_id_schema": "SHINKANSEN"
        },
        "identification": {
          "id": "98765432-1",
          "id_schema": "CLID"
        },
        "name": "StarTech Solutions Ltd"
      },
      "currency": "CLP",
      "debtor": {
        "account": "123456789",
        "account_type": "current_account",
        "email": "finance@cosmicretail.com",
        "financial_institution": {
          "fin_id": "BANCO_STELLAR_CL",
          "fin_id_schema": "SHINKANSEN"
        },
        "identification": {
          "id": "12345678-9",
          "id_schema": "CLID"
        },
        "name": "Cosmic Retail Corp"
      },
      "description": "Service subscription payment",
      "expiration_date": "2024-03-15T15:00:00Z",
      "interactive_payment_failure_redirect_url": "https://startech.com/payments/failure",
      "interactive_payment_success_redirect_url": "https://startech.com/payments/success",
      "internal_id": 456,
      "metadata": null,
      "payin_type": "interactive_payment",
      "shinkansen_delivered_at": null,
      "shinkansen_received_at": "2024-03-01T10:00:00Z",
      "shinkansen_transaction_id": "f7922b99-d31c-46ee-9721-b5756d71bed7",
      "transaction_id": "a2fb8246-861b-47e2-93cd-60f24f526462",
      "transaction_type": "payin",
      "ttl": null
    }
  }
]

Changes

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