Skip to navigation

Get account transfer conversion estimate

View as Markdown

Returns an indicative conversion estimate before creating an account transfer between treasury accounts in different currencies.

Query parameters

FieldTypeRequiredDescription
from_account_idUUIDYesSource treasury main account
to_account_idUUIDYesDestination treasury main account
amount_in_minor_unitsIntegerYesSource (debit) amount in the source account’s minor units

The source currency is derived from from_account_id; it is not passed separately.

Response fields

FieldDescription
source_currency_codeDebit currency
source_amount_in_minor_unitsEcho of request amount
destination_currency_codeCredit currency (from destination account)
destination_amount_in_minor_unitsEstimated credit amount (may differ at settlement)
indicative_fx_rateEffective major-unit rate as a decimal string

This is an estimate, not a quote. The credit amount applied at settlement may differ. After settlement, use bank-reported transactions on each account for actual debit and credit amounts.

Error responses

StatusDescription
400Invalid account pair or request
404Entity or account not found

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

Query parameters

from_account_idstringRequiredformat: "uuid"
Source main account ID.
to_account_idstringRequiredformat: "uuid"
Destination main account ID.
amount_in_minor_unitsintegerRequired

Source amount in minor units (source account currency).

Response

Indicative conversion estimate for the account transfer.
dataobject
Indicative FX preview for an account transfer conversion estimate.
warningstring or nullOptional