Paybis

https://docs.payb.is/docs/
Admin
Paybis provides plug-and-play payment solutions bridging traditional finance and crypto, offering...
Tokens:47,451
Snippets:158
Trust Score:2.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Start Paybis Widget (Swift)

Source: https://docs.payb.is/docs/mobile-ios-sdk

This is the basic example of starting the Paybis widget by calling the `startWidget` function with required parameters like environment, requestId, and customAppScheme.

```swift
import PaybisMobileWidgetSDK
...
PaybisMobileWidget.startWidget(
	environment: ENVIRONMENT,
	requestId: REQUEST_ID,
  customAppScheme: CUSTOM_SCHEME://,
)
```

--------------------------------

### Start Paybis Widget - Multiple Options (Swift)

Source: https://docs.payb.is/docs/mobile-ios-sdk

This snippet provides various ways to start the Paybis widget, including combinations with one-time tokens and merchant identifiers. It demonstrates the flexibility in configuring the widget's launch.

```swift
import PaybisMobileWidgetSDK
...
// Without one time token
PaybisMobileWidget.startWidget(
  environment: ENVIRONMENT,
  requestId: REQUEST_ID,
  customAppScheme: CUSTOM_SCHEME://
)
// With one time token
PaybisMobileWidget.startWidget(
  environment: ENVIRONMENT,
  requestId: REQUEST_ID,
  customAppScheme: CUSTOM_SCHEME://,
  oneTimeToken: ONE_TIME_TOKEN
)
// With merchant identifier
PaybisMobileWidget.startWidget(
  environment: ENVIRONMENT,
  requestId: REQUEST_ID,
  customAppScheme: CUSTOM_SCHEME://,
  oneTimeToken: ONE_TIME_TOKEN,
  merchantId: MERCHANT_ID
)
```

--------------------------------

### Start Paybis Widget with One-Time Token (Swift)

Source: https://docs.payb.is/docs/mobile-ios-sdk

This example shows how to start the Paybis widget while skipping authentication by providing an optional `oneTimeToken`. This token is generated when the `passwordless` parameter is set to `true` during request creation.

```swift
import PaybisMobileWidgetSDK
...
PaybisMobileWidget.startWidget(
	environment: ENVIRONMENT,
	requestId: REQUEST_ID,
  customAppScheme: CUSTOM_SCHEME://,
	oneTimeToken: OPTIONAL_ONE_TIME_TOKEN
)
```

--------------------------------

### Start Paybis Widget with Custom App Scheme (Swift)

Source: https://docs.payb.is/docs/mobile-ios-sdk

This snippet demonstrates how to pass a custom app scheme to the widget, enabling redirects back to your application after a successful APM flow. Ensure the scheme is defined in your app's Info tab.

```swift
import PaybisMobileWidgetSDK
...
PaybisMobileWidget.startWidget(
  ...
  customAppScheme: CUSTOM_SCHEME://,
)
```

--------------------------------

### Start Paybis Widget with Request ID

Source: https://docs.payb.is/docs/mobile-android-sdk

Initiate the Paybis crypto purchase flow by calling `startWidget` with your application context, environment, and a generated `requestId`. This starts a new activity for the user authentication and purchase process.

```kotlin
PaybisMobileWidget.startWidget(
    application,
    PaybisEnvironment.SANDBOX,
    "<generated_request_id>",
    null,
    false
)
```

--------------------------------

### Start Payb.is Widget with Request ID and Token (Kotlin)

Source: https://docs.payb.is/docs/mobile-android-sdk

Shows how to initiate the Payb.is widget using a provided request ID and an optional one-time token. It also demonstrates selecting the correct Paybis environment (production or sandbox) based on the application's build flavor.

```kotlin
class ExampleActivity : AppCompatActivity() {
  
  private val vm by viewModels<ExampleViewModel>()
  
  ...
  
  override fun onStart() {
    ...
    // Here should be your logic to retreive `requestId` and `oneTimeToken` (if needed)
    vm.requestCreated
    	.onEach { request ->
        startWidget(request.requestId, request.oneTimeToken)
      }
      .launchIn(lifecycleScope)
  }
  
  private fun startWidget(requestId: String, oneTimeToken: String?) {
    // some logic to define which environment you want to use
    val paybisEnv =
       if (BuildConfig.FLAVOR == "prod") PaybisEnvironment.PROD
       else PaybisEnvironment.SANDBOX
    
    PaybisMobileWidget.startWidget(
      application,
      paybisEnv,
      requestId,
      oneTimeToken,
    )
  }
}
```

--------------------------------

### Start Paybis Widget with Merchant ID (Swift)

Source: https://docs.payb.is/docs/mobile-ios-sdk

This snippet shows how to connect a merchant identifier to the SDK when starting the widget, which is necessary for supporting Apple Pay.

```swift
import PaybisMobileWidgetSDK
...
PaybisMobileWidget.startWidget(
  ...
	merchantId: MERCHANT_ID
)
```

--------------------------------

### Get Supported Cryptocurrencies for Swaps

Source: https://docs.payb.is/docs/crypto-acquiring-integration-guide

Retrieve a list of cryptocurrencies that are supported for swap operations via the Paybis API.

