Skip to main content
POST
Requer o header account com o código da conta. Passa por validações de fraude, bloqueio de clientes e rate limiting por cliente.
Clientes bloqueados por IP, e-mail, CPF ou BIN do cartão terão a cobrança rejeitada automaticamente.
Para cobrar um cartão já salvo, envie apenas payment.card.card_token (o token retornado ao salvar o cartão / no evento card.token_created) no lugar dos dados completos do cartão. Continue enviando payment.card.installments. O card_token só é aceito para cartões da mesma conta da cobrança.
O billing address do cartão não é tokenizado. Ao cobrar com card_token, informe o billing address (client.address) na própria requisição.

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"

Body

application/json
client
object
required
payment
object
required
items
object[]
required

Lista de itens da compra (obrigatório, mín. 1 item)

Example:
international
boolean | null

Indica se é uma transação internacional (opcional, padrão false)

Example:

false

Response

Cobrança processada com sucesso

Resposta da criação de cobrança (envelope APIReturnUtil + dados ConsultCharge)

mensagem
string
Example:

"Cobrança realizada com sucesso."

erro
boolean
Example:

false

mensagenserro
string[]
Example:
codigoretorno
integer
Example:

201

id
string

ID da cobrança criada

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

data
object

Dados completos de uma cobrança retornados pelo ConsultCharge