Consultar o saldo do seller.
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.
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.
Autorização
ApiKeyAuth Em: header
Corpo da resposta
application/json
application/json
application/json
curl -X GET "https://example.com/balance"{ "object": "balance", "pending_cents": 0, "available_cents": 0, "reserved_cents": 0, "requestable_cents": 0, "reserve_held_cents": 0, "clawback_held_cents": 0, "held_back_cents": 0, "payout_blocked_by_kyc": true, "currency": "BRL", "request_id": "req_xxx"}Estornar uma cobrança paga. POST
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.
Listar o histórico (ledger) do saldo do seller. GET
Lista as transações de saldo (lançamentos do ledger) com escopo do tenant para uma API key com escopo de seller, das mais recentes para as mais antigas. Exige a permissão balance:read e uma key com escopo de seller.