# Regenerate OTP code for an active OTP process

Endpoint: POST /transaction/management/2fa/v1/regenerate/{transactionId}
Version: 1.0.0
Security: Bearer

## Path parameters:

  - `transactionId` (string, required)
    The id of the transaction that initialized the OTP process
    Example: "684CWYHCK05X2CN5K_N6"

## Response 200 fields (application/json):

  - `timestamp` (string, required)
    When the response was generated

  - `regeneration_possible_in_seconds` (integer)
    The time until another OTP can be sent. Might be null in error responses or when the OTP is verified.

  - `ratepay_transaction_id` (string, required)
    The id of the transaction that was tied to the OTP process
    Example: "684CWYHCK05X2CN5K_N6"

  - `result` (string, required)
    The machine-readable outcome of the operation of the OTP process
    Enum: "otp_sent", "unexpected_client_input", "otp_verified", "otp_regenerated", "unexpected_server_error", "otp_exists", "otp_failed", "verify_attempt_failed", "no_more_verification_attempts_left", "transaction_not_found", "no_more_regeneration_attempts_left", "retry_regeneration_later", "no_authorization_data_provided", "authorization_data_invalid", "no_claims_provided", "authorization_data_not_processable", "transaction_access_not_allowed", "otp_live_daily_sms_rate_limit_exceeded", "otp_live_total_sms_rate_limit_exceeded_talk_to_ratepay"

  - `message` (any, required)
    A detailed description of the outcome in English and German

  - `time_to_live_in_seconds` (integer, required)
    The time until the OTP process will expire and the OTP will be invalid.

  - `_links` (object)

## Response 401 fields (application/json):

  - `timestamp` (string, required)
    When the response was generated

  - `regeneration_possible_in_seconds` (integer)
    The time until another OTP can be sent. Might be null in error responses or when the OTP is verified.

  - `ratepay_transaction_id` (string, required)
    The id of the transaction that was tied to the OTP process
    Example: "684CWYHCK05X2CN5K_N6"

  - `result` (string, required)
    The machine-readable outcome of the operation of the OTP process
    Enum: "otp_sent", "unexpected_client_input", "otp_verified", "otp_regenerated", "unexpected_server_error", "otp_exists", "otp_failed", "verify_attempt_failed", "no_more_verification_attempts_left", "transaction_not_found", "no_more_regeneration_attempts_left", "retry_regeneration_later", "no_authorization_data_provided", "authorization_data_invalid", "no_claims_provided", "authorization_data_not_processable", "transaction_access_not_allowed", "otp_live_daily_sms_rate_limit_exceeded", "otp_live_total_sms_rate_limit_exceeded_talk_to_ratepay"

  - `message` (any, required)
    A detailed description of the outcome in English and German

  - `_links` (object)

## Response 403 fields (application/json):

  - `timestamp` (string, required)
    When the response was generated

  - `regeneration_possible_in_seconds` (integer)
    The time until another OTP can be sent. Might be null in error responses or when the OTP is verified.

  - `ratepay_transaction_id` (string, required)
    The id of the transaction that was tied to the OTP process
    Example: "684CWYHCK05X2CN5K_N6"

  - `result` (string, required)
    The machine-readable outcome of the operation of the OTP process
    Enum: "otp_sent", "unexpected_client_input", "otp_verified", "otp_regenerated", "unexpected_server_error", "otp_exists", "otp_failed", "verify_attempt_failed", "no_more_verification_attempts_left", "transaction_not_found", "no_more_regeneration_attempts_left", "retry_regeneration_later", "no_authorization_data_provided", "authorization_data_invalid", "no_claims_provided", "authorization_data_not_processable", "transaction_access_not_allowed", "otp_live_daily_sms_rate_limit_exceeded", "otp_live_total_sms_rate_limit_exceeded_talk_to_ratepay"

  - `message` (any, required)
    A detailed description of the outcome in English and German

  - `_links` (object)

## Response 422 fields (application/json):

  - `timestamp` (string, required)
    When the response was generated

  - `regeneration_possible_in_seconds` (integer)
    The time until another OTP can be sent. Might be null in error responses or when the OTP is verified.

  - `ratepay_transaction_id` (string, required)
    The id of the transaction that was tied to the OTP process
    Example: "684CWYHCK05X2CN5K_N6"

  - `result` (string, required)
    The machine-readable outcome of the operation of the OTP process
    Enum: "otp_sent", "unexpected_client_input", "otp_verified", "otp_regenerated", "unexpected_server_error", "otp_exists", "otp_failed", "verify_attempt_failed", "no_more_verification_attempts_left", "transaction_not_found", "no_more_regeneration_attempts_left", "retry_regeneration_later", "no_authorization_data_provided", "authorization_data_invalid", "no_claims_provided", "authorization_data_not_processable", "transaction_access_not_allowed", "otp_live_daily_sms_rate_limit_exceeded", "otp_live_total_sms_rate_limit_exceeded_talk_to_ratepay"

  - `message` (any, required)
    A detailed description of the outcome in English and German

  - `_links` (object)

## Response 429 fields (application/json):

  - `timestamp` (string, required)
    When the response was generated

  - `regeneration_possible_in_seconds` (integer)
    The time until another OTP can be sent. Might be null in error responses or when the OTP is verified.

  - `ratepay_transaction_id` (string, required)
    The id of the transaction that was tied to the OTP process
    Example: "684CWYHCK05X2CN5K_N6"

  - `result` (string, required)
    The machine-readable outcome of the operation of the OTP process
    Enum: "otp_sent", "unexpected_client_input", "otp_verified", "otp_regenerated", "unexpected_server_error", "otp_exists", "otp_failed", "verify_attempt_failed", "no_more_verification_attempts_left", "transaction_not_found", "no_more_regeneration_attempts_left", "retry_regeneration_later", "no_authorization_data_provided", "authorization_data_invalid", "no_claims_provided", "authorization_data_not_processable", "transaction_access_not_allowed", "otp_live_daily_sms_rate_limit_exceeded", "otp_live_total_sms_rate_limit_exceeded_talk_to_ratepay"

  - `message` (any, required)
    A detailed description of the outcome in English and German

  - `_links` (object)

## Response 500 fields (application/json):

  - `timestamp` (string, required)
    When the response was generated

  - `regeneration_possible_in_seconds` (integer)
    The time until another OTP can be sent. Might be null in error responses or when the OTP is verified.

  - `ratepay_transaction_id` (string, required)
    The id of the transaction that was tied to the OTP process
    Example: "684CWYHCK05X2CN5K_N6"

  - `result` (string, required)
    The machine-readable outcome of the operation of the OTP process
    Enum: "otp_sent", "unexpected_client_input", "otp_verified", "otp_regenerated", "unexpected_server_error", "otp_exists", "otp_failed", "verify_attempt_failed", "no_more_verification_attempts_left", "transaction_not_found", "no_more_regeneration_attempts_left", "retry_regeneration_later", "no_authorization_data_provided", "authorization_data_invalid", "no_claims_provided", "authorization_data_not_processable", "transaction_access_not_allowed", "otp_live_daily_sms_rate_limit_exceeded", "otp_live_total_sms_rate_limit_exceeded_talk_to_ratepay"

  - `message` (any, required)
    A detailed description of the outcome in English and German

  - `_links` (object)