API Reference

/api/v1/quote

post
https://openapitest.osl-pay.com/api/v1/quote

This API retrieves a quote for buying cryptocurrency with fiat or converting cryptocurrency to fiat.
The returned price may differ slightly from the final executed price.
You can request either a real-time quote or a cached quote. Real-time quotes are valid for 1 minute.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int64

OSL Pay user ID At least one of userId or merchantUserId must be provided when type = 1

string

Merchant-side user ID At least one of userId or merchantUserId must be provided

string

IP address. Must comply with IPv4 or IPv6 standards.(If you want to inquire about the KYC-free credit limit, this field is required).

string
required

Fiat currency

string
required

Cryptocurrency

string

Amount in fiat currency

string

Amount in cryptocurrency

string
enum
required

Trade direction

Allowed:
string

Blockchain network of the cryptocurrency. Required if the transaction involves on-chain withdrawal

string
enum
required

Quote type: 0 – Cached quote, for display purposes (default) 1 – Real-time quote, used before placing an order; valid for 1 minute

Allowed:
string
enum

Payment method for the transaction(If not specified, the best quote will be returned)
tradeDir=BUY， payWayCode=VIETQR、PIX、SEPA、IBAN
tradeDir=SELL，payWayCode=BANKACCOUNT、ATMCARD、PIX、SEPA、IBAN

Allowed:
string
enum

Quote direction FORWARD: Forward quote REVERSE: Reverse quote.(Currently, reverse quotes are only supported in cached quotes when buying crypto)

Allowed:
boolean
Defaults to false

ndicates whether to return quote information for all payment methods
Default: false

string

The unique fingerprint of the device is generated by the merchant itself.

Responses

400

Bad request

401

Unauthorized

500

Internal server error

Updated 2 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago

Did this page help you?