Créditos e saldo

Sua agência opera com uma carteira pré-paga. Cada ativação debita o saldo automaticamente, e as recargas o creditam. Este guia mostra como consultar o saldo, ver o histórico e adicionar crédito.

Saldo atual

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

bash

curl --request GET \
  --url 'https://portal.woo-fi.com/api/webservice/v1/current-balance' \
  --header 'Accept: application/json' \
  --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 na carteira. Mantenha saldo suficiente para não bloquear novas ativações.

Como o saldo se movimenta

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

Histórico de recargas

GET /credit-history lista as recargas da carteira, com data, valor, situação e método:

bash

curl --request GET \
  --url 'https://portal.woo-fi.com/api/webservice/v1/credit-history' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {seu-token}'

json

[
  { "date": "16/11/2023 18:21", "value": "5.00", "approved": "Não aprovado", "type": "Stripe" }
]

Extrato de vendas e débitos

GET /credit-statement retorna os débitos de ativações e as vendas do período. Informe o intervalo pela query:

bash

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

Parâmetro	Formato	Descrição
`initial_date`	`AAAA-MM-DD`	Início do período.
`final_date`	`AAAA-MM-DD`	Fim do período.

json

[
  {
    "idCharge": 1541,
    "idOrder": 3021,
    "date": "26/07/2026 10:15",
    "value": "45.00",
    "description": "Débito ref. Ativação de Pedido #3021",
    "status": "Aprovado"
  }
]

Adicionar crédito

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

bash

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

Campo	Tipo	Obrigatório	Descrição
`typePayment`	String	Sim	Gateway: `stripe` ou `ebanx`.
`price`	Number	Sim	Valor da recarga (respeita o mínimo do gateway).
`instalments`	String	Não	Parcelas.
`type`	String	Não	Ebanx: `pix` ou `creditcard` (obrigatório no Ebanx).
`card_name`, `card_number`, `expiration`, `card_cvv`	String	Não	Dados do cartão (Ebanx `creditcard`).

Para Stripe, a resposta traz o link de checkout em stripe_url:

json

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

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

Não trafegue dados de cartão sem necessidade

Envie card_number, card_cvv e afins apenas no Ebanx com type = creditcard. Para Pix, esses campos ficam vazios e o valor é pago pelo QR/checkout do gateway.

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

O pagamento Stripe é concluído fora da API, no link de checkout. Você confirma o resultado consultando a sessão de checkout pelo seu session_id — o valor cs_... que aparece na URL retornada pelo charge.

Se precisar recuperar o id da última sessão criada, use GET /charge/stripe/last-id:

bash

curl --request GET \
  --url 'https://portal.woo-fi.com/api/webservice/v1/charge/stripe/last-id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {seu-token}'

json

{ "payment_id": "cs_test_a1Zj2XFnQGzd0PaeXxtBcByyD16r9fi6vPaX22bwUVY0Tu5q8SUU2JliCX" }

Em seguida, confirme a aprovação com GET /charge/stripe/check-success, passando o session_id na query:

bash

curl --request GET \
  --url 'https://portal.woo-fi.com/api/webservice/v1/charge/stripe/check-success?session_id=cs_test_a1Zj2XFnQGzd0PaeXxtBcByyD16r9fi6vPaX22bwUVY0Tu5q8SUU2JliCX' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {seu-token}'

json

{ "status": true }

status: true indica que o pagamento foi aprovado.

O saldo entra após a aprovação

O crédito só aparece em current-balance depois que o pagamento é aprovado. Confirme via check-success antes de assumir que a recarga entrou.

Próximos passos

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