S
Stater

PIX entrada

QR code de depósito

Gere cobranças PIX via QR. O corpo é uma união discriminada pelo campo variant: simple, debtor ou cobv.

Criar cobrança

POST/v1/accounts/:accountId/pix/deposit-qrcodes

Escopo: pix:in. Valores monetários em centavos.

Campos comuns
variantenumrequired

simple | debtor | cobv

amountintegerrequired

Valor em centavos.

base64Imagebooleanoptionaldefault: true (simple), false (debtor)

Quando true, devolve PNG em base64.

Variante debtor

debtorNamestringrequired

Nome do pagador.

debtorDocumentstringrequired

CPF ou CNPJ (somente dígitos).

typeDocumentenumrequired

CPF | CNPJ

Variante cobv

dueDateISO 8601required

Data de vencimento.

expirationDateISO 8601required

Quando o QR expira.

fineDateISO 8601required

Data a partir da qual incide multa.

typeFineenumoptionaldefault: NONE

NONE | VALUE | PERCENT

finenumberoptional

Valor ou percentual de multa. Deve ser > 0 quando typeFine ≠ NONE.

tagstringoptional

Texto livre (ex.: número do pedido).

Imagem em base64

Quando base64Image: true, a resposta inclui imageBase64 com a imagem do QR code em PNG codificada em base64.

Erros

400 invalid_request — corpo inválido.

422 deposit_qr_failed — provedor recusou + reason.

422 account_not_virtual / account_missing_provider_fields / missing_env_or_account_config.

Consultar cobrança

GET/v1/accounts/:accountId/pix/charges/:chargeId

Escopo: pix:in.

404 not_found quando o ID não existe ou pertence a outra conta.

Listar cobranças

GET/v1/accounts/:accountId/pix/charges

Escopo: pix:in. Suporta filtro por status e paginação por cursor.

Query params
cursorstringoptional

ID da última cobrança da página anterior.

limitintegeroptionaldefault: 30

Itens por página (mín. 1, máx. 100).

statusenum | enum[]optional

Filtra por status. Aceita valor único (status=PENDING) ou múltiplos (status=PENDING&status=COMPLETED).

Status aceitos

  • PENDING — pendente
  • COMPLETED — paga
  • EXPIRED — expirada
  • FAILED — falhou
  • REFUNDED — estornada

Exemplos

bash
curl -X GET "https://stater.stric.io/v1/accounts/acc_123/pix/charges" \
  -H "Authorization: Bearer $TOKEN"

Resposta

json· 200 OK
{
  "data": [
    {
      "chargeId": "chg_cx4xq7k9m0001",
      "tenantId": "ten_01",
      "accountId": "acc_123",
      "status": "COMPLETED",
      "amountCents": "1500",
      "paidAt": "2026-04-23T10:00:00.000Z",
      "createdAt": "2026-04-23T09:59:00.000Z",
      "updatedAt": "2026-04-23T10:00:00.000Z"
    },
    {
      "chargeId": "chg_cx4xq7k9m0000",
      "tenantId": "ten_01",
      "accountId": "acc_123",
      "status": "PENDING",
      "amountCents": "900",
      "createdAt": "2026-04-23T09:00:00.000Z",
      "updatedAt": "2026-04-23T09:00:00.000Z"
    }
  ],
  "nextCursor": "chg_cx4xq7k9m0000"
}
  • data: array de cobranças no mesmo formato do endpoint de detalhe.
  • nextCursor: ID para buscar a próxima página, ou null quando não houver mais registros.

Erros

400 invalid_request — query inválida (ex.: limit fora da faixa).

401 unauthorized — token ausente/inválido.

403 forbidden — sem escopo pix:in ou conta restrita sem permissão.

404 account_not_found — conta não encontrada para o tenant.