Returns transactions from Shinkansen

get

https://api.shinkansen.finance/v1/transactions

Returns a list of transactions based on the provided filters.

Query Params

transaction_type

string

required

Must be "payout"

fin_id

string

If present, filter by financial institution ID

creditor_account

string

If present, filter by creditor account

debtor_account

string

If present, filter by debtor account

creditor_fin_id

string

If present, filter by creditor financial institution ID

creditor_id

string

If present, filter by creditor ID

shinkansen_transaction_id

uuid

If present, filter by Shinkansen transaction ID

transaction_id

uuid

If present, filter by transaction ID

shinkansen_transaction_status

string

If present, filter by transaction status

limit

integer

≥ 1

Defaults to 1000

Maximum number of transactions to return (defaults to 1000)

order_by

string

Field to order results by

before_internal_id

integer

≥ 1

If present, filter by transactions before this internal ID

before_datetime

date-time

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

after_datetime

date-time

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

delivered

boolean

If present, filter by delivery status

debtor_account_schema_id

string

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

creditor_account_schema_id

string

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

Responses

400

Invalid message (e.g: invalid signature)

403

Forbidden (e.g: wrong API Key)

200List of transactions