Skip to main content
GET
/
v1
/
charge
/
exports
Exportar cobranças
curl --request GET \
  --url https://sandbox.api.veepag.com/v1/charge/exports \
  --header 'apiKey: <api-key>'
[]

Authorizations

​
apiKey
string
header
required

API key no formato keyId.secret.

Query Parameters

​
rangeTime.end
string<date-time>

Range end (ISO string). Used with sort.property.

Example:

"2026-06-23T23:59:59.999Z"

​
rangeTime.start
string<date-time>

Range start (ISO string). Used with sort.property.

Example:

"2026-06-01T00:00:00.000Z"

​
sort.order
enum<string>
default:desc

Sort direction (asc|desc)

Available options:
asc,
desc
Example:

"desc"

​
sort.property
enum<string>
default:createdAt

Range field (createdAt|lastUpdate)

Available options:
createdAt,
lastUpdate
Example:

"createdAt"

​
status
any[]

Charge status (multiple values allowed)

​
clientId
string

Client ID

​
productId
string

Product ID

​
subscriptionId
string

Subscription ID

​
ids
any[]

Charge IDs (multiple values allowed)

​
id
string

Charge ID

Response

Cobrancas exportadas.

​
_id
string
​
companyId
string
​
clientId
string
​
productId
string
​
subscriptionId
string
​
amount
number
​
dueDate
​
description
string
​
status
enum<string>
Available options:
PAID,
ACTIVE,
ANTICIPATED,
CANCELED,
CANCELED_ALERT_ETHOCA,
PENDING_PAYMENT,
IMPORTED,
ERROR_PAYMENT,
ERROR_REFUNDED,
OVERDUE,
NO_PAYMENT_ROUTE,
RECOVERED,
BLOCKED,
NO_PAYMENT,
CANCELED_MANUAL,
DISPUTE,
CHARGEBACK,
STANDBY,
DISABLED
​
paymentMethod
enum<string>
Available options:
CREDIT_CARD,
DEBIT_CARD,
BOLETO,
PIX
​
paymentMethodOption
object[]
​
active
boolean
​
number
number
​
createdAt
string<date-time>
​
lastUpdate
string<date-time>