Spuštění Twisto Universal API (zastaralé)

Toto API je zastaralé!

Nové integrace používejte přes PSP API

Proces integrace

Během registrace vaší společnosti potřebujeme vypořádací bankovní účet, fakturační údaje a URL webhooků, které platí pro všechny registrované obchodníky / e-shopy.

Proces integrace lze rozdělit na tyto hlavní části, které jsou níže podrobněji popsány:

  • Příjem dat od PSP (odesílaných přes API na API).
  • Poskytnutí UI zákazníkům pro doplnění chybějících osobních údajů a souhlas s obchodními podmínkami
  • Provádění operací v dalších částech backendu Twisto (např. skórování úvěrového rizika, generování, rušení, aktivace a vracení faktur). Jakmile proces rozhodování začne, odešle se webhook se stavem checking. Možné výsledky rozhodnutí:
    • approved — odešle se webhook se stavem accepted
    • rejected — odešle se webhook se stavem rejected
    • error — odešle se webhook se stavem error
  • Po rozhodnutí je zákazník během 5 sekund automaticky přesměrován na URL zadané při vytvoření objednávky v kroku 1.
  • Vypořádání prostředků (odeslání peněz PSP, příjem peněz za refundace od PSP)
  • Notifikace PSP (přes webhook)

Aktivace

Pokud je přijata notifikace accepted, je nutné objednávku aktivovat pomocí POST order/{order_id}/activate, čímž Twisto informujete, aby zákazníkovi odeslala fakturu a objednávku označila jako uhrazenou / dokončenou. Po provedení je objednávka ve stavu activated.

Zrušení

Objednávku lze před aktivací zrušit pomocí POST /order/{order_id}/cancel. Po provedení je objednávka ve stavu canceled.

Refundace

Po aktivaci objednávky lze provést plnou nebo částečnou refundaci pomocí POST /order/{order_id}/refund. Po provedení je při plné refundaci objednávka ve stavu activated a při částečné refundaci zůstává ve stavu activated.

Tok stavů transakce

Sekvenční diagram transakce

Sekvenční diagram toku transakce Twisto

Webhookové notifikace o objednávce

O změnách objednávky Twisto informuje pomocí webhooků. Notifikace se odešle, když:

  • se stav objednávky změní na jeden z následujících:
    • rejected
    • accepted
    • error
    • canceled
    • activated
    • refunded
    • checking
  • Twisto převede peníze, což je v notifikaci označeno datem a časem ve poli date_settled

Poznámka: Požadavek obsahuje vlastní user-agent: Twisto/PSP. Informujte partnery, aby ho povolili.