API BaaSBoleto Charge

Get the account's boleto beneficiary

Live beneficiary of this account. 404 boleto_charge_beneficiary_not_found when the holder was never registered. 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.

Response

Beneficiary
beneficiaryIdstringOptional

Settlement-bank beneficiary id.

identifierstringOptional
Beneficiary identifier.
statusenumOptional
Beneficiary status.
Allowed values:
relationshipStatusenumOptional
Relationship with the settlement bank.
Allowed values:
relationshipActivebooleanOptional
True when the relationship is active.
personTypeenumOptional
Allowed values:
taxNumberstringOptional
namestringOptional

Errors

403
Forbidden Error
404
Not Found Error