Skip to main content
GET
/
v1
/
charge
Listar cobranças
curl --request GET \
  --url https://hml.4seletpay.com.br/api/v1/charge \
  --header 'Authorization: Bearer <token>' \
  --header 'account: <account>'
{
  "current_page": 1,
  "data": [
    {
      "code": "chg_abc123",
      "status": "Approved",
      "value": 199.8,
      "payment_type": "CreditCard",
      "installments": 1,
      "expiration": null,
      "payment_code": null,
      "payment_copy_paste": null,
      "order_code": "ord_abc123xyz",
      "order_status": "Approved",
      "type": "PurchaseOrder",
      "cycle_type": "Only",
      "cycle": 1,
      "coin": "BRL",
      "purchase_status": "pur_abc123xyz"
    }
  ],
  "first_page_url": "https://app.4seletpay.com.br/api/v1/charge?page=1",
  "from": 1,
  "last_page": 5,
  "last_page_url": "https://app.4seletpay.com.br/api/v1/charge?page=5",
  "links": [
    {
      "url": "<string>",
      "label": "<string>",
      "active": true
    }
  ],
  "next_page_url": "https://app.4seletpay.com.br/api/v1/charge?page=2",
  "path": "https://app.4seletpay.com.br/api/v1/charge",
  "per_page": 10,
  "prev_page_url": null,
  "to": 10,
  "total": 72
}
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).

Authorizations

​
Authorization
string
header
required

Token JWT obtido via POST /v1/login. Envie no header Authorization: Bearer <token>.

Headers

​
account
string
required

Código da conta à qual a operação se aplica

Example:

"acc_abc123xyz"

Query Parameters

​
page
integer
default:1

Número da página (gerenciado automaticamente pelo paginador Laravel)

Example:

1

​
per_page
integer
default:10

Quantidade de itens por página

Example:

10

​
search
string

Texto para busca nos campos da listagem

Example:

"joao"

​
id
string

Filtrar por ID específico da cobrança

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
with_trashed
enum<integer>
default:0

Incluir registros soft-deleted (1 = sim, 0 = não)

Available options:
0,
1
Example:

0

​
trashed_only
enum<integer>
default:0

Retornar apenas registros soft-deleted (1 = sim, 0 = não)

Available options:
0,
1
Example:

0

Response

Lista de cobranças retornada com sucesso

Resposta paginada de cobranças (formato padrão do paginador Laravel)

​
current_page
integer
Example:

1

​
data
object[]
​
first_page_url
string
Example:

"https://app.4seletpay.com.br/api/v1/charge?page=1"

​
from
integer | null
Example:

1

​
last_page
integer
Example:

5

​
last_page_url
string
Example:

"https://app.4seletpay.com.br/api/v1/charge?page=5"

​
links
object[]
​
next_page_url
string | null
Example:

"https://app.4seletpay.com.br/api/v1/charge?page=2"

​
path
string
Example:

"https://app.4seletpay.com.br/api/v1/charge"

​
per_page
integer
Example:

10

​
prev_page_url
string | null
Example:

null

​
to
integer | null
Example:

10

​
total
integer
Example:

72