CreateEnrollmentBody

client_redirect_url stringrequired

Client redirect URL.

participant_id stringrequired

Open Finance participant id.

logged_user_document stringrequired

Client logged user document. In case of the user is a business entity, it is the document of the business entity representative.

logged_business_entity_document string

Client logged user document when the user is a business entity.

permissions string[]required

Possible values: [PAYMENTS_INITIATE, RECURRING_PAYMENTS_INITIATE]

Enrollment permissions. PAYMENTS_INITIATE: Permission to initiate payments RECURRING_PAYMENTS_INITIATE: Permission to initiate recurring payments

name string

Enrollment name.

logged_user_bank_ispb string

client logged user bank ISPB.

logged_user_branch_number string

client logged user branch number.

logged_user_bank_account_number string

client logged user bank account number.

logged_user_bank_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 bank account type.

is_linked boolean

Enrollment is linked to a optmized journey.

link_id string

Enrollment link id to a optmized journey. Required if is_linked is true.