> ## Documentation Index
> Fetch the complete documentation index at: https://docs.4seletpay.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# Listar Cobranças
> Retorna a lista paginada de cobranças da conta informada no header `account`. A resposta segue o formato padrão de paginação do Laravel (não é envelopada pelo formato APIReturnUtil).
Requer o header `account` com o código da conta. Retorna lista paginada das cobranças no formato padrão do paginador Laravel (diferente do envelope `APIReturnUtil` das demais rotas).
## OpenAPI
````yaml GET /v1/charge
openapi: 3.1.0
info:
title: 4Selet Pay API
description: >
API de processamento de pagamentos da plataforma 4Selet Pay. Suporta
cobranças únicas, assinaturas recorrentes, PIX, Cartão de Crédito. Todas as
rotas autenticadas requerem um Bearer Token obtido via `/v1/login`.
version: 1.0.0
contact:
name: 4Selet Pay
email: suporte@4selet.com.br
servers:
- url: https://sandbox.4seletpay.com.br/api
description: Servidor de Sandbox
security:
- bearerAuth: []
tags:
- name: Autenticação
description: Rotas de autenticação e criação de usuários
- name: Cobranças
description: Criação, consulta, cancelamento e reembolso de cobranças
- name: Pedidos
description: Consulta de pedidos e gerenciamento de confirmações desafiadas
- name: Assinaturas
description: Criação e gerenciamento de assinaturas recorrentes
- name: Faturas
description: Gerenciamento de faturas e pagamento de faturas em atraso
- name: Clientes Bloqueados
description: Gerenciamento de lista negra de clientes
- name: Contas
description: Criação e gerenciamento de contas na plataforma
- name: Aplicativo
description: Endpoints para dashboard e uso via aplicativo mobile
- name: Notificações Push
description: Envio e gerenciamento de notificações push
- name: Utilitários
description: Endpoints utilitários como listagem de fusos horários
- name: Gestão
description: Relatórios gerenciais (acesso restrito a Super Admins)
- name: Webhooks
description: Endpoints para receber notificações de gateways de pagamento
- name: Endpoints de Webhook
description: >-
Gerenciamento de endpoints de webhook para receber notificações de eventos
da plataforma
- name: Links de Pagamento
description: Criação e gerenciamento de links de pagamento com checkout pré-configurado
paths:
/v1/charge:
get:
tags:
- Cobranças
summary: Listar cobranças
description: >
Retorna a lista paginada de cobranças da conta informada no header
`account`. A resposta segue o formato padrão de paginação do Laravel
(não é envelopada pelo formato APIReturnUtil).
operationId: listCharges
parameters:
- $ref: '#/components/parameters/AccountHeader'
- name: page
in: query
required: false
description: Número da página (gerenciado automaticamente pelo paginador Laravel)
schema:
type: integer
default: 1
example: 1
- name: per_page
in: query
required: false
description: Quantidade de itens por página
schema:
type: integer
default: 10
example: 10
- name: search
in: query
required: false
description: Texto para busca nos campos da listagem
schema:
type: string
example: joao
- name: id
in: query
required: false
description: Filtrar por ID específico da cobrança
schema:
type: string
example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
- name: with_trashed
in: query
required: false
description: Incluir registros soft-deleted (1 = sim, 0 = não)
schema:
type: integer
enum:
- 0
- 1
default: 0
example: 0
- name: trashed_only
in: query
required: false
description: Retornar apenas registros soft-deleted (1 = sim, 0 = não)
schema:
type: integer
enum:
- 0
- 1
default: 0
example: 0
responses:
'200':
description: Lista de cobranças retornada com sucesso
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedChargesResponse'
'401':
$ref: '#/components/responses/Unauthorized'
security:
- bearerAuth: []
components:
parameters:
AccountHeader:
name: account
in: header
required: true
description: Código da conta à qual a operação se aplica
schema:
type: string
example: acc_abc123xyz
schemas:
PaginatedChargesResponse:
type: object
description: Resposta paginada de cobranças (formato padrão do paginador Laravel)
properties:
current_page:
type: integer
example: 1
data:
type: array
items:
$ref: '#/components/schemas/ChargeListItem'
first_page_url:
type: string
example: https://app.4seletpay.com.br/api/v1/charge?page=1
from:
type: integer
nullable: true
example: 1
last_page:
type: integer
example: 5
last_page_url:
type: string
example: https://app.4seletpay.com.br/api/v1/charge?page=5
links:
type: array
items:
type: object
properties:
url:
type: string
nullable: true
label:
type: string
active:
type: boolean
next_page_url:
type: string
nullable: true
example: https://app.4seletpay.com.br/api/v1/charge?page=2
path:
type: string
example: https://app.4seletpay.com.br/api/v1/charge
per_page:
type: integer
example: 10
prev_page_url:
type: string
nullable: true
example: null
to:
type: integer
nullable: true
example: 10
total:
type: integer
example: 72
ChargeListItem:
type: object
description: Item da listagem de cobranças (campos flat retornados pelo paginador)
properties:
code:
type: string
description: Código da cobrança
example: chg_abc123
status:
type: string
description: Status da cobrança
enum:
- Pending
- Challenged
- Approved
- Declined
- Refunded
- Canceled
example: Approved
value:
type: number
format: float
description: Valor da cobrança
example: 199.8
payment_type:
type: string
description: Tipo de pagamento
enum:
- CreditCard
- PIX
example: CreditCard
installments:
type: integer
description: Número de parcelas
example: 1
expiration:
type: string
nullable: true
description: Data/hora de expiração do pagamento (PIX)
example: null
payment_code:
type: string
nullable: true
description: Código do pagamento no gateway
example: null
payment_copy_paste:
type: string
nullable: true
description: Código copia e cola do PIX
example: null
order_code:
type: string
description: Código do pedido associado
example: ord_abc123xyz
order_status:
type: string
description: Status do pedido
enum:
- Pending
- Challenged
- Approved
- Declined
- Refunded
- Canceled
example: Approved
coin:
type: string
description: Moeda
example: BRL
purchase_status:
type: string
description: Código da compra (purchase code)
example: pur_abc123xyz
ErrorResponse:
type: object
properties:
mensagem:
type: string
example: Um erro inesperado acabou de acontecer.
erro:
type: boolean
example: true
mensagenserro:
type: array
items:
type: string
example:
- Detalhe do erro ocorrido.
codigoretorno:
type: integer
example: 400
id:
type: string
example: 00000000-0000-0000-0000-000000000000
data:
type: array
example: []
responses:
Unauthorized:
description: Não autorizado — token inválido ou ausente
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
mensagem: Unauthenticated.
erro: true
mensagenserro: []
codigoretorno: 401
id: 00000000-0000-0000-0000-000000000000
data: []
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
Token JWT obtido via `POST /v1/login`. Envie no header `Authorization:
Bearer `.
````