TransferSwift

Request a foreign exchange quote

Request a foreign exchange quote to exchange USD to other currencies for international wire transfers. Quotes are not booked until they are used in transfer requests.

post/transfers/international-wire/fx-rate

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/transfers/international-wire/fx-rate
  • Auth: HTTP basic

Headers

Idempotency-Keystring

Idempotency keys can be up to 255 characters long and are case sensitive. Column reserves the right to expire idempotency keys after 30 days. Only ASCII printable characters (code 32 - 126) are allowed for idempotency keys.

Request body

book_directlyboolean required

If true, the quote will be booked immediately upon creation.

buy_amountinteger required

Amount to buy in the smallest unit of the buy currency.

buy_currency_codestring required

The three-letter ISO 4217 currency code of the currency to buy.

fx_fee_bpsnumber nullable required

Foreign exchange fee in basis points.

rate_datestring date nullable required

The calendar date to use for the exchange rate. Format: YYYY-MM-DD. If not provided, today's rate is used.

Response

Successful response

buy_amountinteger required

Buy amount in smallest unit

buy_currency_codestring required

Buy currency ISO code

created_atstring date-time required

Time the FX quote was created

expired_atstring date-time required

Time the FX quote expires

idstring required

The ID of the FX quote

ratestring required

Effective exchange rate

rate_datestring date required

Calendar date used for the exchange rate

sell_amountinteger required

Sell amount in smallest unit

sell_currency_codestring required

Sell currency ISO code

statusstring required

Current status of the FX quote

updated_atstring date-time required

Time the FX quote was last updated

Changes

No recorded changes to this operation across all 1 revision of this API.