v2
API Documentation
Começando

Aqui você irá encontrar toda a documentação pública da PoloPay para geração de cobranças PIX e pagamentos via API.

Ambiente

Base URL:

https://aurorapro.online

Todos os endpoints descritos utilizam esta base.

Gerar QRCode
POST https://aurorapro.online/v2/pix/qrcode
POST
Body Params
amount required
number
Valor da transação em reais (> 0).
external_id optional
string
ID externo definido por você para conciliação.
postbackUrl optional
string (URL)
URL HTTPS para receber notificações da cobrança.
payerQuestion optional
string
Texto exibido ao pagador junto ao QRCode.
payer optional
objeto
Dados do pagador (nome, documento, email).
Fazer um Pagamento
POST https://aurorapro.online/v2/pix/payment
POST
Body Params
amount required
number
Valor do saque em reais (> 0).
description optional
string
Descrição livre da transferência.
external_id optional
string
ID externo para conciliação.
creditParty required
objeto
Dados do destinatário da transferência PIX.
Tipos de chave PIX (keyType)
  "TELEFONE"
  "EMAIL"
  "CPF"
  "CNPJ"
  "CHAVE_ALEATORIA"
Evento de Pagamento (Webhook)

Quando você informa postbackUrl ao gerar o QRCode, a PoloPay envia um postback para a sua URL quando houver atualização do pagamento.

Payload enviado

A PoloPay faz um POST para a sua URL com o payload abaixo. 

{
  "status": "approved",
  "transaction_id": "4392d1d7e408d3cec04fm1zf3gv7vkq1",
  "amount": 15,
  "external_id": "pedido-123",
  "paymentType": "PIX"
}

Campos:
status: status do pagamento.
transaction_id: ID público da transação retornado na criação do QRCode.
amount: valor em reais (float).
external_id: seu identificador externo (se enviado).
paymentType: forma de pagamento.

Status de pagamento
  "waiting_payment"
  "approved"
  "refunded"
  "paid"
  "cancelled"
  "chargeback"
  "pending"
  "in_protest"