```APIDOC
## GET /currencypairs/swapcrypto

### Description
Retrieves a list of supported cryptocurrencies for crypto-to-crypto swaps.

### Method
GET

### Endpoint
`/currencypairs/swapcrypto`

### Parameters

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **data** (array) - A list of supported currency pairs for swaps.
  - **fromCurrency** (string) - The originating cryptocurrency symbol.
  - **toCurrency** (string) - The destination cryptocurrency symbol.
  - **logoUrl** (string) - URL for the logo of the currency.

#### Response Example
```json
{
  "data": [
    {
      "fromCurrency": "BTC",
      "toCurrency": "ETH",
      "logoUrl": "https://example.com/logos/btc.png"
    },
    {
      "fromCurrency": "ETH",
      "toCurrency": "USDT",
      "logoUrl": "https://example.com/logos/eth.png"
    }
  ]
}
```
```

--------------------------------

### Handle Payment Initiated Event in Swift

Source: https://docs.payb.is/docs/mobile-ios-sdk

This example shows how to respond to the payment-initiated event from the Paybis Mobile Widget in Swift. It includes closing the widget and a placeholder for custom payment logic, after which the widget can be reopened with the same request.

```swift
PaybisMobileWidget.instance.onPaymentInitiated = { [weak self] in
  PaybisMobileWidget.closeWidget()
  // handle necessary payment operation here and reopen the widget with same request
}
```

--------------------------------

### GET /currency_pairs/swap_crypto

Source: https://docs.payb.is/docs/crypto-acquiring-integration-guide

Retrieves available cryptocurrency pairs for swap operations, allowing partners to display user-selectable options.

```APIDOC
## GET /currency_pairs/swap_crypto

### Description

Retrieve a list of available cryptocurrency pairs for currency swaps. This endpoint allows partners to fetch and display the supported crypto pairs to their users.

### Method

GET

### Endpoint

/currency_pairs/swap_crypto

### Parameters

#### Query Parameters

None

### Response

#### Success Response (200)

- **pairs** (array) - An array of objects, where each object represents a cryptocurrency pair with relevant details.

#### Response Example

```json
{
  "pairs": [
    {
      "from": "ETH-SEPOLIA",
      "to": "USDT-TRC20-SHASTA"
    }
    // ... more currency pairs
  ]
}
```
```

--------------------------------

### Widget SDK Usage Example with Button Click

Source: https://docs.payb.is/docs/web-javascript-sdk

This example shows how to integrate the Paybis widget within a partner website that uses AJAX. It includes a button that, when clicked, calls a JavaScript function to open the widget. This function ensures the `PartnerExchangeWidget` is loaded before attempting to open it with a specific `requestId`.

```javascript
<script>
  !function(){if(window.PartnerExchangeWidget=window.PartnerExchangeWidget||{open(e){window.partnerWidgetSettings={immediateOpen:e}}},"PartnerExchangeWidget"!==window.PartnerExchangeWidget.constructor.name){(()=>{const e=document.createElement("script");e.type="text/javascript",e.defer=!0,e.src="/partner-exchange-widget.js";const t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(e,t)})()}}();
</script>

<button onclick="openWidget()">Transfer crypto</button>

function openWidget() {
  // Pay attention that for this step partner already needs to have requestId
  window.PartnerExchangeWidget.open({
    requestId: '<genereated unique requestId>', 
  })
}
```

--------------------------------

### Supported Locales and States

Source: https://docs.payb.is/docs/pnp-web-sdk-integration

Lists of supported locales and possible states for the wallets application.

```APIDOC
## Supported Locales

Following locales can be used as the value for the `locale` argument:
`en`, `de`, `ru`, `it`, `fr`, `es`, `pt`, `ko`

## Supported State Values

The Plug&Play Wallets application may be in one of the following states:

- `initial`: SDK has just been loaded.
- `startLoading`: Plug&Play application started to load.
- `loaded`: Plug&Play application is loaded.
- `completed`: A specific transaction within Plug&Play was completed.
- `rejected`: A specific transaction within Plug&Play was rejected.
- `cancelled`: User cancelled a transaction.
- `closed`: App requests to close, but the iframe is not yet removed.
- `terminated`: App was closed and the iframe was removed.

**Note**: Application's `state` is not available when the Application is opened in a new tab.
```

--------------------------------

### Available Paybis Environments

Source: https://docs.payb.is/docs/mobile-android-sdk

This enum defines the possible environments for the Paybis SDK: `SANDBOX`, `QA`, and `PROD`. Choose the appropriate environment when starting the widget.

```kotlin
enum class PaybisEnvironment {
    SANDBOX, QA, PROD
}
```

--------------------------------

### Install Paybis SDK with CocoaPods

Source: https://docs.payb.is/docs/mobile-ios-sdk

This Ruby code snippet defines the sources and dependencies for integrating the Paybis Mobile Widget SDK into an iOS project using CocoaPods. Ensure your project has a Podfile and update the target name accordingly.

```ruby
source 'https://gitlab.com/techcloud/shared/widget-sdk-ios-spec'
source 'https://github.com/CocoaPods/Specs.git'
source 'https://github.com/SumSubstance/Specs.git'

target 'WidgetExampleApp' do
  # Comment the next line if you don't want to use dynamic frameworks
  use_frameworks!

  # Pods for WidgetExampleApp
  pod 'PaybisMobileWidgetSDK'
end
```

--------------------------------

### JSON Response for Quote API

Source: https://docs.payb.is/docs/crypto-acquiring-integration-guide

This is an example JSON response from the Quote API. It includes a unique 'id' for the quote, the currency pair details ('currencyCodeTo', 'currencyCodeFrom'), the 'requestedAmount' with its currency, and available 'payoutMethods'. This response is crucial for initiating a transaction.

