Saltar para o conteúdo
PayAppDocs
Criar conta

Verificar um comprovativo

Confirma um comprovativo contra as contas registadas da loja.

POSThttps://api.payapp.ferreirakorp.com/v1/verify

Pedido

Aceita três formatos de envio:

  1. multipart/form-data com o campo comprovativo (ou file, ou pdf)
  2. application/json com { "pdf_b64": "<base64>", "valor": 45000 }
  3. o PDF em bruto no corpo do pedido

O campo opcional valor é o montante esperado da encomenda. Quando enviado, a verificação também confirma que o comprovativo cobre esse valor.

curl -X POST https://api.payapp.ferreirakorp.com/v1/verify \
  -H "X-API-Key: pk_live_…" \
  -F "[email protected]"

Resposta

{
  "ok": true,
  "autentico": true,
  "repetido": false,
  "verdict": "VERDADEIRO",
  "valor": 45000,
  "txn": "0912847361",
  "nome": "Ana Miguel",
  "iban": "AO06…5017 9",
  "motivo": [],
  "cobrado": "gratis",
  "retencao": "nenhuma"
}
CampoSignificado
autenticoa assinatura digital do banco confere e o destino é uma conta da loja
repetidoeste comprovativo já tinha sido verificado nesta loja
verdictVERDADEIRO, FALSO, NAO_CONFIRMADO ou ERRO
valormontante em Kwanzas
nomequem ordenou a transferência
motivolista de explicações em português quando falha (mostrável ao cliente)
cobradogratis (dentro das 100 do mês) ou credito

Regra de negócio

só entregue a mercadoria quando autentico === true e repetido === false. Um comprovativo autêntico mas repetido é a tentativa de burla mais comum: o mesmo PDF verdadeiro reenviado a várias lojas.

Erros

CódigoSituação
401API key inválida
400não veio PDF nenhum
402sem créditos: a loja tem de recarregar