Ověřovací API

Poznámka: Tato část API je určena jen pro paywally a e-shopy ji nemusí implementovat. Ověřovací API je v současnosti vypnuté.

Toto API slouží k ověření zákazníka. Kód je zákazníkovi zaslán SMS nebo v aplikaci. Tento kód zadá na vašem webu. Poté se porovná s tím, co bylo uživateli odeslano. Při shodě lze vytvořit fakturu.

K testu tohoto API je potřeba vytvořit objednávku s e-mailem zákazníka sms.test@example.com, tedy objekt Customer musí mít email nastaveno na tuto hodnotu. Tento zákazník bude v testovacím API přijat (odpověď bude mít status nastaveno na accepted-verification-required). Ověřovací kód 1234 bude vždy přijat, cokoli jiného bude zamítnuto. Bez ověření nelze fakturu vytvořit.

Požadavek na odeslání ověřovacího kódu

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --header "Authorization: your-public-key,your-secret-key" \
'https://api.twisto.cz/v2/check/12312312123/verification/send/'

Odpověď

Odpověď na odeslání ověřovacího kódu má dvě části: message_id a message. message_id je číslo zprávy a message obsahuje samotný text. Zprávy jsou pouze v angličtině.

Ověřovací kód lze odeslat hned po skončení vyhodnocení. Druhý požadavek musí být nejdříve 10 sekund po konci vyhodnocení, jinak se znovu odešle ověřovací kód. Jinak se vrátí odpověď s message_id 1.
Ověřovací kód lze odeslat nejvýše 2×. Pokud zákazník tento limit překročí, vrátí se odpověď s message_id 2.

Parametry dotazu pro vyhledávání

Message_id	Message	Akce	Konečný stav	HTTP Status
`0`	Verification code has been sent			`200`
`1`	Resend requested too early			`400`
`2`	Resends exceeded	Disable resent		`400`
`3`	Cannot verify the payment	Disable resent	✓	`400`

{
  "message_id": 0,
  "message": "Verification code has been sent"
}

{
  "message_id": 1,
  "message": "Resend requested too early"
}

{
  "message_id": 2,
  "message": "Resends exceeded"
}

{
  "message_id": 3,
  "message": "Cannot verify transaction"
}

Odeslání ověřovacího kódu

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --header "Authorization: your-public-key,your-secret-key" \
     --data '{"code": "1234"}' \
'https://api.twisto.cz/v2/check/0f38de72lkxjpk55evbid62k/verification/'

Odpověď

Odpověď na ověření kódu má dvě části: message_id a message. message_id je číslo zprávy a message obsahuje text. Zprávy jsou pouze v angličtině.

Maximální počet pokusů o zadání ověřovacího kódu je 50.
Prázdné požadavky se do tohoto limitu nezapočítávají.
Transakce vyprší jednu hodinu po skončení vyhodnocení. Znovuodeslání ověřovacího kódu na to nemá vliv.

Parametry dotazu pro vyhledávání

Message_id	Message	Akce	Konečný stav	HTTP Status
`0`	Successful verification	Create invoice	✓	`200`
`1`	Verification code does not match			`400`
`2`	Transaction has expired	Disable Twisto payment	✓	`400`
`3`	Maximum tries exceeded	Disable Twisto payment	✓	`400`
`4`	Cannot verify the payment	Disable Twisto payment	✓	`400`

{
  "message_id": 0,
  "message": "Successful verification"
}

{
  "message_id": 1,
  "message": "Verification code does not match"
}

{
  "message_id": 2,
  "message": "Transaction has expired"
}

{
  "message_id": 3,
  "message": "Maximum tries exceeded"
}

{
  "message_id": 4,
  "message": "Cannot verify transaction"
}