The following API endpoints are available for participants to integrate with Shinkansen’s payment platform:
Send a Transfer
This endpoint allows participants to initiate an Electronic Funds Transfer (TEF) to accounts held at other financial institutions. The processing flow follows the sequence:
IFO (Initiating Financial Institution) → Shinkansen → IFR (Receiving Financial Institution)
Participants must provide all required transaction details such as sender and recipient information, amounts, and reference identifiers.
Transaction Status
This endpoint allows participants to query the current processing status of a previously submitted transaction. Possible status values include:
pending:Awaiting processing by the receiving institutionpreliminary_ok:Provisionally approved by the IFR, awaiting final confirmationok:Successfully confirmed and fully processederror:Rejected or failed due to an error or invalid data
This endpoint helps participants track transactions throughout their lifecycle and respond appropriately based on the outcome.
Send Responses
This endpoint is used by the Receiving Financial Institution (IFR) to submit official responses to incoming transaction requests. Responses may include:
- Approvals: Indicating the transaction was successfully processed
- Rejections: Including specific response codes and descriptions explaining the reason for the rejection
Timely and accurate responses are critical for maintaining the reliability of the payment ecosystem.