Skip to main content

Get Crossborder Rates

GET 
/v1/crossborder/rates

Get crossborder exchange rates for a currency pair. Returns buy and sell prices, amounts, and currency information.

Request​

Query Parameters

    base_currency stringrequired

    Base currency symbol.

    quote_currency stringrequired

    Quote currency symbol.

    amount_currency stringrequired

    Possible values: [base, quote]

    Amount currency (base or quote).

    amount numberrequired

    Amount in cents.

    side stringrequired

    Possible values: [buy, sell]

    Order side (BUY or SELL).

Header Parameters

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid string

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses​

Rates returned successfully.

Schema
    id stringrequired

    Rate ID.

    price_buy numberrequired

    Price buy in cents.

    price_sell numberrequired

    Price sell in cents.

    side stringrequired

    Possible values: [buy, sell]

    Order side.

    base_amount_buy numberrequired

    Base amount buy in cents.

    base_amount_sell numberrequired

    Base amount sell in cents.

    base_currency_symbol stringrequired

    Base currency symbol.

    base_currency_decimal numberrequired

    Base currency decimal places.

    base_currency_title stringrequired

    Base currency title.

    quote_amount_buy numberrequired

    Quote amount buy in cents.

    quote_amount_sell numberrequired

    Quote amount sell in cents.

    quote_currency_symbol stringrequired

    Quote currency symbol.

    quote_currency_decimal numberrequired

    Quote currency decimal places.

    quote_currency_title stringrequired

    Quote currency title.

    ttl date-timerequired

    Time to live (TTL) date.

Loading...