```json
{
  "id": "b83f478f-227b-42a7-a53e-fed76d4cb222",
  "currencyCodeTo": "USDT-TRC20-SHASTA",
  "currencyCodeFrom": "ETH-SEPOLIA",
  "requestedAmount": {
    "amount": "100.00",
    "currencyCode": "USD"
  },
  "requestedAmountType": "from",
  "payoutMethods": [
    {
      "id": "ca-test-tether-trc-20",
      "name": "Tether",
      "// ... other fields"
    }
  ]
}
```

--------------------------------

### Quote Request Body Examples (JSON)

Source: https://docs.payb.is/docs/integration-guide-v2

These JSON examples demonstrate the structure for requesting a quote from Paybis. The first example is for when the user is spending fiat currency, and the second is for when a crypto amount is specified for payout to a wallet. Both require currency codes, amount, direction, payment method, and a flag indicating fee handling.

```json
{
  "currencyCodeFrom": "USD",
  "amount": "100",
  "currencyCodeTo": "USDT-TRC20-SHASTA",
  "directionChange": "from",
  "paymentMethod": "{yourbrand}-credit-card",
  "isReceivedAmount": false
}
```

```json
{
  "currencyCodeFrom": "USD",
  "amount": "100",
  "currencyCodeTo": "USDT-TRC20-SHASTA",
  "directionChange": "to",
  "paymentMethod": "{yourbrand}-credit-card",
  "isReceivedAmount": true
}
```

--------------------------------

### Create Transaction Request

Source: https://docs.payb.is/docs/crypto-acquiring-integration-guide

Initiate a transaction based on a previously generated quote. This endpoint is used to start the payment process.

```APIDOC
## POST /request/v2

### Description
Creates a transaction request using a previously generated quote ID. This endpoint initiates the payment process.

### Method
POST

### Endpoint
`/request/v2`

### Parameters

#### Request Body
- **quoteId** (string) - Required - The ID of the quote generated by the Create Quote API.
- **partnerTransactionId** (string) - Optional - A unique identifier for the transaction provided by the partner.
- **redirectUrl** (string) - Required - The URL to redirect the user to after the transaction is initiated.

### Request Example
```json
{
  "quoteId": "q_abc123xyz789",
  "partnerTransactionId": "my_unique_ref_123",
  "redirectUrl": "https://partner.com/payment/success"
}
```

### Response
#### Success Response (200)
- **transactionId** (string) - Unique identifier for the created transaction.
- **paymentUrl** (string) - The URL where the user can complete the payment.

#### Response Example
```json
{
  "transactionId": "tx_abcdef123456",
  "paymentUrl": "https://pay.payb.is/tx/abcdef123456"
}
```
```

--------------------------------

### Wallets UI Getters

Source: https://docs.payb.is/docs/pnp-web-sdk-integration

Methods to retrieve the current state and loading status of the wallets UI.

```APIDOC
## Getters

### `state`

#### Description
Returns the current state of the application.

#### Method
`state`

#### Returns
`enum` - The current state (e.g., `initial`, `loaded`, `completed`).

### `isLoaded`

#### Description
A shorthand for checking if the state is `loaded`. Indicates that the plug&play wallets app has been loaded.

#### Method
`isLoaded`

#### Returns
`boolean`

### `loader`

#### Description
Returns the loader property of the application.

#### Method
`loader`

#### Returns
`boolean | object`

### `loaderImage`

#### Description
Returns the path to the preloader image, if one is presented.

#### Method
`loaderImage`

#### Returns
`string | undefined`

### `loaderBackground`

#### Description
Returns the background color of the loader, if one is presented.

#### Method
`loaderBackground`

#### Returns
`string | undefined`
```

--------------------------------

### Transaction Flow & Currency Parameters

Source: https://docs.payb.is/docs/standalone-widget-integration-via-web-sdk

This section details how to configure the transaction flow (buy or sell crypto) and specify the fiat and cryptocurrency codes for the widget.

```APIDOC
## Transaction Flow & Currency Parameters

When setting a fiat currency in the widget (the currency the user pays or receives), it is also required to specify the cryptocurrency. The widget cannot determine the fiat currency in isolation — the crypto side of the transaction must always be defined.

### Buy Crypto (`transactionFlow=buyCrypto` or not provided)
To define the fiat currency the user spends (e.g. `currencyCodeFrom=EUR`), you must also define the crypto they will receive (e.g. `currencyCodeTo=ETH`).

**Example:**
`https://widget.paybis.com/?currencyCodeFrom=EUR&currencyCodeTo=ETH&partnerId={partner UUID}&transactionFlow=buyCrypto&signature={signature}`

*If `transactionFlow` is omitted, it defaults to `buyCrypto`.*

### Sell Crypto (`transactionFlow=sellCrypto`)
To define the fiat currency the user receives (e.g. `currencyCodeTo=USD`), you must also define the crypto the user will sell (e.g. `currencyCodeFrom=BTC`).

**Example:**
`https://widget.paybis.com/?currencyCodeFrom=BTC&currencyCodeTo=USD&partnerId={partner UUID}&transactionFlow=sellCrypto&signature={signature}`

### Parameters

#### Query Parameters
- **currencyCodeFrom** (string) - Required - The currency code for the transaction (e.g., EUR, BTC).
- **currencyCodeTo** (string) - Required - The currency code for the transaction (e.g., ETH, USD).
- **partnerId** (string) - Required - Your unique partner UUID.
- **transactionFlow** (string) - Optional - Specifies the transaction type. Accepted values: `buyCrypto` (default), `sellCrypto`.
- **signature** (string) - Required - A signature for transaction verification.
```

--------------------------------

### Paybis API Parameters

Source: https://docs.payb.is/docs/standalone-widget-integration-via-web-sdk

This section details the parameters accepted by the Paybis API, which can be used to pre-fill user flows and configure transaction details.

```APIDOC
## Supported Parameters

