/v2/quote

post

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

Payment quote creation method

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

enum

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.

Allowed:

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-ID

string

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

X-User-IP

string

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

X-User-Locale

string

enum

X-Referer

string

Responses

401

API key is missing

403

Invalid API key or access disabled

404

Payment method for quote not found

200A Quote successfully created.

422Validation error

503Maintenance status