Skip to content
PayplugPayplug Elements

How it works

The big picture in one diagram. What happens during a split payment, the four steps you control, and everything the components handle.

Payplug Elements let the payer settle one order in several tranches, using several payment methods, until the total is covered. Each tranche is held as an authorization, and nothing is actually charged until the order is paid for in full. Nobody ever pays for a fraction of an order.

As an integrator, your work comes down to four tasks. This page shows what each task is before you start implementing it.

The dots represent your integration.

The rest is taken care of: the Payplug Elements collect what the payer intends, and the orchestrator turns those intentions into transactions.

Your customer places an order on your page. Your server authenticates, creates a payment session, and receives an elementsToken, which it hands to the page along with the components. The customer then pays the order in one or more tranches: each one is authorized with a processing API, whose verdict comes back out of band. Once the total is covered the captures go out on their own, your customer sees the confirmation, and a notification tells your server the order is paid. Four arrows carry a dot: they are the four tasks you implement.until the total is reachedyour customer placesthe order1. authenticate2. create the sessionelementsToken3. integrate the elementswith the elementsTokenyour customer pays a trancheauthorizationthe verdict, out of bandthe status of the tranche is updatedcaptures are triggeredonce the total is reachedthe order is confirmed4. the notification:the order is paidYour page(your customer)Your serverPayplug Elements APIProcessing APIs

Your four tasks

Section titled “Your four tasks”
  1. Authenticate. Your server exchanges your credentials for a short-lived access token. One single call for the whole lifetime of that access token.
  2. Create the session. Still on your server: you declare the order (its total, its currency, the methods you accept…) and you receive an opaque token for the elements.
  3. Show the elements. Your page loads one script, composes the components where you want them, and hands them that token. From there the checkout runs itself.
  4. Handle the notification. When the session ends, we call a notification URL you declared. That is how you learn the order is paid.

Dig deeper with the documentation

Section titled “Dig deeper with the documentation”

Tasks 1 and 2 live together on Create a session, task 3 on Show the elements, and task 4 has its own page: webhooks.