Pré-análise do Pix parcelado

Indica se o Pix parcelado deve ser oferecido a um comprador e valor. Não reserva crédito nem garante aprovação.

POST

/api/v1/pagaleve/pre-analysis

Indica se o Pix parcelado deve ser oferecido a um comprador e valor. Não reserva crédito nem garante aprovação.

Autenticação

ApiKey

headerAuthorization<token>

A chave de API crua, sem prefixo: kpa_test_sk_… no sandbox e kpa_live_sk_… em produção. Use apenas no servidor.

Corpo da requisição

application/json

body

amount*integer

Centavos de BRL.

Intervalo1 <= value <= 1000000

customer*

Pelo menos um identificador. Recomendado enviar os três.

Corpo da resposta

Resultado.

application/json

response

action?string

Trate valores desconhecidos como DENY.

Valores aceitos"ALLOW""DENY"

Exemplo de requisição

curl -X POST 'https://g6idryo27h.execute-api.us-east-1.amazonaws.com/api/v1/pagaleve/pre-analysis' \
  -H 'Content-Type: application/json' \
  -d '{
  "amount": 29990,
  "customer": {
    "document": "12345678909",
    "email": "cliente@example.com",
    "phone": "+5511999999999"
  }
}'

Exemplo de requisição

curl -X POST 'https://g6idryo27h.execute-api.us-east-1.amazonaws.com/api/v1/pagaleve/pre-analysis' \  -H 'Content-Type: application/json' \  -d '{  "amount": 29990,  "customer": {    "document": "12345678909",    "email": "cliente@example.com",    "phone": "+5511999999999"  }}'

Exemplo de respostaEsquema

{
  "action": "ALLOW"
}

{  "action": "ALLOW"}

Pré-análise do Pix parcelado

AutenticaçãoCopiar link da seção

Corpo da requisiçãoCopiar link da seção

Corpo da respostaCopiar link da seção

Autenticação

Corpo da requisição

Corpo da resposta