Skip to navigation

Update boleto beneficiary registration data

Updates registration data of this account’s beneficiary. The facade looks up the beneficiary from the account; do not send a beneficiary id. At least one field is required. A person account accepts name and socialName; a company account accepts legalName and tradeName. email, phone and representative fields apply to both. Asynchronous: 202 with operationId. Scope boleto_charge.manage. Requires boleto_charge.

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.
legalNamestringOptional<=200 characters
tradeNamestringOptional<=200 characters
namestringOptional<=200 characters
socialNamestringOptional<=200 characters
emailstringOptional
phonestringOptional<=30 characters
representativeNamestringOptional<=200 characters
representativeEmailstringOptional
representativePhonestringOptional<=30 characters

Response

Accepted. The settlement bank confirms later.
operationIdstringOptional
beneficiaryIdstringOptional
processingStatusenumOptional
Allowed values:

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error