Pré-análise · Accelerazione

Consulte, antes de mostrar a opção, se o Pix parcelado deve ser oferecido para um comprador e um valor.

POST/api/v1/pagaleve/pre-analysis

A pré-análise é opcional. Ela ajuda a decidir se você deve mostrar o Pix parcelado para um comprador e um valor. Ela não reserva crédito nem garante a aprovação da compra.

Terminal

curl -X POST "$DM_API_BASE/api/v1/pagaleve/pre-analysis" \
  -H "Authorization: $DM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 29990,
    "customer": {
      "document": "12345678909",
      "email": "cliente@example.com",
      "phone": "+5511999999999"
    }
  }'

Campo	Descrição
`amount`	Valor em centavos de BRL, de `1` a `1000000`.
`customer.document`	CPF do comprador, sem pontuação.
`customer.email`	E-mail do comprador.
`customer.phone`	Telefone brasileiro em formato internacional.

Envie pelo menos um identificador em customer. Recomenda-se enviar os três.

200 OK

{ "action": "ALLOW" }

Resultado	O que fazer
`ALLOW`	Mostre o Pix parcelado para esse comprador e valor.
`DENY`	Não ofereça o método nesta consulta. O comprador pode escolher outro meio de pagamento.
Erro HTTP	A pré-análise não concluiu. Não trate como aprovação.

Não há webhook de pré-análise: o resultado vem na resposta.

HTTP	`type`	Causa
`422`	`merchant_not_eligible`	A conta não está habilitada para Pix parcelado.
`502`	`pagaleve_pre_analysis_failed`	A consulta à Pagaleve não concluiu. Não trate como `ALLOW`.
`502`	`merchant_eligibility_check_failed`	A verificação de habilitação da conta não concluiu. Repita depois.