Fetch rate

Retrieve the conversion rate that will be charged for the disbursement entry. This rate only differs from one (1) if the source currency specified is not the same as the destination currency.

The conversion rate and disbursement fees are separate. After conversion, the disbursement fee will still be applied for the service.

Retrieve the active conversion rate for a transfer of an amount for the specified currency

get

Authorizations

Bearer

AuthorizationstringRequired

API Key as Bearer Token

Query parameters

amountnumber · doubleOptional

source_currencystringOptional

destination_currencystringOptional

Responses

200

Success

application/json

statusstring · enumOptionalPossible values:

messagestring · nullableOptional

metaobjectOptional

is_errorbooleanRead-onlyOptional

get

/v1/transfers/rate

HTTPcURLJavaScriptPython

GET /v1/transfers/rate HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

Success

{
  "status": "success",
  "message": "text",
  "data": {
    "rate": 1,
    "source": {
      "amount": 1,
      "currency": "text"
    },
    "destination": {
      "amount": 1,
      "currency": "text"
    }
  },
  "meta": {},
  "errors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "is_error": true
}