/v2/quote

post https://widget-api.sandbox.paybis.com/v2/quote

Payment quote creation method

Quote method

This method allows for the request of a quote that locks in the exchange rate for a provided Fiat-to-Crypto, Crypto-to-Fiat, and Crypto-to-Crypto pairs. The resulting quote is valid for a specified period, enabling the transaction to be executed at the locked-in exchange rate.

❗️
To ensure the security of your integration, signature verification is required for all Public and Private API requests.
More details on how to generate the signature.

Regular Widget Transactions

The quote is calculated for each payment method supported for the given currency pair. Supported currency pairs can be retrieved using the GET Currency Pairs Buy Crypto or GET Currency Pairs Sell Crypto endpoint depending on the transaction flow.

Crypto Acquiring Transactions

The quote is calculated for each supported currency pair. Supported currency pairs can be retrieved using the GET Currency Pairs Swap Crypto endpoint.

Fiat-to-Crypto: For transactions where the amount is denominated in fiat currency, the quote is calculated based on the requested_currency and amount fields. These fields represent the fiat amount and currency that should be passed as an equivalent in fiat currency. Paybis handles the conversion between the two cryptocurrencies based on the equivalent of fiat currency.
Crypto-to-Crypto: For transactions where both the user's payment and the merchant's payout are denominated in cryptocurrencies, the quote is calculated based on the currencyCodeFrom, currencyCodeTo, and amount fields. These fields represent the user's payment cryptocurrency, the merchant's payout cryptocurrency, and the amount of the user's cryptocurrency being exchanged. Paybis handles the conversion between the two cryptocurrencies.

🚧
Making Requests
This endpoint must be called from your application's backend.

Request examples

{
  // Specifies the fiat currency the user will be paying with.
  "currencyCodeFrom": "USD", 

  // Specifies the cryptocurrency the user wants to buy.
  "currencyCodeTo": "BTC-TESTNET", 

  // The amount the user wants to spend
  //(in USD, since directionChange is 'from').
  "amount": "10.00", 

  // Indicates that the 'amount' is in the 'currencyCodeFrom'.
  "directionChange": "from", 

  // Indicates the user wants to know the total cost including fees.
  "isReceivedAmount": false 
 
  // (Optional) ID of the specific payment method to be used for this purchase.
  "paymentMethod": "credit_card"
}

{
  // Specifies the cryptocurrency the user wants to sell.
  "currencyCodeFrom": "ETH-SEPOLIA", 

  // Specifies the fiat currency the user wants to receive.
  "currencyCodeTo": "EUR", 

  // The amount of cryptocurrency the user wants to sell.
  "amount": "0.005", 

  // Indicates that the 'amount' is in the 'currencyCodeFrom' (ETH-SEPOLIA).
  "directionChange": "from", 

  // Indicates the user wants to know the total amount of EUR 
  //they'll receive after fees.
  "isReceivedAmount": false 
  
  // (Optional) ID of the specific payout method the user wants to use to receive the fiat currency.
  "payoutMethod": "partnername_bridgerpay_sell_netellerr" //Please replace with your payout ID
}

{
  // Specifies the fiat currency the user will be paying with.
  "currencyCodeFrom": "USD", 

  // Specifies the cryptocurrency the user wants to buy.
  "currencyCodeTo": "LTC-TESTNET", 

  // The amount the user wants to spend 
  //(in USD, since directionChange is 'from').
  "amount": "10.00", 

  // Indicates that the 'amount' is in the 'currencyCodeFrom' (USD).
  "directionChange": "from", 

  // Indicates the user wants to know the total cost including fees.
  "isReceivedAmount": false,

  // The promo code the user wants to apply to their purchase.
  "promoCode": "SALE50" // Replace with the actual promo code
}

{  
  // The fiat amount that the merchant wants to receive
  "amount": "100", 
  
  // The fiat currency that the merchant wants to receive
  "requestedCurrency": "USD",
  
  // The cryptocurrency that the customer will pay with
  "currencyCodeFrom": "ETH-SEPOLIA",
  
  // The cryptocurrency that the merchant will receive
  "currencyCodeTo": "USDT-TRC20-SHASTA",
  
  "isReceivedAmount": false,    
  "payoutMethod": "ca-test-sell-ethereum-widget"
}

Body Params

currencyCodeFrom

string

