Lista os movimentos do saldo
/v1/balance/historyAutentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.
Parâmetros de consulta
limitintegerTamanho da página (itens por página).
offsetintegerPosição do primeiro item (a partir de 0).
sortstringExpressão de ordenação, ex.: "-createdAt"
daterangeum deCriados neste dia (
YYYY-MM-DD) ou neste instante.daterangegtstring (date-time)Criados depois deste instante (exclusivo).
daterangegtestring (date-time)Criados a partir deste instante (inclusivo).
daterangeltstring (date-time)Criados antes deste instante (exclusivo).
daterangeltestring (date-time)Criados até este instante (inclusivo).
bucketstringavailable: só os movimentos que mudaram o saldo disponível (o extrato). Omita para todos os movimentos entre baldes.Valores:availabledirectionstringEntrada (
credit) ou saída (debit) do saldo disponível. Implicabucket=available.Valores:creditdebittypestringTipos de movimento separados por vírgula (receivableScheduled, receivableReleased, receivableChargeback, receivableDispute, receivableRefunded, receivableCanceled, receivableSettledExternally, warrantyHeld, warrantyReleased, warrantyCover, chargebackFee, chargebackFeeRefund, antifraudFee, withdrawalFee, withdrawal, withdrawalReversal, appUsageCharge, productSubscription, debtSettlement, debtSettlementRefund, receivableAnticipated, anticipationFee, adjustment, other).
Respostas
200Sucesso
dataobject[]obrigatórioOs itens desta página.
+16 campos de
dataidintegerobrigatórioId sequencial do movimento.
notestringobrigatóriopode ser nuloTexto escrito para você num ajuste manual, ou a descrição da fatura paga com o saldo;
nullnos demais.typestringobrigatórioO que o movimento foi, como slug estável (
receivableReleased,withdrawal,chargebackFee…) — o campo para tratar no seu sistema.amountintegerobrigatóriopode ser nuloEfeito no saldo DISPONÍVEL, em centavos e com sinal: positivo entrou, negativo saiu, 0 não mexeu nele;
nullem movimentos antigos.sourceobjectobrigatóriopode ser nuloO objeto por trás do movimento, para abrir o detalhe;
nullem movimentos sem origem registrada.+2 campos de
sourceidstringobrigatórioId público da origem.
objectstringobrigatórioTipo da origem (ex.:
transaction,withdrawal).Valores:transactionreceivablewithdrawalinvoicedebtSettlementanticipation
toTypestringobrigatóriopode ser nuloO balde em que o dinheiro entrou;
nullquando saiu do saldo.categorystringobrigatóriopode ser nuloCategoria de um ajuste manual feito pela Selectwin;
nullnos movimentos automáticos.fromTypestringobrigatóriopode ser nuloO balde de onde o dinheiro saiu (
available,pending,blocked…);nullquando veio de fora.createdAtstringobrigatórioQuando o recurso foi criado (ISO 8601, UTC).
directionstringobrigatóriopode ser nulocreditentrou no saldo disponível,debitsaiu;nullquandoamounté 0 ounull.Valores:creditdebithandledBystringobrigatóriopode ser nuloNome interno do que movimentou o dinheiro — prefira
type.newBalanceobjectobrigatórioO saldo depois do movimento.
+4 campos de
newBalanceblockedBalanceintegerobrigatórioO que está retido (disputas, análise de fraude, retenção da Selectwin), em centavos.
pendingBalanceintegerobrigatórioO que aguarda a data de liberação, em centavos.
refundedBalanceintegerobrigatórioO que foi estornado a compradores, em centavos.
availableBalanceintegerobrigatórioO que você pode sacar agora, em centavos.
oldBalanceobjectobrigatórioO saldo antes do movimento.
+4 campos de
oldBalanceblockedBalanceintegerobrigatórioO que está retido (disputas, análise de fraude, retenção da Selectwin), em centavos.
pendingBalanceintegerobrigatórioO que aguarda a data de liberação, em centavos.
refundedBalanceintegerobrigatórioO que foi estornado a compradores, em centavos.
availableBalanceintegerobrigatórioO que você pode sacar agora, em centavos.
descriptionstringobrigatórioO mesmo, em português, pronto para a linha do extrato.
availableAfterintegerobrigatóriopode ser nuloO saldo disponível depois deste movimento, em centavos.
processedAmountintegerobrigatórioValor movimentado, em centavos.
pageobjectobrigatórioCursores de paginação da lista.
+3 campos de
pagetotalintegerobrigatórioNúmero total de páginas.
offsetobjectobrigatórioO
offsetpara pedir a primeira, a anterior, a próxima e a última página.+4 campos de
offsetlastintegerobrigatórioPosição da última página.
nextintegerobrigatórioPosição da próxima página (fica nesta quando ela é a última).
previntegerobrigatórioPosição da página anterior (0 na primeira).
firstintegerobrigatórioPosição da primeira página.
currentintegerobrigatórioNúmero da página atual (a primeira é 1).
limitintegerobrigatórioTamanho da página, como pedido.
totalintegerobrigatórioNúmero total de itens que atendem aos filtros.
_linksobjectLinks para operações relacionadas, por ação (
self,create,update,delete,list…).offsetintegerobrigatórioPosição do primeiro item desta página, como pedido.
hasMorebooleanobrigatóriotruequando há mais itens depois desta página.merchantobjectA conta dona do recurso (o vendedor de registro).
+3 campos de
merchantnamestringobrigatóriopode ser nuloNome fantasia da conta dona do recurso.
merchantIdstringobrigatóriopode ser nuloId público da conta dona do recurso (
bus_…).isSubAccountbooleanobrigatóriotruequando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
401Não autenticado (credencial ausente ou inválida)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
403Sem permissão
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
500Erro interno do servidor
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório