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** | Field | Type | Required | Description | |-------|------|----------|-------------| | `from_account_id` | UUID | Yes | Source treasury main account | | `to_account_id` | UUID | Yes | Destination treasury main account | | `amount_in_minor_units` | Integer | Yes | Source (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** | Field | Description | |-------|-------------| | `source_currency_code` | Debit currency | | `source_amount_in_minor_units` | Echo of request amount | | `destination_currency_code` | Credit currency (from destination account) | | `destination_amount_in_minor_units` | **Estimated** credit amount (may differ at settlement) | | `indicative_fx_rate` | Effective 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** | Status | Description | |--------|-------------| | 400 | Invalid account pair or request | | 404 | Entity 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 null