taler-docs

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

post-challenge-CHALLENGE_ID-confirm.rst (1311B)

      1 .. http:post:: [/instances/$INSTANCE]/challenge/$CHALLENGE_ID/confirm
      2 
      3   Solves the ``CHALLENGE_ID`` challenge and allows performing the protected operation.
      4 
      5   @since **v21**
      6 
      7   When the challenge is confirmed, you can call the protected endpoint again
      8   with ``CHALLENGE_ID`` in the ``Taler-Challenge-Ids`` HTTP header and the
      9   original request body.
     10 
     11   This endpoints is not authenticated for token creation challenges. Too many
     12   unsuccessful attempts to confirm token creation challenges block the
     13   account.
     14 
     15   This endpoint may be used even when mandatory TAN channels
     16   were not validated yet.
     17 
     18   **Request:**
     19 
     20   .. ts:def:: MerchantChallengeSolveRequest
     21 
     22     interface MerchantChallengeSolveRequest {
     23 
     24       // The TAN code that solves $CHALLENGE_ID.
     25       tan: string;
     26     }
     27 
     28   **Response:**
     29 
     30   :http:statuscode:`204 No Content`:
     31     The challenge was solved.
     32   :http:statuscode:`404 Not Found`:
     33     The challenge was not found.
     34     Returned with ``TALER_EC_MERCHANT_TAN_CHALLENGE_UNKNOWN``.
     35   :http:statuscode:`409 Conflict`:
     36     Wrong TAN, returned with an
     37     error code of ``TALER_EC_MERCHANT_TAN_CHALLENGE_FAILED``.
     38   :http:statuscode:`429 Too many requests`:
     39     Too many failed confirmation attempts, a new TAN must be requested.
     40     Returned with ``TALER_EC_MERCHANT_TAN_TOO_MANY_ATTEMPTS``.