Cobranças

Para realizar cobranças de cartão de crédito ou boleto, você deve criar um objeto charge. Este objeto tem os seguintes atributos:

🚧

Novo status "chargedback"

Com intuito de aumentar a visibilidade sobre as suas transações, a partir do dia 12/09/2022, sempre que uma charge sofrer uma ação de chargeback, a nossa API vai passar a modificar o estado da charge para chargedback.

Essa funcionalidade só irá existir para clientes na integração PSP (subadiquirência). Para integrações do tipo Gateway, não é possível termos essa informação.

Para mais informações acesse: Novo status chargeback

Atributos

Tipo

Descrição

id

string

Código da cobrança. Formato: ch_XXXXXXXXXXXXXXXX.

code

string

Código identificador da cobrança no sistema da loja.

gateway_id

string

Código da cobrança no gateway de pagamento.

amount

integer

Valor da cobrança.

payment_method

string

Meio de pagamento.

status

string

Status da cobrança. Valores possíveis: pending, paid, canceled, processing, failed, overpaid ou underpaid e chargedback

due_at

datetime

Data de vencimento da cobrança.

created_at

datetime

Data de criação da cobrança.

updated_at

datetime

Data de atualização da cobrança.

customer

object

Dados do cliente. Saiba mais sobre clientes.

invoice

object

Dados da fatura. Saiba mais sobre faturas.

last_transaction

object

Informações sobre a última transação da cobrança.

metadata

object

Objeto chave/valor utilizado para armazenar informações adicionais sobre a cobrança. Saiba mais sobre metadata.