Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.stric.io/llms.txt

Use this file to discover all available pages before exploring further.

Neste guia você vai:
  1. Configurar sua API key
  2. Consultar o saldo da sua conta
  3. Consultar o titular de uma chave Pix

1. Sua API key

Nesse momento você precisa ter sua API key em mãos, com o escopo que sua integração precisa.
A API key dá acesso completo ao escopo configurado. Trate como senha: variáveis de ambiente, secrets manager, nunca em repositórios públicos.
Salve em .env:
export STRIC_API_KEY="sua_api_key_aqui"
export STRIC_BASE_URL="https://stater.stric.io"

2. Consulte seu saldo

curl "$STRIC_BASE_URL/v1/balance" \
  -H "Authorization: Bearer $STRIC_API_KEY"
Resposta esperada (valores em centavos como string):
{
  "available": "150000",
  "blocked": "0"
}
"150000" significa R$ 1.500,00. Toda quantia monetária na Stric é representada como string em centavos.

3. Consulte o titular da chave Pix

Antes de enviar um Pix, é comum usar POST /v1/dict/lookup pra confirmar o titular e obter um dictLookupId opcional para a próxima transferência Pix. pixKeyType deve ser uma destas strings: CPF, CNPJ, EMAIL, PHONE, EVP — alinhado ao campo pixKey.
curl -X POST "$STRIC_BASE_URL/v1/dict/lookup" \
  -H "Authorization: Bearer $STRIC_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "pixKey": "exemplo@stric.io",
    "pixKeyType": "EMAIL"
  }'
Resposta:
{
  "id": "dlk_01HXYZ...",
  "key": "exemplo@stric.io",
  "keyType": "EMAIL",
  "owner": { "name": "Maria Silva", "document": "***.123.456-**" },
  "bankName": "Banco Exemplo",
  "ispb": "12345678",
  "branch": "0001",
  "account": "1234567",
  "accountType": "CACC",
  "cached": false
}
Guarde o id — você pode usá-lo como dictLookupId em POST /v1/payouts junto dos campos obrigatórios pixKey, pixKeyType e amountCents.

Próximos passos

1

Envie seu primeiro Pix

Use pixKey, pixKeyType, amountCents e, se aplicável, dictLookupId. Veja o fluxo completo.
2

Crie uma cobrança

Gere QR Code para receber pagamentos. Veja Receber Pix.
3

Configure webhooks

Receba eventos em tempo real. Veja Webhooks.