Skip to main content
POST
Create a new charge

Authorizations

apiKey
string
header
required

API key no formato keyId.secret.

Body

application/json
companyId
string
required

ID da empresa da cobranca.

clientId
string
required

ID do cliente que recebera a cobranca.

productId
string
required

ID do produto vinculado a cobranca.

dueDate
any
required

Data de vencimento da cobranca.

amount
number
required

Valor decimal da cobranca. O backend converte internamente para centavos com Math.round(amount * 100).

paymentMethodOption
object[]

Opcoes de pagamento disponiveis para a cobranca.

description
string

Descricao da cobranca.

cardAuth
boolean | null

Indica uso de autorizacao de cartao, quando aplicavel.

Response

Cobranca criada.

_id
string

ID da cobranca.

companyId
string

ID da empresa vinculada a cobranca.

clientId
string

ID do cliente vinculado.

productId
string

ID do produto vinculado.

subscriptionId
string

ID da assinatura vinculada, quando houver.

amount
number

Valor da cobranca, normalmente com value em centavos e currency BRL.

dueDate

Data de vencimento da cobranca.

description
string

Descricao da cobranca.

status
enum<string>

Status atual da cobranca.

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>

Metodos de pagamento disponiveis.

Available options:
CREDIT_CARD,
DEBIT_CARD,
BOLETO,
PIX
paymentMethodOption
object[]

Opcoes de pagamento da cobranca.

active
boolean

Indica se a cobranca esta ativa.

number
number

Numero sequencial da cobranca, quando houver.

createdAt
string<date-time>

Data de criacao da cobranca.

lastUpdate
string<date-time>

Data da ultima atualizacao da cobranca.