FaTPay Docs
🇺🇸 English
🇺🇸 English
  • Overview
  • Get Started
    • Onboarding
    • Quickstarts
  • Best Practices
    • Exchanges
    • Crypto Projects
    • Wallets
    • Affiliate Partners
    • NFT
  • Reference
    • Integration Tutorial
      • On-ramp Widget Customization
      • NFT Checkout Widget Customization
      • Interface Customization
      • Widget Themes Gallery
      • Widget Signature
    • API Reference
      • APIs
        • List all cryptocurrencies
        • List all fiat currencies and payment methods
        • Retrieve quoted price
        • List all orders
      • Webhooks
        • Webhook for order events
      • API Signature & Webhook Validation
  • Appendix
    • Demo
      • Widget Signature Demo
      • API Signature Demo
      • Webhook Validation Demo
    • Languages
    • Fiat Currencies
    • Cryptocurrencies (on-ramp)
    • Cryptocurrencies (NFT Checkout)
    • Errors
Powered by GitBook
On this page
  • Retrieve quoted price
  • Object definition
  • CryptoCurrencyQuote
  1. Reference
  2. API Reference
  3. APIs

Retrieve quoted price

Query cryptocurrency quotes based on fiat currency amount and present exchange rate

Retrieves cryptocurrency quotes based on fiat currency amount and present exchange rate. And returns a map with a data property that contains a CryptoCurrencyQuote object.

Retrieve quoted price

GET https://api.ramp.fatpay.xyz/open/api/onramp/price

Query cryptocurrency quotes based on fiat currency amount and present exchange rateObject definition

Query Parameters

Name
Type
Description

fiatCurrency*

String

currencyAmount*

Decimal

Fiat currency amount, up to two decimal places e.g 199

cryptoCurrencyCode*

String

payment

String

buyType

String

buyType=nft:nft quoted price

buyType=fiat:on-ramp quoted price

Headers

Name
Type
Description

Content-Type*

String

application/json

X-Fp-Version*

String

FaTPay API version e.g. v1.0

X-Fp-Timestamp*

Integer

Unix timestamp in second e.g. 1661346861

X-Fp-Nonce*

Integer

Random integer e.g. 868964

X-Fp-Partner-Id*

String

Partner ID assigned by FaTPay as Premium Partner e.g. 2yQrS9A0xmM8xpfa

X-Fp-Signature*

String

{
    "code": 10000,
    "msg": "Succeess",
    "data": {
        "fiatCurrency": "USD",
        "currencyAmount": 199,
        "cryptoCurrency": "USDT",
        "network": "ethereum_rinkeby",
        "cryptoCurrencyCode": "USDT_ERC20" 
        "cryptoCurrencyAmount": 182.0,
        "gasFee": 1.32,
        "cryptoCurrencyUnitPrice": 1.03,
        "platformFee": 5.0,
        "totalFee": 6.32,
        "paymentOptions": {
            "name": "CREDIT_DEBIT_CARD",
            "processingTime": "3 - 7Min",
            "icon": "https://fatpay.xyz/img/1.png",
            "maxAmount": 4000,
            "minAmount": 1
        }
    }
}

Object definition

CryptoCurrencyQuote

Key
Format
Required
Description

fiatCurrency

String

Y

ISO code of fiat currency, e.g. USD, THB, etc.

currencyAmount

Decimal

Y

Fiat currency amount, up to two decimal places. e.g. 199

cryptoCurrency

String

Y

Cryptocurrency name, e.g. USDT

network

String

Y

Cryptocurrency blockchain, e.g. ethereum_mainnet

cryptoCurrencyCode

String

Y

Cryptocurrency code, e.g. USDT_ERC20

cryptoCurrencyAmount

Decimal

Y

The amount of cryptocurrency, up to two decimal places. e.g. 182

cryptoCurrencyUnitPrice

Decimal

Y

Unit price of cryptocurrency, up to two decimal places. e.g. 1.03

gasFee

Decimal

Y

Gas fee, up to two decimal places. e.g. 1.32

platformFee

Decimal

Y

Processing fee charged by FaTPay, up to two decimal places. e.g. 11.94

totalFee

Decimal

Y

Total fee = Gas fee + Processing fee, up to two decimal places. e.g. 13.26

paymentOptions

Object

Y

PreviousList all fiat currencies and payment methodsNextList all orders

Last updated 2 years ago

ISO code of fiat currency from [] e.g. USD

Cryptocurrency code from [] e.g. USDT_ERC20

Payment method from [] e.g. BANK_CARD_TRANSFER

generated by APIPrivateKey e.g. zbBQ+1nv/5up9riH1wbTSSMmkb26LQj3g1cNWsutOordOrtpk8agcA5D5bdYaGeVlHK0qZ2MlUV+ZfOK9cXMuficeIm5fnEjMEm7s1IZtSivMt5te7EFqe52dtVFafE4hUgwqH6QBZB0yZ1FSqHs2dOCI0e8RKJQBDitxtHkibStl1Jt5wulzzq96qWbbVnwoBqGDT52OtwwEcDqMI4SIAzUAdBhAuLqUig1U4Ne9ufT8B1aAohEk5fvn/Sbom21bEjLdgbt5PwH2wmmuBx4tq31IgcP4V+qEBILY2eMAFzkvxNXaX3PsLbj9NpgyIc3HQl0FtRq3gdN7FsSvyvcWA==

Array of

Fiat Currencies
Cryptocurrencies (on-ramp)
paymentOption
PaymentOption
Signature