SHshinkansen
Transactions & Responses

Returns the transaction response of a non-pending transaction

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 "payin" for this type of transaction.

transaction_idstring required

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

shinkansen_transaction_idstring required

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

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.

response_idstring required

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

response_status'ok' | 'invalid' | 'error_expired' | 'error_debtor_rejected' | 'error_debtor_account_not_found' | 'error_debtor_account_detail_mismatch' | 'error_debtor_account_insufficient_funds' | 'error_debtor_account_over_limits' | 'error_debtor_fi_offline' | 'error_payment_rail_offline' | 'error_creditor_account_over_limits' | 'error' required

Status of the response, reported by the payin operator (or shinkansen if the operator is down):

  • ok: The payin was successful. Note that the money might not be available yet on the destination account. See the Notifications product to know when money is actually credited to your bank account. See also the expected_settlement_date field.
  • invalid: The request failed some validation.
  • error_expired: The payin request expired (typically for expected payments if an expiration_date was specified when creating the payin request)
  • error_debtor_rejected: The end user rejected the payment.
  • 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_insufficient_funds: The origin account doesn't have enough funds to cover the payin amount
  • error_debtor_account_over_limits: The origin account is over the limits set by the debtor bank/institution. Might also indicate lack of funds on some payment rails which don't have separate error codes.
  • error_debtor_fi_offline: The origin bank/institution is offline
  • error_payment_rail_offline: The payment rail is offline.
  • error_creditor_account_over_limits: The destination account is over the limits set by the creditor bank/institution or payment rail.
  • error: Other errors not categorized above.
response_messagestring required

Human-readable message further explaining the response status.

expected_settlement_datestring date

Date when the payin is expected to be settled and funds arrive at the creditor's account. This is the date when the money will be available on the destination account. This is only set when the response status is ok and the operator provides this information. Note that the actual settlement amount might be different from the payin amount due to exchange rates, fees, etc. To be notified of the actual settlement event, see the Notifications product.

Example response

{
  "transaction_type": "payin",
  "transaction_id": "11fe7135-750a-47e2-93cd-60f24f526351",
  "shinkansen_transaction_id": "bacbf923-284b-43b5-90ab-086d56e4b46c",
  "shinkansen_transaction_status": "ok",
  "shinkansen_transaction_message": "OK",
  "response_id": "66b9c18e-02a0-4f99-991f-656482fb696a",
  "response_status": "ok",
  "response_message": "OK",
  "expected_settlement_date": "2023-04-08T18:25:45-04:00",
  "additional_info": {
    "debtor": {
      "name": "Juan Perez",
      "identification": {
        "id_schema": "CLID",
        "id": "12383287-6"
      },
      "financial_institution": {
        "fin_id_schema": "SHINKANSEN",
        "fin_id": "BANCO_BICE_CL"
      },
      "account": "12345678901234567890",
      "account_type": "current_account",
      "email": "jperez@gmail.com"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.