Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space ENWORK and version Documentation

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording

...

REST API uses 2 types of payment flows:

  • Asynchronous
  • Synchronous

Asynchronous payment

These payments receive final response asynchronously and you are responsible to fetch the final status from

...

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
.


In

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
REST API these payments are handled following way:

  1. Your application calls

...

  1. Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePlatform-Kurz
    PageWithExcerptWording
    , in Body of Request are defined:
    1. Payment method
    2. Your Return URL (preferably containing ID to reference payment when

...

    1. Multiexcerpt include
      SpaceWithExcerptEN
      MultiExcerptNamePlatform-Kurz
      PageWithExcerptWording
      will redirect to this URL)
    2. Webhook URL

...

  1. Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePlatform-Kurz
    PageWithExcerptWording

...

  1. responds synchronously, in Body of Response is defined Redirection URL
  2. Your application is responsible to redirect browser to Redirection URL

...

  1. Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePlatform-Kurz
    PageWithExcerptWording
    receives response from 3rd party payment method with

...

  1. result of payment

...

  1. Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePlatform-Kurz
    PageWithExcerptWording
    calls your Webhook URL with just

...

  1. PaymentID in the body of

...

  1. request
  2. Your application is responsible to call

...

  1. Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePlatform-Kurz
    PageWithExcerptWording
    to fetch the status of the payment, using

...

  1. PaymentID
  2. Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePlatform-Kurz
    PageWithExcerptWording

...

  1. redirects client back to Merchant Return URL


Sequence diagram

...

Multiexcerpt
MultiExcerptNameProcessFlow_asynchron

draw.io Diagram
bordertrue
diagramNameREST_asynchron_CT
simpleViewerfalse
linksauto
tbstyletop
lboxtrue
diagramWidth1109


Synchronous payment

These payments receive final response synchronously

...

in response to initial Request.


In

...

Multiexcerpt include
SpaceWithExcerptEN
MultiExcerptNamePlatform-Kurz
PageWithExcerptWording
REST API

...

these payments are handled following way:

  1. Your application calls

...

  1. Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePlatform-Kurz
    PageWithExcerptWording
    , in Body of Request is defined

...

  1. payment method

...

  1. Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePlatform-Kurz
    PageWithExcerptWording
    responds synchronously, in Body of Response are defined:

    ...

      1. PaymentID
      2. Status


    Sequence diagram

    ...

    Image Removed

    ...

    Multiexcerpt
    MultiExcerptNameProcessFlow_synchron

    draw.io Diagram
    bordertrue
    diagramNameREST_synchron_CT
    simpleViewerfalse
    linksauto
    tbstyletop
    lboxtrue
    diagramWidth821


    Subsequent actions

    After the initial

    ...

    payment is created, there is set of possible

    ...

    actions that can be performed on the

    ...

    payment:

    • Reversal
    • Capture
    • Refund (Credit)

    All of these subsequent

    ...

    actions have synchronous flow.


    Webhooks

    For payment methods with asynchronous flow or any updates on the payment status,

    ...

    Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePlatform-Kurz
    PageWithExcerptWording
    sends notifications to your defined Webhook URL.

    For security purposes, Webhook contains only non sensitive

    ...

    PaymentID and your application is responsible to fetch the status of payment by actively calling the API.


    In

    ...

    Multiexcerpt include
    SpaceWithExcerptEN
    MultiExcerptNamePlatform-Kurz
    PageWithExcerptWording
    REST API

    ...

    Webhooks are handled following way:

    ...

    1. Multiexcerpt include
      SpaceWithExcerptEN
      MultiExcerptNamePlatform-Kurz
      PageWithExcerptWording
      calls your Webhook URL

      ...

        1. PaymentID is in the body of

      ...

        1. request
      1. Your application calls

      ...

      1. Multiexcerpt include
        SpaceWithExcerptEN
        MultiExcerptNamePlatform-Kurz
        PageWithExcerptWording
        and fetches the status of the payment

      ...

      1. using

      ...

      1. PaymentID