Zachycení nebo zrušení platby (charge)

Volání API /capture a /cancel se týkají pouze flow autorizace a zachycení (Authorise and Capture).

Jakmile je objednávka zákazníka připravena k odeslání, musíte prostředky zachytit. Pokud objednávku z jakéhokoli důvodu nelze vyřídit, lze autorizaci místo toho zrušit.

Tento flow podporuje také částečné zachycení, pokud:

  • Lze vyřídit jen část objednávky
  • Objednávka obsahuje více položek odesílaných v různých časech

Zachycení (capture)

Toto API volání obsahuje:

  • Částku k zachycení

Toto volání /capture by mělo probíhat z vašeho serveru, nikoli přímo z klientského frontendu.

sequenceDiagram actor Customer Order Management->>Server: Order selected for shipping Server->>Twisto: POST<br/>/charges/{id}/capture Twisto->>Server: Return Charge<br/>with status 'captured' Server->>Order Management: Return Charge success Order Management->>Customer: Notify customer payment<br/>has been completed<br/>and goods are shipped

Požadavek

Id platby (charge) vrácené původním API voláním /charges se předá v endpointu capture k identifikaci zachycované platby. Například:

https://api.twisto.cz/psp/smi/charges/chargeId/capture

Příklad předání těchto informací:

{ "amount": 300 }

Částečné zachycení není k dispozici. Pokud ho potřebujete, použijte plné zachycení a následně částečnou refundaci.

Zrušení (cancel)

Pokud objednávku nelze vyřídit v celém rozsahu, je třeba zavolat /cancel, aby se uvolnily prostředky zákazníka.

Toto API volání nemá tělo požadavku.

Toto volání /cancel by mělo probíhat z vašeho serveru, nikoli přímo z klientského frontendu.

sequenceDiagram actor Customer Order Management->>Server: Order selected for cancellation Server->>Twisto: POST<br/>/charges/{id}/cancel Twisto->>Server: Return Charge<br/>with status 'cancelled' Server->>Order Management: Return Cancel success Order Management->>Customer: Notify customer payment<br/>has been cancelled<br/>and funds are released

Požadavek

Id platby (charge) vrácené původním API voláním /charges se předá v endpointu cancel k identifikaci rušené platby. Například:

https://api.twisto.cz/psp/smi/charges/chargeId/cancel