The Paybis API allows for customization of user flows through various optional and required parameters. These parameters can pre-fill information such as crypto addresses, currency codes, and amounts, or define the transaction type and user interface locale.

### Method
GET (Implied, as parameters are for URL construction)

### Endpoint
(Not explicitly defined, but parameters are used in URL construction for the 'open' method)

### Parameters
#### Query Parameters
- **partnerId** (string) - Required - Unique identifier of your product provided by Paybis account manager.
- **signature** (string) - Mandatory - Security signature for the URL request, generated using query parameters and a secret key.
- **cryptoAddress** (string) - Optional - User's crypto wallet address. Pre-fills the wallet entry screen.
- **currencyCodeFrom** (string) - Optional - Fiat currency code for buy crypto, or cryptocurrency code for sell crypto transactions.
- **currencyCodeTo** (string) - Optional - Cryptocurrency code for buy crypto, or fiat currency code for sell crypto transactions.
- **amountFrom** (number) - Optional - Amount in fiat to spend (buy) or crypto amount to withdraw (sell).
- **amountTo** (number) - Optional - Crypto amount paid out (buy) or fiat amount paid out (sell).
- **transactionFlow** (string) - Optional - Defines the transaction flow type. Possible values: `buyCrypto` (default), `sellCrypto`.
- **partnerUserId** (string) - Optional - Identifier of the customer in the partner's system, returned in webhook notifications.
- **locale** (string) - Optional - Defines the preferable UI language schema. Possible values: `en` (default), `de`, `ru`, `it`, `fr`, `es`, `pt`, `ko`.
- **successReturnURL** (string) - Optional - URL to redirect the user after completing a transaction successfully.
- **failureReturnURL** (string) - Optional - URL to redirect the user after a transaction is rejected or canceled.
- **canClose** (boolean) - Optional - Allows to hide the Close widget icon on UI.

### Request Example
(Constructed URL using query parameters, example below is illustrative)
`https://widget.paybis.com/?partnerId=YOUR_PARTNER_ID&signature=YOUR_SIGNATURE&cryptoAddress=0x123...&currencyCodeFrom=USD&currencyCodeTo=BTC&amountFrom=100&transactionFlow=buyCrypto`

### Response
(This section describes parameters, not direct API responses. Successful API calls would typically redirect or trigger webhooks.)
#### Success Response (200)
(N/A - This documentation focuses on input parameters for URL construction)

#### Response Example
(N/A - This documentation focuses on input parameters for URL construction)
```

--------------------------------

### Example Success Response (JSON)

Source: https://docs.payb.is/docs/emi-partner-api-integration-guide

An example of a successful response when retrieving EMI payment details. The JSON object contains the payment amount, currency, order ID, and detailed bank information required for the EMI transaction.

```JSON
{
  "amount": "123.45",
  "currency": "EUR",
  "orderId": "unique_order_identifier_string",
  "bankRequisites": {
    "bankName": "Example Bank",
    "bankAddress": "123 Bank Street, City, Country",
    "accountHolderName": "John Doe",
    "iban": "DE89370400440532013000",
    "swift": "EXAMPLEBANK"
  }
}
```

--------------------------------

### Get Supported Currency Pairs and Payout Methods

Source: https://docs.payb.is/docs/frictionless-off-ramping-for-wallets

Retrieve a list of supported crypto-to-fiat currency pairs and available payout methods for withdrawal.

```APIDOC
## GET /currency_pairs/sell_crypto

### Description
Retrieves a list of supported cryptocurrency pairs for selling and their associated payout methods.

### Method
GET

### Endpoint
/currency_pairs/sell_crypto

### Parameters

#### Query Parameters
- **fiatCurrency** (string) - Optional - The fiat currency for which to retrieve pairs.

### Response
#### Success Response (200)
- **currencyPairs** (array) - List of supported currency pairs.
  - **cryptoCurrency** (string) - The cryptocurrency symbol.
  - **fiatCurrency** (string) - The fiat currency symbol.
  - **payoutMethods** (array) - List of payout methods available for this pair.
    - **methodName** (string) - The name of the payout method.
    - **methodLogoUrl** (string) - URL for the payout method logo.
    - **minAmount** (number) - Minimum transaction amount.
    - **maxAmount** (number) - Maximum transaction amount.
    - **commissionPercent** (number) - Commission percentage.
    - **commissionFixed** (number) - Fixed commission amount.

#### Response Example
```json
{
  "currencyPairs": [
    {
      "cryptoCurrency": "BTC",
      "fiatCurrency": "USD",
      "payoutMethods": [
        {
          "methodName": "credit-card-paybis",
          "methodLogoUrl": "https://example.com/logo.png",
          "minAmount": 50,
          "maxAmount": 10000,
          "commissionPercent": 2.5,
          "commissionFixed": 1.0
        }
      ]
    }
  ]
}
```
```

--------------------------------

### POST /request/v2

Source: https://docs.payb.is/docs/crypto-acquiring-integration-guide

Initiates a transaction request using a provided quote ID and essential user details.

```APIDOC
## POST /request/v2

### Description

Initiates a transaction request using a previously generated `quote ID`. This endpoint requires essential user information to proceed with the transaction.

### Method

POST

### Endpoint

/request/v2

### Parameters

#### Request Body

