Estornar uma cobrança paga.
Estorna uma cobrança paga ou parcialmente estornada. Omita amount_cents para estornar o saldo restante. O status do refund é processing, succeeded ou failed: processing significa que a adquirente aceitou o pedido e o desfecho chega depois, em minutos, pelos eventos refund.succeeded/refund.failed — nenhum dinheiro voltou ainda e o valor fica reservado na cobrança, então não reenvie o estorno. Os eventos saem na ordem refund.created, depois refund.succeeded ou refund.failed, e junto do sucesso o charge.refunded.
Estorna uma cobrança paga ou parcialmente estornada. Omita amount_cents para estornar o saldo restante. O status do refund é processing, succeeded ou failed: processing significa que a adquirente aceitou o pedido e o desfecho chega depois, em minutos, pelos eventos refund.succeeded/refund.failed — nenhum dinheiro voltou ainda e o valor fica reservado na cobrança, então não reenvie o estorno. Os eventos saem na ordem refund.created, depois refund.succeeded ou refund.failed, e junto do sucesso o charge.refunded.
Autorização
ApiKeyAuth Em: header
Parâmetros de caminho
^ch_[A-Za-z0-9]+$Parâmetros de cabeçalho
1 <= length <= 255Corpo da requisição
application/json
Definições TypeScript
Use o tipo request body em TypeScript.
Corpo da resposta
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/charges/ch_xxx/refund" \ -H "Idempotency-Key: order_123_attempt_1" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "object": "refund", "status": "pending", "charge_id": "string", "amount_cents": 1, "currency": "BRL", "reason": "string", "provider_reference": "string", "succeeded_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "request_id": "req_xxx"}Dividir uma cobrança já paga. POST
Escreve — ou substitui — a divisão (split) de uma cobrança que já está PAGA: a comissão combinada depois da venda, ou a correção, naquela venda, do que a regra de split aplicou. Vale somente até 23:59:59.999 (America/Sao_Paulo) do dia em que a cobrança foi paga e enquanto nenhum recebível dela foi liquidado, antecipado, cedido, cancelado ou entrou em repasse: a chamada RELIQUIDA a venda inteira, reprecificando o lojista que vendeu sobre a venda menos a nova fatia. Os recebedores precisam ser estabelecimentos ativos da mesma white label e nunca podem ser o próprio lojista da venda, que fica com o restante. Exige a permissão charges:split.
Consultar o saldo do seller. GET
Retorna o saldo pendente, disponível, reservado e passível de solicitação para uma API key com escopo de seller, com o detalhamento do que está retido: reserve_held_cents (rolling reserve, que não entra em pending_cents/available_cents e volta ao saldo na liberação), clawback_held_cents (retido por dívida de chargeback/estorno) e held_back_cents (total retido do liberado = available_cents − requestable_cents). Exige a permissão balance:read e uma key com escopo de seller.