API BaaSBoleto Charge

Close the boleto beneficiary relationship

Closes the relationship. After the settlement bank confirms, this account cannot issue new boletos. Register again to reactivate. `reason` is required. `terminationDate` is optional (`YYYY-MM-DD`, today or later, BRT). **202** carries `operationId` from the bank's `X-Operation-Id`. 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.
reasonstringRequired<=500 characters
terminationDatedateOptional

Response

Close request accepted.
operationIdstringOptional
beneficiaryIdstringOptional
processingStatusenumOptional
Allowed values:

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error