- **quoteId** (string) - REQUIRED - The unique ID obtained from the Quote API, used to define the transaction amount and cryptocurrency.
- **locale** (string) - REQUIRED - The customer's preferred locale, provided in ISO alpha-2 format (e.g., "en", "es").
- **partnerUserId** (string) - REQUIRED - A unique identifier for the customer within the Partner's system.
- **email** (string) - REQUIRED - The user's email address.

### Request Example

```json
{
  "quoteId": "b83f478f-227b-42a7-a53e-fed76d4cb222",
  "locale": "en",
  "partnerUserId": "user123",
  "email": "user@example.com"
}
```

### Response

#### Success Response (200)

- **transactionId** (string) - The unique ID for the initiated transaction.
- **paymentUrl** (string) - The URL to redirect the user to complete the payment.

#### Response Example

```json
{
  "transactionId": "txn_abc123xyz",
  "paymentUrl": "https://widget.payb.is/payment?token=..."
}
```
```

--------------------------------

### Direct URL API Integration - Get Supported Currency Pairs

Source: https://docs.payb.is/docs/integration-guide-1

Retrieves a list of supported fiat and cryptocurrencies for buying crypto via the Paybis API.

```APIDOC
## GET /v2/currency/pairs/buy-crypto

### Description
Retrieves a list of supported fiat and cryptocurrencies available for purchasing crypto through the Paybis platform.

### Method
GET

### Endpoint
/v2/currency/pairs/buy-crypto

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **supported_pairs** (array) - A list of objects, where each object contains details about a supported currency pair.
  - **fiat_currency** (string) - The fiat currency code (e.g., "USD").
  - **crypto_currency** (string) - The cryptocurrency code (e.g., "BTC").
  - **buy_enabled** (boolean) - Indicates if buying is enabled for this pair.
  - **sell_enabled** (boolean) - Indicates if selling is enabled for this pair.

#### Response Example
```json
{
  "supported_pairs": [
    {
      "fiat_currency": "USD",
      "crypto_currency": "BTC",
      "buy_enabled": true,
      "sell_enabled": false
    },
    {
      "fiat_currency": "EUR",
      "crypto_currency": "ETH",
      "buy_enabled": true,
      "sell_enabled": true
    }
  ]
}
```
```

--------------------------------

### Wallets UI Methods

Source: https://docs.payb.is/docs/pnp-web-sdk-integration

Methods to control the opening and closing of the Payb.is wallets user interface.

```APIDOC
## Methods

### `open`

#### Description
Opens application UI in an iframe full-screen overlay.

#### Method
`open`

#### Parameters
- **sessionId** (string) - Required - The session ID for the user.
- **partnerProductId** (string) - Required - The product ID of the partner.
- **oneTimeToken** (string) - Required - A one-time token for authentication.
- **locale** (enum) - Optional - The locale for the UI (e.g., `en`, `de`, `fr`).

#### Returns
`void`

### `openInIframe`

#### Description
Opens the application UI in an iframe full-screen overlay.

#### Method
`openInIframe`

#### Parameters
- **sessionId** (string) - Required - The session ID for the user.
- **partnerProductId** (string) - Required - The product ID of the partner.
- **oneTimeToken** (string) - Required - A one-time token for authentication.
- **locale** (enum) - Optional - The locale for the UI (e.g., `en`, `de`, `fr`).

#### Returns
`void`

### `detectAndOpen`

#### Description
Opens the application UI using the best appropriate method depending on the user's browser. This includes options for a new browser tab (Safari), an iframe (all browsers except Safari), or a redirect in the same tab (Safari if new tab fails).

#### Method
`detectAndOpen`

#### Parameters
- **sessionId** (string) - Required - The session ID for the user.
- **partnerProductId** (string) - Required - The product ID of the partner.
- **oneTimeToken** (string) - Required - A one-time token for authentication.
- **locale** (enum) - Optional - The locale for the UI (e.g., `en`, `de`, `fr`).

#### Returns
`void`

### `openInNewTab`

#### Description
Opens the application UI in a new browser tab. Ensure no asynchronous actions occur between user interaction and this call to avoid browser security cancellations.

#### Method
`openInNewTab`

#### Parameters
- **sessionId** (string) - Required - The session ID for the user.
- **partnerProductId** (string) - Required - The product ID of the partner.
- **oneTimeToken** (string) - Required - A one-time token for authentication.
- **locale** (enum) - Optional - The locale for the UI (e.g., `en`, `de`, `fr`).

#### Returns
`void`

### `openRedirect`

#### Description
Opens the application UI by redirecting the user from the partner's website to the plug&play wallets URL in the same browser tab.

#### Method
`openRedirect`

#### Parameters
- **sessionId** (string) - Required - The session ID for the user.
- **partnerProductId** (string) - Required - The product ID of the partner.
- **oneTimeToken** (string) - Required - A one-time token for authentication.
- **locale** (enum) - Optional - The locale for the UI (e.g., `en`, `de`, `fr`).

#### Returns
`void`

### `close`

#### Description
Triggers an exit from the wallets UI. Only usable if wallets were initiated with `openInIframe` or `open` methods.

#### Method
`close`

#### Parameters
*None*

