Oceanbris Docs

Ajuda

Changelog

Mudanças na API pública e nesta documentação.

Mudanças que acrescentam campos ou eventos podem acontecer sem aviso: a sua integração deve ignorar campos que não conhece. Mudanças que quebram compatibilidade serão anunciadas aqui com antecedência.

23/10/2026: Saque pela API

  • A chave de API passa a pedir, simular, consultar e cancelar saques: POST /v1/payouts (escopo payouts:write), POST /v1/payouts/quote, GET /v1/payouts/policy, GET /v1/payouts, GET /v1/payouts/{id} e POST /v1/payouts/{id}/cancel. Todo pedido feito pela API aguarda a análise de uma pessoa da Oceanbris antes da transferência; o painel continua funcionando como antes. Veja Saques.
  • GET /v1/beneficiaries (escopo beneficiaries:read) lista as contas de destino cadastradas no painel, com os dados mascarados e o id usado no pedido.
  • Novos escopos aceitos na API: payouts:write e beneficiaries:read. Veja Chaves de API.
  • payouts_by_koku_message no saldo passa a dizer "peça o saque pelo painel ou pela API".

07/10/2026: Saque pelo painel a qualquer hora

  • O saque passa a ser pedido pelo painel, a qualquer hora (sem dia ou horário), com a taxa de saque mostrada antes de confirmar, aprovação da Oceanbris e transferência feita pela Oceanbris. Veja Saques.
  • available_for_payout_cents passa a mostrar o disponível para saque (antes, "0").
  • Extrato: os saques aparecem como payout.reserved, payout.paid (com a referência da transferência) e payout.released. Veja Tipos de lançamento.
  • Eventos payout.created, payout.approved, payout.rejected e payout.paid documentados e enviados. Veja Eventos.
  • GET /v1/payouts/by-koku lista só os repasses feitos pela Oceanbris sem pedido de saque.

07/10/2026: Ajustes antes da publicação

  • 503 provider_unavailable passa a trazer details.reason público: processing_unavailable (repita com a mesma Idempotency-Key) ou account_not_enabled (repetir não resolve; fale com a Oceanbris). Veja Erros.
  • failure_message da cobrança failed e resolution_note de devolução não executada passam a ser textos fixos da Oceanbris. Lista em Estados da cobrança.
  • description do extrato passa a ser um texto fixo por tipo de lançamento; os repasses feitos pela Oceanbris aparecem como gateway.external_payout. Veja Saldo e extrato.
  • charge.failed sempre traz reason; cobrança cancelada antes do pagamento chega como charge.expired com data.status: "cancelled".
  • Devolução: reason de 3 a 300 caracteres (o esquema dizia 500) e a mesma Idempotency-Key com outro motivo responde 409 idempotency_conflict.

07/10/2026: Versão inicial

  • Publicação da documentação pública em docs.oceanbris.com.
  • API v1 para Pix: criar, consultar e listar cobranças; devolução total ou parcial; casos da cobrança (devoluções e contestações MED).
  • Saldo, extrato com bruto, tarifa e líquido de cada venda, e lista dos repasses feitos pela Oceanbris.
  • Webhooks assinados (x-webhook-signature, HMAC-SHA256), com reenvio automático, lista de eventos e de entregas.
  • Referência gerada a partir da especificação OpenAPI (/openapi.json), com exemplos conferidos automaticamente contra a API.
  • Ambiente de testes para integradores: em preparação.