Skip to main content

Get Open Finance Layout Config by ID

GET 
/v1/open-finance/layout-configs/:id

Get an open finance layout config by id.

Request​

Path Parameters

    id stringrequired

    Layout config UUID.

Header Parameters

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

    nonce stringrequired

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

    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.

    x-lang string

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

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

Responses​

Layout config retrieved successfully.

Schema
    id stringrequired

    Layout config UUID.

    status stringrequired

    Possible values: [ACTIVE, INACTIVE]

    Layout config status.

    logo_url stringrequired

    Layout config logo URL.

    background_color stringrequired

    Layout config background color. (Hex color code)

    button_color stringrequired

    Layout config button color. (Hex color code)

    redirect_url stringrequired

    Layout config redirect URL.

    created_at date-timerequired

    Enrollment created at.

    updated_at date-timerequired

    Enrollment updated at.

Loading...