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"

Para clientes PSP, desde 12/09/2022, sempre que uma charge sofre uma ação de chargeback, a nossa API modifica o estado da charge para chargedback.

Com intuito de aumentar a visibilidade sobre as suas transações, a partir de 27 de julho de 2026 o status chargedback também passará a ser retornado para clientes Gateway, exclusivamente para cobranças capturadas pela adquirência Stone.

Para mais informações acesse: Novo status chargeback

AtributosTipoDescrição
idstringCódigo da cobrança. Formato: ch_XXXXXXXXXXXXXXXX.
codestringCódigo identificador da cobrança no sistema da loja.
gateway_idstringCódigo da cobrança no gateway de pagamento.
amountintegerValor da cobrança.
payment_methodstringMeio de pagamento.
statusstringStatus da cobrança. Valores possíveis: pending, paid, canceled, processing, failed, overpaid ou underpaid e chargedback
due_atdatetimeData de vencimento da cobrança.
created_atdatetimeData de criação da cobrança (UTC).
updated_atdatetimeData de atualização da cobrança (UTC).
customerobjectDados do cliente. Saiba mais sobre clientes.
invoiceobjectDados da fatura. Saiba mais sobre faturas.
last_transactionobjectInformações sobre a última transação da cobrança.
metadataobjectObjeto chave/valor utilizado para armazenar informações adicionais sobre a cobrança. Saiba mais sobre metadata.