API Internet BankingBanks

Look up a participant by COMPE or ISPB

Same row as in GET /v1/banks. {code} accepts a 3-digit COMPE (341), a padded COMPE (0341) or an 8-digit ISPB (60701190). Unknown or disabled codes return 404 bank_not_found. A value that is not 3, 4 or 8 digits returns 400 invalid_bank_code.

Authentication

AuthorizationBearer

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

Path parameters

codestringRequired

COMPE (3 digits) or ISPB (8 digits).

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

The participant.
namestring
bankCodestring

3-digit COMPE. Empty when the participant has no COMPE.

ispbstring

8-digit ISPB. Leading zeros are significant (Banco do Brasil is 00000000).

tedboolean

Can be a TED destination (has a COMPE that POST .../ted/out accepts).

pixboolean

Offered in the PIX-by-bank-account dropdown.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error