Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.usealpa.com/llms.txt

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

​
Endpoint

POST /api/advances/
Autenticação: Bearer Token (JWT) — requer KYC aprovado

​
Corpo da requisição

CampoTipoObrigatórioDescrição
amountCentsintegerValor a antecipar em centavos. Se omitido, antecipa o saldo total disponível
reasonstringMotivo da solicitação (opcional, para análise interna)
Somente uma antecipação pode estar com status PENDING ou APPROVED por vez. Tente criar outra nesse estado retorna 409 Conflict.

​
Exemplo

curl --request POST \
  --url https://alpa-sistema-api.onrender.com/api/advances/ \
  --header 'Authorization: Bearer SEU_JWT_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "amountCents": 50000,
    "reason": "Capital de giro"
  }'

​
Resposta de sucesso (201 Created)

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "amountCents": 50000,
    "netAmountCents": 48500,
    "feeCents": 1500,
    "feePercentage": 3.0,
    "status": "PENDING",
    "createdAt": "2026-05-25T00:00:00.000Z"
  }
}
CampoDescrição
amountCentsValor bruto solicitado
netAmountCentsValor líquido a ser creditado (bruto − taxa)
feeCentsTaxa de antecipação em centavos
feePercentageTaxa de antecipação em percentual
statusSempre PENDING ao criar

​
Erros comuns

CódigoDescrição
400Valor inválido ou sem saldo disponível para antecipar
403KYC não aprovado
409Já existe uma antecipação PENDING ou APPROVED

Listar antecipações

Acompanhe o status da sua solicitação.