PrismaPay
  1. Faturas
PrismaPay
  • Começe por Aqui
  • Autenticação
    • Auth
      GET
    • Status Credencial
      GET
  • Consumidores
    • Lista Consumidores
      GET
  • Faturas
    • Cartão de Crédito
    • Criar Fatura
      POST
    • Adicionar Tracking Code
      POST
    • Listar Mediações
      GET
    • Listar Chargebacks
      GET
    • Atualizar Vencimento
      PATCH
    • Lista Faturas
      GET
    • Cancelar Fatura
      DELETE
    • Estornar Fatura
      PUT
  • Webhooks
    • Exemplos de Webhooks
    • Validar Webhook Recebido
      OPTIONS
    • Reenviar Webhook
      COPY
  • BAAS
  1. Faturas

Lista Faturas

GET
/invoices
Neste endpoint, você consulta todas as faturas, separados por paginação com limite de 100 faturas por página.
Use o parâmetro p com a numeração da página.
Use o parâmetro id com o id da fatura para obter os detalhes.
Use o parâmetro status para obter as faturas com base no status.
Não use este endpoint para consultar demasiadamente os status da fatura, pois irá ser bloqueado pelo nosso firewall por RATE-LIMIT
Utilize este endpoint apenas para CONTINGÊNCIA. Nos demais, utilize a notificação via Webhook para essa atualização interna.

STATUS DA FATURA#

STATUS (code)Descrição
1Aguardando Pagamento
2Em Processamento
3Pagamento Agendado
4Autorizado
5Pago
6Cancelado
7Aguardando Estorno
8Parcialmente Estornado
9Estornado
10Contestado/Em Contestação
12Pagamento Negado
15Pagamento Vencido
16Erro no Pagamento

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros de Consulta

Respostas

🟢200200 - Sucesso
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.prismapayment.com.br/invoices?p=5&id=123&status=5' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
    "pages": {
        "now": 1,
        "total": 1
    },
    "total": {
        "invoices": 1,
        "per_page": 100
    },
    "invoices": [
        {
            "id": "17014069781",
            "date": "2023-12-01 06:02:58",
            "status": {
                "code": 1,
                "title": "Aguardando Pagamento!",
                "description": "realize o pagamento o quanto antes para garantir o seu produto."
            },
            "customer": 17014007321,
            "prices": {
                "total": 1200,
                "discount": 0,
                "taxs": {
                    "others": 0
                },
                "refound": null
            },
            "type": {
                "id": 3,
                "title": "PIX"
            },
            "payment": {
                "gateway": "",
                "date": null,
                "card": null
            }
        }
    ]
}
Modificado em 2025-10-31 15:46:39
Página anterior
Atualizar Vencimento
Próxima página
Cancelar Fatura
Built with