--- title: "Returns transactions from Shinkansen" method: GET path: "/transactions" tags: ["Transactions & Responses"] --- # Returns transactions from Shinkansen `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` Returns a list of transactions based on the provided filters. ## Response `200` List of transactions - object[]: Transactions list response from Shinkansen for payins - `shinkansen_transaction_status` 'pending' | 'ok' | 'error', required: The status of the transaction. Can be one of `pending`, `ok`, or `error` - `transaction` object, required - `amount` string, required: Transaction amount with 6 decimal places - `creditor` PayinCreditor: The destination of the fund movement (i.e, the account where the funds will eventually get collected) - `name` string, required: Creditor name. Must refer to the legal name of the participant sending the payin message. - `identification` object, required: The identifier for a legal or natural person - `id_schema` string, required: Identification schema. See https://docs.shinkansen.tech/docs/tipos-de-identificacion - `id` string, required: The actual identification "number" (but not always just numbers). For `"MXRFC"` schema (Mexican RFCs), it can contain numbers and letters (13 for natural persons, 12 for legal entities). For `"MXCURP"` schema (Mexican CURPs) identifying natural persons, it can contain numbers and letters (18 characters). For `"COCC"`, `"COTI"`, `"CONUIP"`, and `"COCE"` schemas (all identifying natural personal in Colombia), use only numbers. For `"CONIT"` schema (Colombian NITs, for legal entities), also use only numbers. For `"PASS"` schema (Passports, used in Colombia for some accounts in name of foreign natural persons), it can contain numbers and letters (and generally whatever is literally printed as a passport number). For `"CLID"` schema (Chilean RUTs, for legal entities and natural persons) you must use the XXXXXXXX-X format: `^\d{8}[-][0-9kK]$`. See https://docs.shinkansen.tech/docs/tipos-de-identificacion for more details. - `financial_institution` object, required: The identifier for a financial institution - `fin_id_schema` string, required: Identification schema for financial institution, namely, any participant in Shinkansen Network. Use `"SHINKANSEN"` for Shinkansen's native network ids and full support on any participant and service of the Shinkansen network. Other schemas might be used when interfacing with other networks but they are *not* recommended unless you *really* know what you are doing or have been explicitly instructed to do so by Shinkansen. - `fin_id` string, required: Identification according to schema. When the `"SHINKANSEN"` schema is used (as recommended), this is the ID assigned by Shinkansen to the participant in the network. In the context of the `header`, it refers to the Shinkansen network participant that sends (Sender) or receives (Receiver) the message. In the context of the `transactions`, it refers to the financial institution from which the resources leave or where the resources arrive. The ID assigned by Shinkansen to the financial institution can be found in https://docs.shinkansen.tech/docs/instituciones-financieras. When sending a transaction to Shinkansen, this value must always be SHINKANSEN. When sending a payout order to Shinkansen Treasury, this value must be SHINKANSEN_TREASURY - `account` string, required: Bank account number of the creditor at the referenced bank or financial institution. The account must be previously setup to be able to receive payments of the corresponding `payin_type` (automated, interactive or expected) - `account_type` string, required: Account type. See https://docs.shinkansen.tech/docs/tipos-de-cuentas for possible values. - `email` string, email, required: E-mail of the legal or natural person receiving the funds (some operators will send email notifications there). - `currency` string, required: Currency code - `debtor` PayinDebtor: The origin of the funds movement. No field is strictly required and even the whole debtor could be omitted for some interactive payments. Check each field for details. - `name` string: Debtor name. The legal name of the legal/natural person sending the funds, if known in advance. Strongly recommended to be present for automated and expected payments. Not required for most interactive payments. - `identification` object: The identifier for a legal or natural person - `id_schema` string, required: Identification schema. See https://docs.shinkansen.tech/docs/tipos-de-identificacion - `id` string, required: The actual identification "number" (but not always just numbers). For `"MXRFC"` schema (Mexican RFCs), it can contain numbers and letters (13 for natural persons, 12 for legal entities). For `"MXCURP"` schema (Mexican CURPs) identifying natural persons, it can contain numbers and letters (18 characters). For `"COCC"`, `"COTI"`, `"CONUIP"`, and `"COCE"` schemas (all identifying natural personal in Colombia), use only numbers. For `"CONIT"` schema (Colombian NITs, for legal entities), also use only numbers. For `"PASS"` schema (Passports, used in Colombia for some accounts in name of foreign natural persons), it can contain numbers and letters (and generally whatever is literally printed as a passport number). For `"CLID"` schema (Chilean RUTs, for legal entities and natural persons) you must use the XXXXXXXX-X format: `^\d{8}[-][0-9kK]$`. See https://docs.shinkansen.tech/docs/tipos-de-identificacion for more details. - `financial_institution` object: The identifier for a financial institution - `fin_id_schema` string, required: Identification schema for financial institution, namely, any participant in Shinkansen Network. Use `"SHINKANSEN"` for Shinkansen's native network ids and full support on any participant and service of the Shinkansen network. Other schemas might be used when interfacing with other networks but they are *not* recommended unless you *really* know what you are doing or have been explicitly instructed to do so by Shinkansen. - `fin_id` string, required: Identification according to schema. When the `"SHINKANSEN"` schema is used (as recommended), this is the ID assigned by Shinkansen to the participant in the network. In the context of the `header`, it refers to the Shinkansen network participant that sends (Sender) or receives (Receiver) the message. In the context of the `transactions`, it refers to the financial institution from which the resources leave or where the resources arrive. The ID assigned by Shinkansen to the financial institution can be found in https://docs.shinkansen.tech/docs/instituciones-financieras. When sending a transaction to Shinkansen, this value must always be SHINKANSEN. When sending a payout order to Shinkansen Treasury, this value must be SHINKANSEN_TREASURY - `account` string: Bank account number of the debtor. Typically used by automated/expected payments. Not required for most interactive payments. - `account_type` string: Account type. See https://docs.shinkansen.tech/docs/tipos-de-cuentas for possible values. - `email` string, email: E-mail of the legal or natural person sending the funds. Optional. - `description` string, required: Transaction description - `expiration_date` string, date-time: Expiration date for payin transactions - `interactive_payment_failure_redirect_url` string: URL to redirect on payment failure - `interactive_payment_success_redirect_url` string: URL to redirect on payment success - `internal_id` integer: Internal identifier - `metadata` object: Additional metadata - `payin_type` 'interactive_payment', required: Type of payin transaction - `shinkansen_delivered_at` string, date-time: When the transaction was delivered - `shinkansen_received_at` string, date-time, required: When the transaction was received - `shinkansen_transaction_id` string, uuid, required: Shinkansen transaction identifier - `transaction_id` string, uuid, required: Client transaction identifier - `transaction_type` 'payin', required: Type of transaction - `ttl` integer: Time to live in seconds ## Other responses - `400`: Invalid message (e.g: invalid signature) - `403`: Forbidden (e.g: wrong API Key) --- [API](https://skmtc.dev/shinkansen/apis/payin-transactions-shinkansen-endpoints.md) - [All operations](https://skmtc.dev/shinkansen/apis/payin-transactions-shinkansen-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/shinkansen/apis/payin-transactions-shinkansen-endpoints/revisions/208e04fad4a5?raw)