Documentação da API Pix PradaPay

Bem-vindo à documentação da API Pix do PradaPay! Esta API permite que você integre facilmente a funcionalidade de geração de Pix em seus aplicativos.

Como Usar

Para usar a API Pix do PradaPay, faça uma requisição HTTP POST para o endpoint https://api.pradapay.com/v1/gateway/ com os seguintes parâmetros:

Exemplo de Requisição Cash in


{
    "amount": 100,
    "client": {
        "name": "Maria Oliveira",
        "document": "123456789",
        "telefone": "11999999999",
        "email": "[email protected]"
    },
    "api-key": "81bb141jmdaw9u32-d3q9md3qd-qdwq59",
    "postback": "https://meusistema.com/callback"
}

Respostas da API

200 OK: O Pix foi gerado com sucesso. A resposta incluirá detalhes do Pix.
401 Unauthorized: Credenciais inválidas.
400 Bad Request: JSON inválido ou dados ausentes.
404 Not Found: Transação não encontrada.

Exemplo de Resposta (200 OK)


{
    "status": "success",
    "message": "ok",
    "paymentCode": "000201010212267...",
    "idTransaction": "52fc5262-4063-4900...",
    "paymentCodeBase64": "iVBORw0..."
}

Exemplo de Resposta (401 Unauthorized)


{
    "status": "error",
    "message": "Falha na solicitação: Credenciais inválidas"
}

Exemplo de Resposta (400 Bad Request)


{
    "error": "Invalid JSON or missing externalreference"
}

Exemplo de Resposta (404 Not Found)


{
    "error": "Transaction not found"
}

Confirmação de Pagamento

Para confirmar o pagamento, faça uma requisição HTTP POST para o endpoint https://api.pradapay.com/v1/webhook/ com o seguinte parâmetro:


{
    "idtransaction": "81bb141a-1746-49a8..."
}

Exemplo de Resposta (200 OK)


{
    "status": "WAITING_FOR_APPROVAL" 
    // ou
    "status": "PAID_OUT"
}

Exemplo de Requisição Cash Out

Endpoint: https://api.pradapay.com/c1/cashout/

    
{
    "api-key": "81bb141a-1746-49a8-basdasdas4a-c3b8dasdasdasaa0d2259" ,
    "name": "adm",
    "cpf": "7029166923232492" ,
    "keypix": "7029132323669492",
    "amount": 410.95
}

Chamada do Callback

Após o pagamento, será enviada uma requisição HTTP POST para o endpoint configurado como callback com os seguintes dados:


{
    "amount": 0,
    "idTransaction": "52f129b8-4bfb-4acb-8c40-d3241182c0cf",
    "paymentMethod": "PIX",
    "status": "paid"
}

FAQs

Q: O que é necessário para autenticar minha requisição?

A chave api-key deve ser incluída no corpo da requisição.

Q: Como recebo notificações de pagamento?

Configure o URL do callback no momento da requisição.

Para mais informações, visite a página oficial.