SHshinkansen
Transactions & Responses

Returns the transaction response of a non-pending transaction

Changed on

Can be used when the participant needs to re-check the response for a given transaction (e.g: if an unexpected error means they lost a response)

get/transactions/{shinkansen_id}/response

Request

  • Base URL
    https://api.shinkansen.finance/v1
  • URL
    https://api.shinkansen.finance/v1/transactions/{shinkansen_id}/response
  • Auth
    API key in header Shinkansen-Api-Key

Response

The response of a non-pending transaction.

transaction_typestring required

Transaction type. Always should be "payout" for this type of transaction.

transaction_idstring required

UUID Unique identifier of the transaction. Generated by original sender of the payout.

shinkansen_transaction_idstring required

UUID Unique identifier of the transaction. Set by Shinkansen on the transaction message.

response_idstring uuid required

UUID Unique identifier of the transaction response. Set by the payout operator.

response_status'ok' | 'invalid' | 'error_creditor_account_not_found' | 'error_creditor_account_detail_mismatch' | 'error_creditor_account_over_limits' | 'error_creditor_account_closed' | 'error_creditor_account_currency_mismatch' | 'error_creditor_reject' | 'error_creditor_fi_offline' | 'error_payment_rail_offline' | 'error_debtor_account_not_found' | 'error_debtor_account_detail_mismatch' | 'error_debtor_account_over_limits' | 'error_debtor_insufficient_funds' | 'error_debtor_reject' | 'error_debtor_fi_offline' | 'error_delivery_ttl_expired' | 'error_expired' | 'error' required

Status as reported by the payout operator (or Shinkansen if the operator is down):

  • ok: The payout was successful.
  • invalid: The request failed some validation
  • error_creditor_account_not_found: The destination account doesn't exist
  • error_creditor_account_detail_mismatch: Something is wrong with the destination account details
  • error_creditor_account_over_limits: The destination account is over the limits set by the creditor bank/institution
  • error_creditor_account_closed: The destination account is closed, cancelled or blocked
  • error_creditor_account_currency_mismatch: The payout currency doesn't match the currency of the destination account
  • error_creditor_reject: The payout was returned or rejected by the creditor bank/institution
  • error_creditor_fi_offline: The creditor bank/institution is temporarily offline
  • error_payment_rail_offline: The payment rail used by Shinkansen/PO is temporarily offline
  • error_debtor_account_not_found: The origin account doesn't exist
  • error_debtor_account_detail_mismatch: Something is wrong with the origin account details
  • error_debtor_account_over_limits: The origin account is over the limits set by the debtor bank/institution or the payout operator.
  • error_debtor_insufficient_funds: The origin account doesn't have enough funds to cover the payout amount.
  • error_debtor_reject: The debtor bank/institution rejected the debit
  • error_debtor_fi_offline: The debtor bank/institution is temporarily offline
  • error_delivery_ttl_expired: The transaction could not be delivered to the source bank/institution before the TTL specified on the original payout message.
  • error_expired: The payout expired at the bank/institution before it could be processed (for example, a cut-off time or an acceptance window was exceeded)
  • error: Other errors not categorized above
response_messagestring required

Human-readable message further explaining the status.

shinkansen_transaction_status'ok' | 'error' required

Status as reported by Shinkansen. Either ok or error (Can't be pending because that's the status for transactions without a response)

shinkansen_transaction_messagestring required

Human-readable message further explaining the Shinkansen status.

Example response

{
  "transaction_type": "payout",
  "transaction_id": "dc07ff80-c706-45d8-8ff6-28471ef29592",
  "shinkansen_transaction_id": "f106831d-fb12-4fca-ba9d-5f7f5c88c034",
  "shinkansen_transaction_status": "ok",
  "shinkansen_transaction_message": "Error or Success Message",
  "response_id": "652f022e-7074-430c-af03-dfe37e8b0855",
  "response_status": "ok",
  "response_message": "OK"
}

Changes

  • f42261dee5a6Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id get-payin-transaction-response-by-id removed and replaced with get-payout-transaction-response-by-id