Skip to main content

Get All Enrollments

GET 
/open-finance/enrollments

Get all enrollments with filters.

Request​

Query Parameters

    page number

    Default value: 1

    Page number.

    size number

    Possible values: <= 100

    Default value: 20

    Page size. Max size is 100.

    sort string

    Possible values: [created_at]

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

    status string[]

    Possible values: [PENDING, ERROR, FAILED, AWAITING_DEVICE_RISK_SIGNALS, AWAITING_ACCOUNT_OWNER_VALIDATION, AWAITING_ENROLLMENT, AWAITING_DEVICE_REGISTRATION, PENDING_REVOKE, AUTHORIZED, REVOKED, REJECTED]

    Enrollment status.

    permissions string[]

    Possible values: [PAYMENTS_INITIATE, RECURRING_PAYMENTS_INITIATE]

    Enrollment Permissions.

    logged_user_document string

    Filter by logged user document.

    logged_business_entity_document string

    Filter by logged business entity document.

    participant_id string

    Participant UUID.

    created_at_start date-time

    Filter by created at start.

    created_at_end date-time

    Filter by created at end.

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​

Enrollments returned successfully.

Schema
    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    Enrollments data.

  • Array [
    • id stringrequired

    Enrollment UUID.

    status stringrequired

    Possible values: [PENDING, ERROR, FAILED, AWAITING_DEVICE_RISK_SIGNALS, AWAITING_ACCOUNT_OWNER_VALIDATION, AWAITING_ENROLLMENT, AWAITING_DEVICE_REGISTRATION, PENDING_REVOKE, AUTHORIZED, REVOKED, REJECTED]

    Enrollment status.

    name string

    Enrollment name.

    logged_user_document stringrequired

    Client logged user document.

    logged_user_document_type objectrequired

    Client logged user document type.

    logged_business_entity_document string

    Client logged business entity document.

    logged_business_entity_document_type object

    Client logged business entity document type.

    permissions string[]required

    Possible values: [PAYMENTS_INITIATE, RECURRING_PAYMENTS_INITIATE]

    Enrollment permissions.

    logged_user_bank_ispb string

    Client logged user bank ISPB.

    logged_user_branch_number string

    Client logged user branch number.

    logged_user_account_number string

    Client logged user account number.

    logged_user_account_type string

    Possible values: [CACC, CASH, CHAR, CISH, COMM, CPAC, LLSV, LOAN, MGLD, MOMA, NREX, ODFT, ONDP, OTHR, SACC, SLRY, SVGS, TAXE, TRAN, TRAS, CC, PG, CD, CG, CI, PP, PI]

    Client logged user account type.

    transaction_limit number

    Enrollment transaction limit.

    daily_limit number

    Enrollment daily limit.

    expiration_date date-time

    Enrollment expiration date.

    participant_id stringrequired

    Open Finance participant id.

    participant_friendly_name stringrequired

    Open Finance participant friendly name.

    participant_friendly_logo_uri string

    Open Finance participant friendly logo URI.

    is_linked boolean

    Enrollment is linked to an optimized journey.

    link_id string

    Enrollment link id to an optimized journey. Required if is_linked is true.

    canceled_by_document string

    Enrollment canceled by document.

    canceled_by_document_type object

    Enrollment canceled by document type.

    cancel_reason object

    Enrollment canceled reason.

    cancel_description string

    Enrollment canceled description.

    canceled_from object

    Enrollment canceled from.

    canceled_at date-time

    Enrollment canceled at.

    redirect_uri string

    Enrollment redirect link.

    created_at date-timerequired

    Enrollment created at.

    updated_at date-timerequired

    Enrollment updated at.

  • ]
Loading...