Convert currency using dynamic rates

Convert currency using the rates Remote applies during employment creation and invoicing.

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.
Client token (ClientToken) — a partner client_token, accepted only on marketing endpoints. See Authentication for partners.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage company resources (company_admin)	Convert currencies (convert_currency:read)	-

post/v1/currency-converter/effective

Request

Base URL: https://gateway.remote.com
URL: https://gateway.remote.com/v1/currency-converter/effective
Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, convert_currency:read, company_admin, all:write, all:read) and OAuth 2 (client credentials, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, convert_currency:read, company_admin, all:write, all:read)

Request body

amountinteger required

The amount to convert in cents

source_currencystring required

The currency code to convert from

target_currencystring required

The currency code to convert to

Example request

{
  "amount": 1000,
  "source_currency": "USD",
  "target_currency": "EUR"
}

Response

Success

Example response

{
  "data": {
    "conversion_data": {
      "exchange_rate": 0.85,
      "source_amount": 1000,
      "source_currency": {
        "code": "CZK",
        "name": "Czech Koruna",
        "symbol": "Kč"
      },
      "target_amount": 850,
      "target_currency": {
        "code": "CZK",
        "name": "Czech Koruna",
        "symbol": "Kč"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 65 revisions of this API.