Skip to main content
PUT
/
v1
/
charge
Atualizar cobrança
curl --request PUT \
  --url https://sandbox.api.veepag.com/v1/charge \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "_id": "<string>",
  "companyId": "<string>",
  "productId": "<string>",
  "dueDate": "<unknown>",
  "amount": 123,
  "description": "<string>",
  "paymentMethodOption": [
    {
      "active": true,
      "installments": [
        {
          "installment": 123,
          "totalAmount": 123,
          "installmentAmount": 123,
          "fee": 123
        }
      ]
    }
  ]
}
'
{
  "_id": "charge_id",
  "amount": 9990
}

Authorizations

apiKey
string
header
required

API key no formato keyId.secret.

Body

application/json
_id
string
required
Minimum string length: 1
companyId
string
Minimum string length: 1
productId
string
Minimum string length: 1
dueDate
any
amount
number
description
string
paymentMethodOption
object[]

Response

Cobranca atualizada.

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