taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

post-accounts-USERNAME-challenge-CHALLENGE_ID.rst (1399B)

      1 .. http:post:: /accounts/$USERNAME/challenge/$CHALLENGE_ID
      2 
      3   Send TAN code for the ``CHALLENGE_ID`` challenge.
      4 
      5   This request can be posted several times to trigger TAN retransmission when the current code has expired or too many confirmation attempts have been made.
      6 
      7   This endpoint is not authenticated. @since **v10**
      8 
      9   **Request:**
     10 
     11   The request body must be empty.
     12 
     13   **Response:**
     14 
     15   :http:statuscode:`200 Ok`:
     16     The TAN code has been sent. The body will be a `ChallengeRequestResponse`.
     17   :http:statuscode:`404 Not Found`:
     18     * ``TALER_EC_BANK_TAN_CHANNEL_SCRIPT_FAILED``: TAN transmition failed.
     19     * ``TALER_EC_BANK_TAN_CHALLENGE_EXPIRED``: TAN transmition failed.
     20       The challenge was not found.
     21   :http:statuscode:`410 Gone`:
     22     The challenge was already solved.
     23   :http:statuscode:`429 Too many requests`:
     24     Too many challenges are active right now, you must wait or confirm current challenges.
     25   :http:statuscode:`502 Bad Gateway`:
     26     * ``TALER_EC_BANK_TAN_CHANNEL_SCRIPT_FAILED``: TAN transmition failed.
     27 
     28   **Details:**
     29 
     30   .. ts:def:: ChallengeRequestResponse
     31 
     32     interface ChallengeRequestResponse {
     33       // How long does the client have to solve the
     34       // challenge.
     35       solve_expiration: Timestamp;
     36 
     37       // What is the earlist time at which the client
     38       // may request a new challenge to be transmitted?
     39       earliest_retransmission: Timestamp;
     40     }