The getTransferQuote mutation locks in a rate for a transfer for a limited amount of time.
The mutation will also return the fee required for the payment.
If you need to update the transfer amount, you may send an updated source_amount or destination_amount. However, you cannot send both amounts simultaneously. Upon executing the mutation, it will return the other amount based on the exchange rate and the fee, which will always be in the source_currency of the transfer.
An exchange rate represents the value relationship between two currencies. For example, if 1 USD equals 0.83 EUR, it means 1 USD has the equivalent value of 0.83 EUR in the market.
rate vs inverse rate
The rate, i.e. the 'forward' rate and the inverted_rate, i.e. the 'inverse' rate, describe the currency direction of the rate. In the paragraph above we stated that 1 USD is equivalent to 0.83 EUR.
This means if you were paying a beneficiary in EUR and funding the payment with USD the forward rate would be 0.83 whereas the inverse rate would be 1.2048192.
The forward rate is always the value of the destination currency relative to 1 unit of the source currency.
The inverse rate is the value of the source currency relative to 1 unit of the destination currency.
Parameters
| Parameter | Type | Required |
|---|---|---|
| transfer_id | UUID | true |
| source_amount | String | false |
| destination_amount | String | false |