Skip to main content
GET

Descrição

Retorna o saldo de split disponível para saque. Pode consultar o saldo de um destinatário específico ou listar todos os destinatários com saldo acumulado.
Funcionalidade restrita: A funcionalidade de split precisa estar habilitada na sua conta. Entre em contato com o suporte para solicitar a ativação.

Headers

string
required
Bearer token com sua API Key

Query Parameters (opcionais)

string
ID Discord do destinatário (17 a 20 dígitos). Se fornecido, retorna apenas o saldo desse destinatário específico. Se omitido, retorna todos os destinatários com saldo positivo.

Response (destinatário específico)

Quando recipientUserId é fornecido:
boolean
Indica se a operação foi bem-sucedida
object
Saldo do destinatário consultado

Response (todos os destinatários)

Quando recipientUserId é omitido:
boolean
Indica se a operação foi bem-sucedida
number
Soma de todos os saldos de split em R$
array
Lista de destinatários com saldo positivo