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.
Body
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.
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.
- Type: stringshinkansen
_transaction _id min length:1Format: uuidrequiredUUID 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.
Responses
- application/json
- application/json
- application/json
- application/json
curl https://sandbox-gateway.shinkansen.finance/api/transfers/consult \
--request POST \
--header 'Content-Type: application/json' \
--header 'Shinkansen-Api-Key: YOUR_SECRET_TOKEN' \
--data '{
"shinkansen_transaction_id": "8af773eb-761d-44a5-86a9-1435189d215c"
}'
{
"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"
}