Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-2642128296.2 KB
Transactions & Responses

Consult a transfer status

Sends a special transfer consult message request to Switch, the consultation will be processed asynchronously and you will receive the status of the consultation in your webhook Receives Responses.

post/transfers/consult

Request body

shinkansen_transaction_idstring uuid required

UUID Unique identifier of the transaction. Generated by Shinkansen (this is the original shinkansen_transaction_id). UUID format is required, otherwise the consult request will be rejected.

Example request

{
  "shinkansen_transaction_id": "8af773eb-761d-44a5-86a9-1435189d215c"
}

Response

This sync response is returned when a transfer consultation is requested successfully, the response will be asynchronous and you will receive the status of the consultation in your webhook Receives Responses.

messagestring required

Message describing the status of the consultation

status'in_progress' | 'completed' | 'failed' required

Status of the consultation

shinkansen_consult_idstring uuid required

Shinkansen consultation ID generated by Shinkansen

Example response

{
  "message": "The query will be sent to CCA and you will receive the results in your webhook.",
  "status": "in_progress",
  "shinkansen_consult_id": "383d811a-4f8c-478c-9ea4-9f1dd4ad0ec5"
}