Skip to main content
POST
/
v1
/
charge
Create a new charge
curl --request POST \
  --url https://sandbox.api.veepag.com/v1/charge \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "companyId": "company_id",
  "clientId": "client_id",
  "productId": "product_id",
  "dueDate": "2026-07-23",
  "amount": 99.9,
  "description": "Mensalidade julho"
}
'
{
  "_id": "charge_id",
  "companyId": "company_id",
  "amount": 9990,
  "status": "ACTIVE"
}

Authorizations

apiKey
string
header
required

API key no formato keyId.secret.

Body

application/json
companyId
string
required
clientId
string
required
productId
string
required
dueDate
any
required
amount
number
required
paymentMethodOption
object[]
description
string
cardAuth
boolean | null

Response

Cobranca criada.

_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>