virtual accounts

Retrieve the receiving conversion rate

Return the current conversion rate and fixed fee for this receiving payment method. The result is indicative until an incoming transfer is created.

get/banks/{product}/rate

Request

The document declares no server URL.
Auth
HTTP bearer
TypeScript
https://skmtc.dev/hevn-inc/apis/hevn-api/docs/banks/:product/rate/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

product'us' | 'swift' | 'eu' | 'uae' | 'uk' | 'br' | 'mx' | 'co' | 'ar' | 'au' | 'ng' | 'ca' | 'dk' | 'no' | 'pl' | 'tr' | 'il' | 'sa' | 'bo' | 'cl' | 'cr' | 'do' | 'gt' | 'hn' | 'jm' | 'eg' | 'sl' | 'tz' | 'ug' | 'waemu' | 'zm' | 'bd' | 'cn' | 'hk' | 'in' | 'id' | 'jp' | 'my' | 'pk' | 'ph' | 'kr' | 'th' | 'vn' | 'card' required

Region product, for example eu or us

Headers

X-Hevn-Accountstring nullable

The client account to act for, as a cl_… id. Omit it to act as yourself.

Example:cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41

Response

Successful Response

currencystring required

ISO 4217 fiat currency code for this conversion.

ratestring nullable

Conversion rate net of markup, when currently available.

fixedFeestring nullable

Fixed fee component, when charged.

fixedFeeCurrencystring nullable

Currency in which the fixed fee is charged.

Example response

{
  "rate": "500.00",
  "fixedFee": "500.00"
}

Changes

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