How it works

Suggest Edits

Orchestrate Embed allows you to offer a fully functional payment orchestration solution to your customers. Orchestrate Emebed providers an end UI that can easily be embedded into your applications.

Use Case

E-commerce building platforms: If your product allows customers easily build their own e-commerce store, Orchestrate embed can easily allow you to provide a payment orchestration solution to them. They get to see a range of supported payment providers across the world and can decide which would power their newly built e-commerce stores.

How to get started

Step 1: Call the embed endpoint from your server-side.

The embed endpoint generates a session URL that you can easily embed in your application as an Iframe or in open in a new tab. View reference for more details API REFERENCE

📘

Session Duration

For security purposes, a UI session only lasts for 30 minutes. We would advise that you generate a new session every time your customer interacts with the ember feature.

Generating a session

https://api.orchestrate.finance/v1/embed/session/ui

Request 

{
    "group": "new business name",
    "cancel_url": "https://myapp.test"
}

Response

{
    "success": true,
    "data": "https://app.orchestrate.finance/embed/payment-providers?session_id=62b55e1cdb4f39116566d2bf",
    "message": "new session generated"
}

<iframe style="width: 100%; height: 100vh; border: none;" src="https://app.orchestrate.finance/embed/payment-providers?session_id=62b55e1cdb4f39116566d2bf"></iframe>

Embed Reference

ParametersDescriptionRequired
groupthe group provides you with a way to easily classify easy data carried out on embed. it allows you great difference embed sessions for each of your customers. We advise you use a unique way of identifying your customers as the group value.True
cancel_urlwhen the embed UI is canceled we redirect the user to the cancel URL provided. We advise you provide a URL to your application.

Embed UI

3580

Updated 11 months ago