#### Returns
`void`
```

--------------------------------

### Embed Paybis Widget Web SDK (Production)

Source: https://docs.payb.is/docs/standalone-widget-integration-via-web-sdk

Embeds the Paybis Widget Web SDK script for the production environment. This script initializes the widget on your webpage.

```html
<script>
  !function() {
    if (window.PartnerExchangeWidget = window.PartnerExchangeWidget || { open(e) { window.partnerWidgetSettings = { immediateOpen: e } } }, 
        "PartnerExchangeWidget" !== window.PartnerExchangeWidget.constructor.name) {
      (() => {
        const e = document.createElement("script");
        e.type = "text/javascript";
        e.defer = true;
        e.src = "https://widget.paybis.com/partner-exchange-widget.js"; // For Production
        const t = document.getElementsByTagName("script")[0];
        t.parentNode.insertBefore(e, t);
      })();
    }
  }();
</script>
```

--------------------------------

### Retrieve Available Currency Pairs

Source: https://docs.payb.is/docs/integration-guide-v2

Use the GET /v2/currency/pairs/buy-crypto endpoint to obtain a list of supported fiat currencies for payment, enabling the display of valid options to users.

```APIDOC
## GET /v2/currency/pairs/buy-crypto

### Description
Retrieves a list of supported fiat currencies for payment.

### Method
GET

### Endpoint
/v2/currency/pairs/buy-crypto

### Parameters

No parameters are required for this endpoint.

### Request Example

No request body is required.

### Response
#### Success Response (200)
- **currencyPairs** (array) - An array of objects, where each object contains:
  - **from_currency_code** (string) - The ISO alpha-3 code of the fiat currency.
  - **to_currency_code** (string) - The crypto asset code (e.g., USDT-TRC20).

#### Response Example
```json
{
  "currencyPairs": [
    {
      "from_currency_code": "USD",
      "to_currency_code": "USDT-TRC20-SHASTA"
    },
    {
      "from_currency_code": "EUR",
      "to_currency_code": "USDC-ERC20"
    }
  ]
}
```
```

--------------------------------

### Widget Initialization Options

Source: https://docs.payb.is/docs/web-javascript-sdk

Methods for opening the PartnerExchangeWidget in different display modes.

```APIDOC
## Widget Initialization Options

### `open(requestId, oneTimeToken)`

**Description:** Opens the widget UI in an iFrame full-screen overlay (default behavior).

**Method:** N/A (This is a function call within the SDK)

**Endpoint:** N/A

**Parameters:**

#### Arguments
- **requestId** (*string*) - Required - Unique identifier for the request.
- **oneTimeToken** (*string*) - Required - A one-time token for authentication.

### `openInIframe(requestId, oneTimeToken)`

**Description:** Opens the widget UI in an iFrame full-screen overlay.

**Method:** N/A (This is a function call within the SDK)

**Endpoint:** N/A

**Parameters:**

#### Arguments
- **requestId** (*string*) - Required - Unique identifier for the request.
- **oneTimeToken** (*string*) - Required - A one-time token for authentication.

### `openInEmbed(requestId, oneTimeToken, element)`

**Description:** Opens the widget UI in embedded mode inside a specified HTML element.

**Method:** N/A (This is a function call within the SDK)

**Endpoint:** N/A

**Parameters:**

#### Arguments
- **requestId** (*string*) - Required - Unique identifier for the request.
- **oneTimeToken** (*string*) - Required - A one-time token for authentication.
- **element** (*HTMLElement*) - Required - The HTML element to embed the widget into.

### `detectAndOpen(requestId, oneTimeToken)`

**Description:** Opens the widget UI using the most appropriate method based on the user's browser (e.g., new tab, iFrame, or redirect).

**Method:** N/A (This is a function call within the SDK)

**Endpoint:** N/A

**Parameters:**

#### Arguments
- **requestId** (*string*) - Required - Unique identifier for the request.
- **oneTimeToken** (*string*) - Required - A one-time token for authentication.

### `openInNewTab(requestId, oneTimeToken)`

**Description:** Opens the widget UI in a new browser tab. Ensure no asynchronous actions occur between the user's click and the widget opening to avoid cancellation due to browser security restrictions.

**Method:** N/A (This is a function call within the SDK)

**Endpoint:** N/A

**Parameters:**

#### Arguments
- **requestId** (*string*) - Required - Unique identifier for the request.
- **oneTimeToken** (*string*) - Required - A one-time token for authentication.

### `openRedirect(requestId, oneTimeToken)`

**Description:** Opens the widget UI by redirecting the user from the partner's website to the widget URL in the same browser tab.

**Method:** N/A (This is a function call within the SDK)

**Endpoint:** N/A

**Parameters:**

#### Arguments
- **requestId** (*string*) - Required - Unique identifier for the request.
- **oneTimeToken** (*string*) - Required - A one-time token for authentication.

```

--------------------------------

### Open Paybis Widget with Basic Parameters

Source: https://docs.payb.is/docs/standalone-widget-integration-via-web-sdk

Opens the Paybis widget using the `window.PartnerExchangeWidget.open` method with essential partner ID and signature. Ensure the SDK script is loaded first.

```html
<!-- Ensure the PartnerExchangeWidget script is loaded before this script block. -->
<script>
  window.PartnerExchangeWidget.open({
    partnerId: '<your partner UUID>',
    signature: '<generated signature>',
  });
</script>
```

--------------------------------

### Start Paybis Widget with One-Time Token (SSO)

Source: https://docs.payb.is/docs/mobile-android-sdk

To bypass user authentication and enable single sign-on, provide a generated `oneTimeToken` when starting the widget. This token is obtained by creating a `Request` with the `passwordless` parameter set to `true`.

```kotlin
PaybisMobileWidget.startWidget(
    application,
    PaybisEnvironment.SANDBOX,
    "<generated_request_id>",
    "<generated_one_time_token>",
    false
)
```

--------------------------------

### SDK Configuration Parameters

Source: https://docs.payb.is/docs/web-javascript-sdk

Configuration parameters and utility methods for the PartnerExchangeWidget SDK.

```APIDOC
## SDK Configuration Parameters

