Consultar beneficiário TEF
POST /accounts/:accountId/tef/beneficiary — etapa 1 do fluxo de transferência interna.
Consultar beneficiário TEF
Etapa 1 do fluxo de transferência interna (TEF — entre contas Stric/WL): pesquisa um beneficiário pelo CPF/CNPJ e lista as contas vinculadas. Use o accountNumber retornado na etapa 2 para efetivar a transferência.
POST/accounts/:accountId/tef/beneficiary
Etapa 1 de 2. Só encontra beneficiários dentro do mesmo tenant — TEF é transferência interna (entre contas Stric/WL), nunca cruza bancos externos. Para isso use Pix. document volta sem máscara porque é a base da confirmação visual antes do envio. Um mesmo CPF/CNPJ pode ter mais de uma conta — escolha a accounts[].accountNumber correta antes de chamar /tef/internal-payment.
Path params
- accountIdObrigatóriostring (UUID)ID da conta que vai enviar o TEF.
Headers
- AcceptObrigatóriostringapplication/json
- Content-TypeObrigatóriostringapplication/json
- AuthorizationObrigatóriostringBearer <token> — JWT de /authenticate.
- X-Tenant-IdObrigatóriostring (UUID)Identificador do tenant.
Body
- documentObrigatóriostringCPF (11 dígitos) ou CNPJ (14 dígitos) do beneficiário, apenas números.
Exemplo de requisição
bash
curl -X POST https://baas.staterpay.io/accounts/00000000-0000-0000-0000-000000000010/tef/beneficiary \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.<payload>.<signature>" \ -H "X-Tenant-Id: 00000000-0000-0000-0000-000000000000" \ -d '{ "document": "12345678000190" }'Resposta
- beneficiaryobjectDados do beneficiário encontrado.
- beneficiary.namestringNome (PF) ou razão social (PJ).
- beneficiary.documentstringDocumento (eco). Aqui sai sem mascaramento porque é necessário pra confirmação visual antes da transferência.
- beneficiary.accountsarrayContas Stric/WL associadas ao documento.
- beneficiary.accounts[].idstring (UUID)ID interno da conta beneficiária.
- beneficiary.accounts[].accountNumberstringNúmero da conta — use este valor em /tef/internal-payment.
- beneficiary.accounts[].agencystringAgência (4 dígitos).
- beneficiary.accounts[].bankstringCódigo do banco (3 dígitos). Para TEF interno usa "000".
json
{ "beneficiary": { "name": "NOME EMPRESA LTDA", "document": "12345678000190", "accounts": [ { "id": "00000000-0000-0000-0000-000000000020", "accountNumber": "1000002", "agency": "0001", "bank": "000" } ] }}URL base:
https://baas.staterpay.io