Listar vendas
Sem campo de autorização: o portal autentica por você com a sua chave de Homologação e as requisições rodam só no ambiente de testes.
Token de acesso devolvido por POST /auth/token. Envie como "Authorization: Bearer ". Vale 24 horas.
In: header
Query Parameters
Número da página, começando em 1.
11 <= valueItens por página, de 1 a 100.
251 <= value <= 100Situação da venda.
"DRAFT" | "OPEN" | "PROCESSING" | "PAID" | "CANCELED" | "ASK_REFUND" | "ASK_PARTIAL_REFUND" | "REFUNDED" | "PARTIALLY_REFUNDED" | "REFUNDING" | "ABANDONED" | "EXPIRED" | "FAILED" | "CHARGEBACK_REQUESTED" | "CHARGEBACK_APPROVED"Meio de pagamento da venda.
"CREDIT_CARD" | "PIX" | "BOLETO" | "APPLE_PAY" | "GOOGLE_PAY"Vendas criadas a partir desta data e hora, incluindo ela. ISO 8601 com fuso.
date-timeVendas criadas até esta data e hora, incluindo ela. ISO 8601 com fuso.
date-timeLista só as vendas com esta referência do pedido (a mesma enviada na criação do pagamento ou da assinatura).
length <= 255Vendas que têm este produto em algum item. A venda volta com todos os itens.
uuidE-mail do cliente da venda. E-mail completo, sem diferenciar maiúsculas de minúsculas.
emailDocumento do cliente da venda. CPF com 11 dígitos ou CNPJ com 14, com ou sem pontuação.
Response Body
curl -X GET "https://pagpolar-api.creativecode.dev.br/v1/sales?page=1&per_page=25&status=DRAFT&payment_method=CREDIT_CARD&created_from=2019-08-24T14%3A15%3A22Z&created_to=2019-08-24T14%3A15%3A22Z&external_reference=string&product_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&customer_email=user%40example.com&customer_document=123.456.789-09"{
"data": [
{
"id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
"identifier": "PPO9876543210",
"external_reference": "PED-2026-0001",
"status": "PAID",
"type": "BILLING",
"payment_method": "PIX",
"installments": 1,
"total_amount": 197,
"cycle": 1,
"paid_at": "2026-01-20T14:32:10.000Z",
"refund_at": null,
"created_at": "2026-01-20T14:30:00.000Z",
"customer": {
"id": "e6f7a8b9-c0d1-4e2f-3a4b-5c6d7e8f9a0b",
"name": "Maria Souza",
"email": "maria@exemplo.com",
"document": "***.456.***-**",
"phone": "****4321",
"is_active": true,
"created_at": "2026-01-05T08:00:00.000Z"
},
"items": [
{
"quantity": 1,
"amount": 197,
"original_amount": 197,
"discount_value": 0,
"offer": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"identifier": "PPP1234567890",
"title": "Plano Mensal"
},
"product": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "Curso de Marketing Digital",
"type": "DIGITAL"
}
}
],
"shipping": {
"amount": 32.9,
"option_name": "SEDEX",
"address": {
"street": "Rua das Flores",
"number": "123",
"complement": "Apto 4B",
"neighborhood": "Centro",
"city": "São Paulo",
"state": "SP",
"postal_code": "01311000"
}
},
"payment_details": {
"qr_code": "00020126...",
"qr_code_expires_at": "2019-08-24T14:15:22Z",
"billet_barcode": "34191.79001 01043.510047 91020.150008 1 96610000015000",
"billet_link": "https://boletos.pagpolar.com/a1b2c3d4.pdf",
"last_credit_card_digits": "4242"
}
}
],
"meta": {
"page": 1,
"per_page": 25,
"total": 143,
"total_pages": 6
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"request_id": "string"
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"request_id": "string"
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"request_id": "string"
}
}Consultar venda GET
Aceita três formas de referência, testadas nesta ordem: o `id` da venda (uuid, o mesmo que volta em `transactions` na criação do pagamento), o código da venda e a `external_reference` que você enviou no pedido. O valor só é tratado como código quando tem o formato do código: 10 dígitos, com ou sem o prefixo (ex.: `PPO0087103960`), ou um link terminado nele. Se a mesma `external_reference` foi usada em mais de um pedido, volta a venda mais recente.
Reembolsos
Liste os pedidos de reembolso e peça o reembolso de uma venda.