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/{rail}/rate

Retrieve the receiving conversion rate

cURL

curl --request GET \
  --url https://api.example.com/banks/{rail}/rate \
  --header 'Authorization: Bearer <token>'

200

{
  "currency": "<string>",
  "rate": "500.00",
  "fixedFee": "500.00",
  "fixedFeeCurrency": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Hevn-Account · string | null

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

Example:

"cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"

x-api-key · string | null

Path Parameters

rail · string · required

Opaque rail id

Example:

"wire_named"

Response

200

application/json

Successful Response

currency · string · required

ISO 4217 fiat currency code for this conversion.

rate · string | null

Conversion rate net of markup, when currently available.

Example:

"500.00"

fixedFee · string | null

Fixed fee component, when charged.

Example:

"500.00"

fixedFeeCurrency · string | null

Currency in which the fixed fee is charged.