WIwirexapp
Cards/Topup

Create topup estimation

Creates a new card topup estimation

post/api/v1/cards/topup/estimate

Request

  • Base URL
    https://api-baas.wirexapp.com
  • URL
    https://api-baas.wirexapp.com/api/v1/cards/topup/estimate
  • Auth
    • API key in header Authorization
    • or API key in header X-Chain-Id and API key in header X-User-Wallet and API key in header Authorization

Request body

destination_amountstring required

DestinationAmount is the raw on-chain token amount the user wants to receive, expressed as an integer string already scaled by the token's decimals (e.g. "100000000" for 100 USDC). Sent as a string to avoid the precision loss a float64 introduces for large or high-decimal amounts.

destination_token_addressstring required

DestinationTokenAddress is the token address the user wants to receive on chain

external_card_idstring required

ExternalCardId is the unique identifier for the external card to debit

Example request

{
  "destination_amount": "100000000",
  "destination_token_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
  "external_card_id": "00000000-0000-0000-0000-000000000001"
}

Response

OK

destination_amountnumber required

Destination amount the user receives on chain as a float displayed at 6 fractional digits

destination_amount_precisestring required

Destination precise amount as a decimal string in token base units

destination_token_addressstring required

Destination token address

destination_token_symbolstring required

Destination token symbol

estimation_idstring required

Identifier of the created estimation

expires_atinteger required

UTC timestamp when the estimation will expire

fee_amountnumber required

Fee amount denominated in fee_currency as a float displayed at 6 fractional digits

fee_amount_precisestring required

Fee precise amount as a decimal string in base units of the fee currency

fee_currencystring required

Fee currency code

providerstring required

Provider of the underlying topup

ratenumber required

Card → reference currency conversion rate

source_amountnumber required

Source-leg amount the card will be debited for (fiat) as a float displayed at 6 fractional digits

source_amount_precisestring required

Source-leg precise amount as a decimal string in base units of the source currency

source_currencystring required

Source-leg fiat currency code

Example response

{
  "destination_amount": 100,
  "destination_amount_precise": "100000000",
  "destination_token_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
  "destination_token_symbol": "USDC",
  "estimation_id": "00000000-0000-0000-0000-000000000001",
  "expires_at": 1617223200,
  "fee_amount": 0.5,
  "fee_amount_precise": "500000",
  "fee_currency": "EUR",
  "provider": "checkout",
  "rate": 1,
  "source_amount": 100,
  "source_amount_precise": "100000000",
  "source_currency": "EUR"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.