WIwirexapp
Bank

Estimate corridor transfer

Estimates the amounts for a bank transfer via specified corridor

post/api/v3/bank/estimate/{corridor}

Request

  • Base URL
    https://api-baas.wirexapp.com
  • URL
    https://api-baas.wirexapp.com/api/v3/bank/estimate/{corridor}
  • 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

Path parameters

corridorstring required

Corridor name (sepa, ach, faster-payments, pix, spei, fedwire, swift, cips, chats, fps_hk, imps, etc.)

Request body */*

account_idstring

Bank account UUID (required for service-bank corridors: sepa, ach, faster-payments)

corridorstring required

Corridor path parameter

destination_amountnumber required

Amount to receive in destination fiat currency

destination_currencystring

Target fiat currency (defaults to corridor default)

recipient_idstring required

Recipient UUID from service-recipient

recipient_payment_details_idstring required

Recipient Payment Details Identifier

source_tokensstring[]

Source token addresses to include in estimation

Example request

{
  "account_id": "550e8400-e29b-41d4-a716-446655440000",
  "destination_amount": 100,
  "destination_currency": "INR",
  "recipient_id": "550e8400-e29b-41d4-a716-446655440000",
  "recipient_payment_details_id": "550e8400-e29b-41d4-a716-446655440000",
  "source_tokens": [
    "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
  ]
}

Response

OK

amountnumber required

Amount that would be transferred in destination currency

currencystring required

Destination fiat currency

expires_atinteger required

UTC timestamp when the estimation will expire

idstring required

Identifier of the estimation

Example response

{
  "amount": 100,
  "currency": "INR",
  "estimated_amounts": [
    {
      "amount": 109.41123037,
      "fee_amount": 0.5,
      "fee_precise_amount": "500000000000000000",
      "precise_amount": "109411230370000000000",
      "rate": 1.09345623,
      "token_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
      "token_symbol": "USDC"
    }
  ],
  "expires_at": 1617223200,
  "id": "00000000-0000-0000-0000-000000000001"
}

Changes

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