API Internet BankingBoleto 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.
X-Request-TimestampstringRequired

Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).

X-Content-SHA256stringRequired

Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.

X-Request-SignaturestringRequired

Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.

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
legalNamestringOptional
tradeNamestringOptional
socialNamestringOptional
relationshipStartDatedateOptional
relationshipClosedAtdatetimeOptional
emailstringOptional
phonestringOptional
representativeNamestringOptional
representativeEmailstringOptional
representativePhonestringOptional
alertOriginatorslist of stringsOptional
ISPBs of institutions that raised alerts about this beneficiary.
updateddatetimeOptional
accountIdstringOptional
Present on the tenant list, when the tax number matches an account.

Errors

403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error