Web: Direct URL API integration
This integration is optimal for partners looking to leverage Paybis widget API functionality without installing widget web or mobile SDK. It enables the supply of initialization parameters via API and then generates a direct link to the widget. The URL can be opened via redirect, in a new browser tab/window, or within a web view in your mobile application.
Building integration
To ensure the security of your integration, signature verification is required for all Public and Private API requests.
To build the integration, follow these steps:
| No | Step | Endpoints (server-to-server) |
|---|---|---|
| 1 | Get the list of supported fiat currencies and crypto assets depending on the transaction flow type (Buy/Sell) | GET Currency Pairs Buy Crypto, GET Currency Pairs Sell Crypto |
| 2 | Request the Quote from Paybis for a certain amount and currency pair | POST Quote |
| 3 | Obtain the requestId required to initialize the widget | POST Request |
| 4 | Generate widget URL with the obtained requestId and extra optional query parameters | n/a |
Passwordless integration (Public API endpoint)
| No | Step | Endpoints (server-to-server) |
|---|---|---|
| 1 | Get the list of supported fiat currencies and crypto assets depending on the transaction flow type (Buy/Sell) | GET Currency Pairs Buy Crypto, GET Currency Pairs Sell Crypto |
| 2 | Request the Quote from Paybis for a certain amount and currency pair | POST Quote |
| 3 | Obtain the requestId required to initialize the widget | POST Request |
| 3.1 | Passwordless option Obtain the oneTimeToken optional to initialize the widget | |
| 4 | Generate widget URL with the obtained requestId and oneTimeToken (optional) extra optional query parameters | n/a |
Supported query parameters:
| Parameter | Required | Description | Comment |
|---|---|---|---|
requestId | mandatory | Session ID is required to initialize the widget. | It can be obtained from the POST Request endpoint response. It's important to obtain a new requestId per each user transaction.You can track the status of each user transaction by requestIdwhen getting Transaction status webhooks. |
successReturnURL | optional | Allows to set the URL to which a user is redirected after completing a transaction in the widget. | If the successReturnURL is specified, the Back to merchant button is displayed on the Transaction completed final screen in the widget. On clicking on the button, the user is redirected to this URL in the same browser tab. |
failureReturnURL | optional | Allows to set the URL to which a user is redirected after getting a transaction rejected/canceled in the widget. | If the failureReturnURLs specified, the Back to merchant button is displayed on the Transaction rejected/canceled final screen in the widget. On clicking on the button, the user is redirected to this URL in the same browser tab. |
oneTimeToken | optional | A unique token is generated for customer authorization. | One-time authentication token used as an argument on Widget initialization for automatic login of the customer More Single-sign on details |
Paybis Widget URL
Generate the widget URL using the following format:
https://{domain}/?requestId={requestId}&successReturnURL={urlencodedUrl}&failureReturnURL={urlencodedUrl}
The actual domain and encoded URLs need to be substituted into the placeholders:
domain:- Sandbox (for testing): widget.sandbox.paybis.com
- Production: widget.paybis.com
requestId: A string in the following format:uuid. For example,a122b998-15a4-4442-8b9e-2add17d59617.urlencodedUrl: A URL-encoded string for success and failure return URLs.
Updated 2 months ago