### `close()`

**Description:** Closes the widget manually. Works only if the widget was opened via `open`, `openInEmbed`, or `openInIframe`.

**Method:** N/A (This is a function call within the SDK)

**Endpoint:** N/A

### `state`

**Description:** Returns the current state of the widget (e.g., `initialized`, `loading`, `loaded`).

**Method:** N/A (This is a property access)

**Endpoint:** N/A

**Parameters:**

#### Return Value
- **state** (*enum*) - The current state of the widget.

### `isLoaded`

**Description:** Indicates whether the SDK has finished loading.

**Method:** N/A (This is a property access)

**Endpoint:** N/A

**Parameters:**

#### Return Value
- **isLoaded** (*boolean*) - `true` if the SDK is loaded, `false` otherwise.

### `events`

**Description:** Contains all available SDK event listeners (e.g., `onclosed`, `onloaded`).

**Method:** N/A (This is a property access)

**Endpoint:** N/A

**Parameters:**

#### Return Value
- **events** (*object*) - An object containing event listener properties.

### `isSafari()`

**Description:** Utility method that returns `true` if the current browser is Safari.

**Method:** N/A (This is a function call within the SDK)

**Endpoint:** N/A

**Parameters:**

#### Return Value
- **isSafari** (*function*) - Returns `true` if the browser is Safari, `false` otherwise.

```

--------------------------------

### Inject Paybis SDK Script (Production)

Source: https://docs.payb.is/docs/pnp-web-sdk-integration

This code snippet injects the Paybis SDK script for the production environment. Similar to the sandbox version, it initializes the SDK or provides an open method. Use this in your live integration after thorough testing.

```javascript
!function(){if(window.PartnerWalletsSDK=window.PartnerWalletsSDK||{open(e){window.partnerWalletsSettings={immediateOpen:e}}},"PartnerWalletsSDK"!==window.PartnerWalletsSDK.constructor.name){(()=>{const e=document.createElement("script");e.type="text/javascript",e.defer=!0,e.src="https://wallets.paybis.com/sdk/partner-wallets.js";const t=document.getElementsByTagName("script")[0];t.parentNode.insertBefore(e,t)})()}}();
```

--------------------------------

### Configure iFrame with Sandbox and Permissions for Paybis Widget

Source: https://docs.payb.is/docs/helpful-tips

This example shows how to configure an iframe with the 'sandbox' and 'allow' attributes to ensure the Paybis widget functions correctly. It includes essential permissions like 'allow-scripts', 'allow-same-origin', and specific allowances for payment, camera, and microphone access.

```html
<iframe
  src="[enter-your-url]"
  sandbox="allow-scripts allow-same-origin allow-presentation allow-popups allow-popups-to-escape-sandbox"
  allow="clipboard-read; clipboard-write *; payment *; camera; microphone;"
></iframe>
```

--------------------------------

### Check Paybis SDK Loaded and Open Application

Source: https://docs.payb.is/docs/pnp-web-sdk-integration

This Javascript code demonstrates how to check if the Paybis SDK has been fully loaded by verifying the existence of `window.PartnerWalletsSDK` and its `state` property. It then shows how to call the `open` method with `sessionId` and `partnerProductId` to launch the application.

```javascript
if (window.PartnerWalletsSDK && window.PartnerWalletsSDK.state) {
  // SDK is loaded and can be used safely
}
window.PartnerWalletsSDK.open({
  sessionId: '<generated unique sessionId>', 
  partnerProductId: '<product id>',
});
```

--------------------------------

### Close Paybis Widget (Swift)

Source: https://docs.payb.is/docs/mobile-ios-sdk

This snippet shows the simple method call to close the Paybis widget UI programmatically.

```swift
PaybisMobileWidget.closeWidget()
```

--------------------------------

### Widget Initialization and Usage

Source: https://docs.payb.is/docs/crypto-acquiring-integration-guide

The Paybis widget requires a unique `requestID` for initialization, which is crucial for tracking and managing transactions. Payment link generation is handled on the partner's side.

```APIDOC
## Widget Initialization

### Description

