RAratepay
One Time Passcode

Validate an OTP code

post/transaction/management/2fa/v1/verify/{transactionId}

Request

  • Base URL
    https://api.ratepay.com
  • URL
    https://api.ratepay.com/transaction/management/2fa/v1/verify/{transactionId}
  • Auth
    HTTP bearer

Path parameters

transactionIdstring required

The id of the transaction that initialized the OTP process

Example:684CWYHCK05X2CN5K_N6

Request body

otp_codestring required

The OTP code given by the customer

Response

OTP code verified successfully

timestampstring date-time required

When the response was generated

regeneration_possible_in_secondsinteger

The time until another OTP can be sent. Might be null in error responses or when the OTP is verified.

ratepay_transaction_idstring required

The id of the transaction that was tied to the OTP process

result'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' required

The machine-readable outcome of the operation of the OTP process

messageunknown required
_linksLinks

Example response

{
  "ratepay_transaction_id": "684CWYHCK05X2CN5K_N6",
  "message": {
    "en": "Your code has been successfully verified.",
    "de": "Ihr Code wurde erfolgreich überprüft."
  }
}

Changes

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