/v3/request

post

https://widget-api.sandbox.paybis.com/v3/request

Create request with userIp required

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

partnerUserId

string

The customers unique ID in your system in order to link the request to the existing user’s account or to create a new one in Paybis system. Use the same ID for each request from the same customer to avoid duplicates.

partnerTransactionId

string | null

The transaction ID in your system to associate the request with.

quoteId

string | null

The quote ID. If provided Widget will start with predefined amount and crypto. Otherwise user will be able to specify amount in Widget and choose desired cryptocurrency for purchase.

cryptoWalletAddress

object | null

Payout wallet details. Optional for buy crypto flow and required for swap crypto flow

cryptoWalletAddressForRefund

object | null

Refund wallet details. Optional for all flows

string | null

The customers email address. If specified, user will not be asked to enter his email during the Widget journey. Pay attention email must be matched with partnerUserId for all upcoming requests, unique user on Paybis side is identified by a combination of partnerUserId + email.

applicantSumsubToken

string | null

The shared KYC token from Sumsub. If specified, user will not be required to go through the KYC process during the Widget journey.

locale

string

enum

The customer’s preferred locale in ISO alpha-2 format. It defines the language of Widget UI. User will be able to change in Widget Menu.

passwordless

boolean

Set passwordless authentication for the customer.

trustedKyc

boolean

Set trusted KYC flow for the customer.

trustedKycInfo

object | null

Optional. This optional data is utilized as Know Your Customer (KYC) information to streamline the payment process. It aims to avoid redundant requests for personal details during payment, if required by the selected payment method.

paymentMethod

string | null

Set payment method.

payoutMethod

string | null

Set payout method.

flow

string | null

enum

Set transaction flow.

Allowed:

cryptoPaymentMethod

string

enum

Defines how the payment process is handled within the sellCrypto flow. Possible values:

manual: The user is required to manually transfer funds from any wallet app to the destination wallet shown on widget UI.
partner_controlled_with_sdk_event: The user confirms transaction details in the widget, and the partner receives a corresponding SDK event. The partner then obtains the payment details from Paybis and arranges the payment within their own app.
partner_controlled_with_redirect: The user confirms the transaction in the widget and is redirected to the partner's app to complete the payment. The partner obtains the payment details from Paybis. It is required to pass depositCallbackUrl for this option.

If this property is not set for sellCrypto flow, it is assumed to be "manual".

Allowed:

depositCallbackUrl

uri

Used to redirect the user to the deposit page on the partner's site if the cryptoPaymentMethod is set to "partner_controlled_with_redirect".

If this property is set, but the cryptoPaymentMethod is either set to "manual" or not set at all, a validation error will be returned.

salesItemDescription

string | null

Textual description of the item being sold.

merchantCompanyName

string | null

Name of the merchant as it will appear on the payment details screen.

userIp

string

user IP address (ipv4 or ipv6), private IPs are not allowed

Headers

X-Request-Signature

string

Signature to sign the request. For more information see https://docs.payb.is/reference/signing-requests

Responses

401

API key is missing

403

Invalid API key or access disabled

404

Quote for request not found

201A request item successfully created.

422Validation error

503Maintenance status