The Paybis widget requires a unique `requestID` for initialization. This ID is mandatory for tracking and managing each transaction. Refer to the [Paybis SDK Documentation](https://docs.payb.is/docs/web-javascript-sdk) for detailed implementation.

### Note

Payment link generation happens exclusively on the partner's side. The partner must:

- Create a request with all required parameters.
- Implement their own business logic to open the widget using the generated request.
- The widget does not handle the payment link creation internally.
```

--------------------------------

### Set Widget Theme

Source: https://docs.payb.is/docs/mobile-android-sdk

Customize the appearance of the Paybis widget by setting its theme. You can choose from `SYSTEM`, `DARK`, or `LIGHT` using the `PaybisThemes` enum when starting the widget.

```kotlin
PaybisMobileWidget.startWidget(
theme = PaybisThemes.SYSTEM
)
```

--------------------------------

### Initialize Paybis Widget with JavaScript SDK

Source: https://context7.com/context7/payb_is/llms.txt

Launches the Paybis widget programmatically on a webpage. Supports popup and embedded display modes. Requires the Paybis SDK script to be included. Outputs transaction status via callbacks.

```html
<!DOCTYPE html>
<html>
<head>
  <script src="https://widget.paybis.com/sdk.js"></script>
</head>
<body>
  <button id="buyButton">Buy Crypto</button>

  <script>
    // Initialize SDK
    const paybisSDK = new PaybisSDK({
      environment: 'production', // or 'sandbox'
    });

    // Open widget in popup
    document.getElementById('buyButton').addEventListener('click', () => {
      paybisSDK.open({
        requestId: 'a122b998-15a4-4442-8b9e-2add17d59617',
        successReturnURL: 'https://yoursite.com/success',
        failureReturnURL: 'https://yoursite.com/failure',
        onClose: () => {
          console.log('Widget closed');
        },
        onSuccess: (data) => {
          console.log('Transaction successful:', data);
        },
        onError: (error) => {
          console.error('Transaction error:', error);
        }
      });
    });

    // Alternative: Embed widget into page element
    paybisSDK.openInEmbed({
      requestId: 'a122b998-15a4-4442-8b9e-2add17d59617',
      containerId: 'paybis-container',
      layout: 'embed'
    });
  </script>

  <div id="paybis-container" style="width: 100%; height: 600px;"></div>
</body>
</html>
```

--------------------------------

### Handle Widget Errors in Swift

Source: https://docs.payb.is/docs/mobile-ios-sdk

This snippet demonstrates how to set up an error handler for the Paybis Mobile Widget using Swift. It captures and prints any errors that occur within the widget. This is crucial for debugging and providing user feedback.

```swift
PaybisMobileWidget.instance.onError = { [weak self] error in
	print(error)
}
```

--------------------------------

### Widget Initialization

Source: https://docs.payb.is/docs/web-direct-url-api-integration

Describes how to initialize the Paybis widget, either through a direct URL or using the Web SDK, using the `requestId` obtained from a previous request.

```APIDOC
## Widget Initialization

### Description
Initializes the Paybis widget using the `requestId`. This can be done via a direct URL or the Web SDK.

### Method
N/A (Client-side action)

### Endpoint
N/A

### Parameters
#### Direct URL Parameters
- **requestId** (string) - Required - The unique identifier for the transaction request.
- **successReturnURL** (string) - Optional - URL-encoded URL to redirect on success.
- **failureReturnURL** (string) - Optional - URL-encoded URL to redirect on failure.

#### Web SDK
Use the provided Paybis Web SDK methods (e.g., `open()`, `openInEmbed()`) to programmatically open the widget within your application.

### Widget URL Format
`https://{domain}/?requestId={requestId}&successReturnURL={urlencodedUrl}&failureReturnURL={urlencodedUrl}`

- **domain**: `widget.sandbox.paybis.com` (Sandbox) or `widget.paybis.com` (Production).

### Request Example (URL)
`https://widget.sandbox.paybis.com/?requestId=a122b998-15a4-4442-8b9e-2add17d59617&successReturnURL=https%3A%2F%2Fyour-site.com%2Fsuccess`

### Response
(Widget opens in the browser or application)
```

--------------------------------

### Open Paybis Widget with Extended Parameters

Source: https://docs.payb.is/docs/standalone-widget-integration-via-web-sdk

Opens the Paybis widget with additional parameters for specifying crypto address, currency codes, and amount. Ensure the SDK script is loaded first.

```html
<!-- Ensure the PartnerExchangeWidget script is loaded before this script block. -->
<script>
  window.PartnerExchangeWidget.open({
    partnerId: '<your partner UUID>',
    signature: '<generated signature>',
    cryptoAddress: '<crypto wallet address>',
    currencyCodeFrom: 'USD',
    currencyCodeTo: 'BTC',
    amountFrom: '10',
  });
</script>
```

--------------------------------

### API Integrations - Get a Quote

Source: https://docs.payb.is/docs/control-transaction-fiat-crypto-and-amount

This endpoint allows you to get a quote from Paybis for a transaction. It's the first step in controlling transaction amounts and currencies via the widget.

```APIDOC
## POST /quote

### Description
Retrieves a quote for a transaction, specifying the amount and currencies. This is used to pre-fill transaction details in the widget.

### Method
POST

### Endpoint
https://docs.payb.is/reference/createquotev2

### Parameters
#### Query Parameters
* **`amount`** (number) - Required - The amount of the transaction.
* **`currency_from`** (string) - Required - The currency to pay with (e.g., 'USD', 'BTC').
* **`currency_to`** (string) - Required - The currency to receive (e.g., 'EUR', 'ETH').

### Request Example
```json
{
  "amount": 100,
  "currency_from": "USD",
  "currency_to": "BTC"
}
```

### Response
#### Success Response (200)
- **`quoteId`** (string) - The unique identifier for the quote.
- **`estimated_amount`** (number) - The estimated amount to be received.
- **`fee`** (number) - The transaction fee.

#### Response Example
```json
{
  "quoteId": "q_a1b2c3d4e5f6",
  "estimated_amount": 0.0015,
  "fee": 2.5
}
```
```

--------------------------------

### Add Additional Repositories for SumSub and Risk.js

Source: https://docs.payb.is/docs/mobile-android-sdk

This snippet adds necessary Maven repositories for integrating third-party libraries like SumSub for KYC and `risk.js` for fraud detection. It includes the Jitpack, SumSub, and `fpregistry.io` repositories.

```gradle
repositories {
    ... other repositories above ...
    maven { url 'https://jitpack.io' }
    maven { url "https://maven.sumsub.com/repository/maven-public/" }
    // for mobsdk versions 2.2.8+
    maven { url = uri("https://maven.fpregistry.io/releases") }
}
```
Tokens:
Raw