Fiat currency code in ISO alpha-3 format or crypto asset (i.e. BTC)

currencyCodeTo

string

Fiat currency code in ISO alpha-3 format or crypto asset (i.e. BTC)

amount

string

The amount in the currency specified by either the directionChange or requestedCurrency parameters
represented the payment amount with precision: 2 decimal places for fiat currencies (e.g., 100.12);
and 8 decimal places for cryptocurrencies (e.g., 0.12345678).

directionChange

string

This field determines the currency in which amount is specified.

A value of from indicates that amount is in the currencyCodeFrom currency. A value of to
indicates that amount is in the currencyCodeTo currency.

This parameter is required if requestedCurrency is not provided. It is mutually exclusive
with requestedCurrency.

requestedCurrency

string

This field is used in swap-crypto exchanges and crypto-acquiring transactions where the transaction
occurs in a fiat equivalent. This parameter is optional. It specifies the fiat currency in which
amount is denominated.

isReceivedAmount

boolean

Specifies how to process the value in the amount field: with or without fees. False, to set the total
amount that the user will spend. True, to set the net amount of money (excluding fees) for which
the user will get crypto.

paymentMethod

string | null

ID of the payment method for which the quote is generated (optional)

payoutMethod

string | null

ID of the payout method for which the quote is generated (optional)

promoCode

string | null

Promo code to be used with transaction

Headers

X-Request-Signature

string

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

X-User-IP

string

User IP detected by a public endpoint that uses the current one

Responses

Response body

object

uuid

Quote ID required for Create request method

currencyCodeFrom

string

Fiat currency code in ISO alpha-3 format or crypto asset (i.e. BTC)

currencyCodeTo

string

Fiat currency code in ISO alpha-3 format or crypto asset (i.e. BTC)

exchangeRate

object

Exchange rate info

from

string

Fiat currency code in ISO alpha-3 format or cryptocurrency code

string

Fiat currency code in ISO alpha-3 format or cryptocurrency code

rate

string

Conversion rate (how much TO per single FROM)

exchangeRateCryptoToFiat

object | null

Exchange rate info

from

string

Fiat currency code in ISO alpha-3 format or cryptocurrency code

string

Fiat currency code in ISO alpha-3 format or cryptocurrency code

rate

string

Conversion rate (how much TO per single FROM)

requestedAmount

object

Amount and currency for which the quote is generated

amount

string

Payment amount with precision 2 for fiat and 8 for crypto. If directionChange is "from", then amount value is in fiat currency, e.g. 100.12. If directionChange is "to", then amount value is in cryptocurrency, e.g. 0.12345678

currencyCode

string

Fiat or crypto currency code depending on the transaction direction

requestedAmountType

string

Type of the transaction direction. "from" value determines the quote amount based on fiat currency code, e.g. customer wants to purchase crypto for XX fiat. "to" determines the quote amount based on crypto currency code, e.g. customer wants to purchase XX crypto.

from to

paymentMethods

array of objects | null

Array of quotes calculated for each available payment method.

paymentMethods

object

paymentMethodErrors

array of objects | null

List of validation errors returned if quote cannot be calculated for a certain payment method

paymentMethodErrors

object

payoutMethods

array of objects | null

Array of quotes calculated for each available payout method.

payoutMethods

object

payoutMethodErrors

array of objects | null

List of validation errors returned if quote cannot be calculated for a certain payout method

payoutMethodErrors

object

promoCodeError

object | null

Error for promo code. Possible values:

Invalid promo code (code 55c50cc4-51d9-4ed1-ab9b-9b76116c1602)
Expired promo code (code 55fc761d-fd63-473f-9136-2c022eaa9862)
Used up promo code (code 7ebb5ee9-f7f3-4746-854b-4589880ca753)

code

uuid

Error code for promo code

55c50cc4-51d9-4ed1-ab9b-9b76116c1602 55fc761d-fd63-473f-9136-2c022eaa9862 7ebb5ee9-f7f3-4746-854b-4589880ca753

message

string

Error message for promo code

401

API key is missing

403

Invalid API key or access disabled

404

Payment method for quote not found

Quote method

❗️

Regular Widget Transactions

Crypto Acquiring Transactions

🚧Making Requests

Request examples

200A Quote successfully created.

422Validation error

503Maintenance status

🚧
Making Requests