v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Colaboradores

Conta bancária do colaborador

Retorna o estado da conta bancária de um colaborador identificado pelo CPF.

Parâmetro bank:

ValorComportamento
BTG (padrão)Consulta a conta BTG do colaborador
PANFallback para colaboradores sem conta BTG ativa

Se a requisição sem bank retornar 404, tente com ?bank=PAN. Colaboradores no início do onboarding podem ainda não ter conta BTG ativa.

get/{companyId}/banking/payroll/employees/{employeeTaxId}/account

Path parameters

companyIdstring required
employeeTaxIdstring required

Query parameters

bankstring

Response

OK

employeeIdstring nullable
accountTypestring nullable
statusstring nullable
errorsstring nullable
onboardingFinalizadoboolean
onboardingFinishedAtstring date-time nullable
bankstring nullable
agencystring nullable
numberstring nullable