API BaaSBoleto Charge

Change boleto beneficiary eligibility

Changes eligibility. Allowed transitions: `ELIGIBLE` to `UNDER_REVIEW` or `INELIGIBLE`; `UNDER_REVIEW` to `ELIGIBLE` or `INELIGIBLE`; `INELIGIBLE` to `UNDER_REVIEW`. Any other combination is **409** `boleto_charge_beneficiary_transition_invalid` and is not sent to the settlement bank. `reason` is required. `documentId` is required when the target is `INELIGIBLE`. Asynchronous **202**. Scope `boleto_charge.manage`.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired
Account identifier.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
Idempotency-KeystringOptional

Optional client-generated idempotency token (recommended for safe retries).

Request

This endpoint expects an object.
targetStatusenumRequired
Allowed values:
reasonstringRequired<=500 characters
documentIdstringOptional<=120 characters
alertOriginInstitutionstringOptional<=12 characters
ISPB of the institution that raised the alert.

Response

Accepted.
operationIdstringOptional
beneficiaryIdstringOptional
processingStatusenumOptional
Allowed values:

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error