Data Conventions

This section describes the data structures used within the Exchange scope. It is highly recommended that users also refer to the platform's Data Conversion section for additional context.

Currency Pair

Represents the currencies involved in a foreign exchange operation.

V1 – Enum-based format

In the first version of the API, currency pairs were defined using an enumerated string format: {CURRENCY_CODE}_{CURRENCY_CODE}. The first code represents the payment currency, and the second the settlement (receiving) currency.

Examples:

• Buying USD with BRL → BRL_USD
• Buying BRL with USD → USD_BRL

V2 – Object-based format

In the second version of the API, currency pairs are represented as an object with source and target properties, where source is the currency being converted and target is the destination currency.

Examples:

• Buying USD with BRL → { "source": "BRL", "target": "USD" }
• Buying BRL with USD → { "source": "USD", "target": "BRL" }