Consultar chave Pix
POST /accounts/:accountId/pix/key-info — etapa 1 do fluxo de transferência Pix.
Consultar chave Pix
Etapa 1 do fluxo de transferência Pix: resolve a chave informada via DICT e devolve um keyInfoId que deve ser usado no POST /pix/payment. A consulta também serve para confirmar visualmente o destinatário antes do envio (nome, banco, documento mascarado).
POST/accounts/:accountId/pix/key-info
Etapa 1 de 2. Tipo da chave é inferido automaticamente do formato. Sempre confirme com o usuário o name e document do titular antes de chamar /pix/payment — fluxo padrão Pix BCB exige essa confirmação. document vem mascarado por regulação. Guarde o key.id e passe como keyInfoId na etapa 2.
Path params
- accountIdObrigatóriostring (UUID)ID da conta que vai enviar o Pix.
Headers
- AcceptObrigatóriostringapplication/json
- Content-TypeObrigatóriostringapplication/json
- AuthorizationObrigatóriostringBearer <token> — JWT de /authenticate.
- X-Tenant-IdObrigatóriostring (UUID)Identificador do tenant.
Body
- keyObrigatóriostringValor bruto da chave Pix (EMAIL, telefone E.164, CPF/CNPJ apenas dígitos ou EVP em UUID).
Exemplo de requisição
bash
curl -X POST https://baas.staterpay.io/accounts/00000000-0000-0000-0000-000000000010/pix/key-info \ -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 '{ "key": "fulano@example.com" }'Resposta
- keyobjectDados resolvidos da chave consultada.
- key.idstring (UUID)ID interno desta consulta — use como keyInfoId em /pix/payment.
- key.keystringChave consultada (eco).
- key.ispbstringCódigo ISPB (8 dígitos) da instituição do titular.
- key.documentstringCPF/CNPJ do titular, mascarado conforme regulação BCB (ex.: ***456789** para CPF).
- key.namestringNome ou razão social do titular.
- key.bankNamestringNome do banco do titular.
- key.bankCodestringCódigo COMPE (3 dígitos) do banco.
- key.endToEndIdstringEndToEndId reservado pela Stater para essa consulta. Será usado quando a transferência for efetivada.
json
{ "key": { "id": "00000000-0000-0000-0000-0000000000d1", "key": "fulano@example.com", "ispb": "12345678", "document": "***456789**", "name": "Fulano de Tal", "bankName": "BANCO EXEMPLO S.A.", "bankCode": "999", "endToEndId": "00000000-0000-0000-0000-0000000000d2" }}URL base:
https://baas.staterpay.io