Créditos e saldo

Sua agência opera com uma carteira pré-paga. Cada ativação debita o saldo; as recargas o creditam.

Saldo atual

GET /current-balance retorna o saldo disponível.

bash

curl --request GET \
  --url 'https://portal.woo-fi.com/api/webservice/v2/current-balance' \
  --header 'Authorization: Bearer {seu-token}'

json

{ "current_balance": 8661.15 }

Confira o saldo antes de ativar

Criar uma ativação debita o valor do pedido. Sem saldo suficiente, a criação é recusada com 422 (Saldo insuficiente.).

Como o saldo se movimenta

Movimento	Efeito
Recarga (Stripe / Ebanx)	Crédito.
Criar ativação	Débito automático do valor do pedido.
Cancelar ativação	Estorno (volta para a carteira).

Histórico de recargas

GET /credit-history lista as recargas (id, created_at, amount, status, gateway):

json

[ { "id": 1201, "created_at": "2026-07-16 18:21:00", "amount": 5.0, "status": "Aprovado", "gateway": "Stripe" } ]

Extrato de vendas e débitos

GET /statement retorna vendas e débitos do período, com summary, data e meta (paginação):

bash

curl --request GET \
  --url 'https://portal.woo-fi.com/api/webservice/v2/statement?initial_date=2026-07-01&final_date=2026-07-31' \
  --header 'Authorization: Bearer {seu-token}'

Parâmetro	Formato	Descrição
`initial_date`	`AAAA-MM-DD`	Início do período (opcional).
`final_date`	`AAAA-MM-DD`	Fim do período (opcional).
`status`	—	Filtro (ex.: `Aprovado`, `all`). Opcional.
`per_page`	Número	Itens por página (opcional).

json

{
  "summary": { "total_sales_count": 2, "total_sales_amount": 135.0, "period_start": "2026-07-01", "period_end": "2026-07-31" },
  "data": [ { "id": 1541, "order_id": 3021, "date": "2026-07-26T10:15:00-03:00", "amount": 45.0, "status": "Aprovado" } ],
  "meta": { "current_page": 1, "per_page": 15, "total": 2, "last_page": 1 }
}

Adicionar crédito

POST /charge gera uma cobrança. O payment_type escolhe o gateway (stripe ou ebanx). No Ebanx, o campo method é obrigatório e define a forma de pagamento: pix ou creditcard. No Stripe, method não se aplica.

bash

curl --request POST \
  --url 'https://portal.woo-fi.com/api/webservice/v2/charge' \
  --header 'Authorization: Bearer {seu-token}' \
  --header 'Content-Type: application/json' \
  --data '{ "payment_type": "stripe", "amount": 100, "instalments": 1 }'

Campo	Tipo	Obrigatório	Descrição
`payment_type`	String	Sim	`stripe` ou `ebanx`.
`amount`	Number	Sim	Valor da recarga (respeita o mínimo do gateway).
`instalments`	Number	Não	Parcelas (1 a 12).
`method`	String	Não	Ebanx: `pix` ou `creditcard` (obrigatório no Ebanx).
`card_name`, `card_number`, `card_expiry`, `card_cvv`	String	Não	Dados do cartão (Ebanx `creditcard`).

Para Stripe, a resposta traz o link de checkout:

json

{ "stripe_url": "https://checkout.stripe.com/pay/cs_test_..." }

Para Ebanx, a resposta traz charge_id, status, redirect_url e pix_qr_code.

Cartões de teste (Sandbox)

No ambiente Sandbox, use estes cartões para simular um pagamento com cartão de crédito:
- Stripe: 4242 4242 4242 4242
- Ebanx: 4111 1111 1111 1111

Use uma data de validade futura e qualquer CVV. Em produção, use dados reais.

Confirmando um pagamento Stripe

Recupere o id da última sessão com GET /charge/stripe/last-id ({ "payment_id": "cs_..." }) e confirme com GET /charge/stripe/check-success?session_id={cs_...}:

json

{ "status": true }

O saldo entra após a aprovação

O crédito só aparece em current-balance depois que o pagamento é aprovado.

Próximos passos

Com saldo, siga para o Ciclo de uma ativação.
Veja Current Balance e Create Charge na referência.