---
title: "Consult a transfer status"
method: POST
path: "/transfers/consult"
tags: ["Transactions & Responses"]
---

# Consult a transfer status

`POST /transfers/consult`

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](https://docs.shinkansen.tech/reference/post-response-webook_transfers).

## Request body

- OriginalTransferConsultRequest — Transfer consult message request to the Switch Network about a specific transfer previously sent/received by your Financial Institution, this is useful to know the final status of a transfer from the Switch Network when something goes wrong, like a timeout, an error, etc. This is a asynchronous request, you will receive the status of the consultation in your webhook [Receives Responses](https://docs.shinkansen.tech/reference/post-response-webook_transfers). Example: You send a transfer to the Switch Network and you don't receive a response, you can request a consultation to the Switch Network to know the final status of the transfer. If the transfer is still pending, you will receive a status of `pending`. If the transfer is approved, you will receive a status of `approved`. If the transfer is rejected, you will receive a status of `error` with the response_status code of the error (error_creditor_account_over_limits, error_creditor_account_closed, etc.). If the transfer is reversed, you will receive a transaction_type of `reversal` with the response_status 'approved' You can found more information about the transfer in the object network_metadata of the response object.
  - `shinkansen_transaction_id` string, 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.

## Response `200`

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](https://docs.shinkansen.tech/reference/post-response-webook_transfers).

- StatusTransferConsult — Status transfer consult HTTP 200
  - `message` string, required — Message describing the status of the consultation
  - `status` 'in_progress' | 'completed' | 'failed', required — Status of the consultation
  - `shinkansen_consult_id` string, uuid, required — Shinkansen consultation ID generated by Shinkansen

## Other responses

- `400` — Message received but rejected by Shinkansen Gateway due to validation errors
- `401` — Message received but rejected by Shinkansen Gateway due to an unauthorized access to the API Key or the JWS Signature
- `404` — Shinkansen transaction id not found in the Gateway API records.

---

[API](https://skmtc.net/shinkansen/apis/payouts-shinkansen-endpoints.md) · [All operations](https://skmtc.net/shinkansen/apis/payouts-shinkansen-endpoints/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shinkansen/payouts-shinkansen-endpoints/versions/1e4a6760b7e8/schema)
