Skip to main content

Get Credit Balance and Liability

GET 
/v1/otc/conversions/credit-balance

Retrieve the user's liability (the sum of all negative balances in BRL across active currencies) and credit balance.

Request​

Header Parameters

    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

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

Responses​

Conversion credit success.

Schema
    liability numberrequired

    Libability (Sum of all negative balances of all active currencies).

    credit_balance numberrequired

    Credit balance for user.

Loading...