Skip to main content
GET
Read an autoconversion rule

Authorizations

Authorization
string
header
required

Bearer authentication header on the format Bearer <API_KEY>.

Path Parameters

id
string<uuid>
required

Autoconversion rule's unique identifier.

Response

Resource successfully retrieved.

id
string<uuid>

Autoconversion rule's unique identifier.

Example:

"9c45d89d-5049-4d0f-9914-72f31ab6e2b7"

accountId
string<uuid>

Autoconversion rule's account, which receives the deposits.

Example:

"bdb68dac-0370-4957-a7ea-5fcb7d5a4008"

partnerFeeId
string<uuid> | null

Autoconversion rule's partner fee, applied to each conversion. null when not set.

Example:

"6229c89b-3903-4654-b78d-466027213796"

status
enum<string>

Autoconversion rule's status. ACTIVE: the rule converts matched deposits. Always ACTIVE here.

Available options:
ACTIVE
Example:

"ACTIVE"

provider
enum<string>

Autoconversion rule's provider, the account's banking provider that receives and matches the deposits.

Available options:
STARKBANK,
BPY,
COBRE,
FINTOC,
ONE_MONEY,
OPENPAYD
Example:

"BPY"

sourceCurrency
enum<string>

Autoconversion rule's source currency, taken from the account's currency.

Available options:
USD,
BRL,
EUR,
MXN,
GBP
Example:

"BRL"

targetCurrency
enum<string>

Autoconversion rule's target currency, the asset deposits are converted into.

Available options:
USDC,
USDT
Example:

"USDC"

blockchain
enum<string>

Autoconversion rule's blockchain, where the converted asset is delivered.

Available options:
ETHEREUM,
POLYGON,
BASE,
TRON,
STELLAR
Example:

"POLYGON"

purpose
enum<string>

Autoconversion rule's purpose, the end-use category of the funds.

Available options:
PERSONAL_ACCOUNT,
INVESTMENT,
REAL_ESTATE,
TRADE_TRANSACTIONS,
TAX,
LOAN,
BILLS,
EXPENSES_REIMBURSEMENT,
PROFESSIONAL_SERVICES
Example:

"INVESTMENT"

name
string

Autoconversion rule's name, a label visible only to you.

Example:

"BRL to USDC investment"

sourceDepositInfo
object[]

Autoconversion rule's deposit details to share with the sender, one item per payment rail. BRL returns one PIX item, MXN one SPEI item, USD one item each for FEDWIRE, ACH, and SWIFT, EUR one SEPA item, and GBP one FPS item. The fields of each item depend on the rail.

createdAt
string<date-time>

Creation date and time (UTC).

Example:

"2026-11-03T17:38:35.585Z"