PenguimPay Logo

PenguimPay API

v1.0 - Plataforma de Pagamentos

Bem-vindo a documentacao da API PenguimPay. Aqui voce encontra os endpoints para gerar PIX In (depositos), PIX Out (saques), consultar status, gerenciar compliance e configurar webhooks. Insira sua publickey no campo Bearer Token na sidebar para testar os endpoints diretamente.

Authentication

Use sua publickey diretamente como Bearer Token em todas as chamadas. Sem necessidade de login ou JWT.

Transactions

Gere PIX In (deposito), PIX Out (saque), consulte status de transacoes e gerencie compliance.

Webhooks

Receba notificacoes automaticas sobre mudancas de status das transacoes na URL configurada.

Base URL

Todas as chamadas utilizam https://api.penguimpay.com como base.

Como comecar

1

Obtenha sua publickey no painel da PenguimPay ao criar sua conta de integrador.

2

Insira a publickey no campo Bearer Token na sidebar esquerda. Ela sera usada automaticamente em todas as requests.

3

Selecione um endpoint na sidebar, copie os exemplos de codigo na sua linguagem ou clique em "Enviar Request" para testar diretamente.

Header de Autenticacao

Todas as requisicoes devem incluir o seguinte header com sua publickey:

Authorization: Bearer pk_sua_chave_aqui
Content-Type: application/json

Codigos de Status HTTP

200OKRequisicao bem-sucedida
201CreatedRecurso criado com sucesso
400Bad RequestDados invalidos na requisicao
401UnauthorizedToken ausente ou invalido
403ForbiddenSem permissao para acessar o recurso
404Not FoundRecurso nao encontrado
500Internal ErrorErro interno do servidor