Skip to main content
POST
Escopo subaccounts:write. O dinheiro continua no seu saldo; a subconta guarda quanto dele é atribuído ao cliente. Cobranças e links criados com subaccountId (ou com split) creditam a venda a ela quando pagos. Em toda rota com {id} vale o sacc_... ou o seu externalId.
string
required
Hoje: 2 a 80 caracteres (INVALID_NAME). Veja a regra do nome, que vai passar a valer.
string | null
E-mail do cliente, guardado criptografado. A lista mostra só hasEmail; o detalhe mostra o e-mail.
string | null
O identificador do cliente no seu sistema: letras, números, ponto, hífen e sublinhado, até 64, e sem o formato sacc_ (INVALID_EXTERNAL_ID). Único por conta (409 EXTERNAL_ID_IN_USE); volta a ficar livre quando a subconta é excluída.
string | null
CPF ou CNPJ do titular, com ou sem pontuação: conferido pelos dígitos (422 INVALID_DOCUMENT) e guardado criptografado. Sempre inteiro (mascarado é recusado). Vem inteiro no detalhe e mascarado na lista.
integer
Sua comissão por venda em pontos-base: 100 = 1%, de 0 a 10000.
integer
Parte fixa da comissão por venda, em centavos (até 1.000.000).
integer
Sua taxa por saque da subconta, em pontos-base. Ela paga a tarifa da WyzeCash do saque; o que sobra fica com você.
integer
Parte fixa da taxa por saque, em centavos.
"global" | "custom"
global segue a taxa global da Configuração das subcontas; custom usa as taxas acima. Sem feeMode e sem nenhuma taxa no pedido, a subconta nasce na global; com alguma taxa, fica com a própria. Os limits que não vierem usam os limites padrão da Configuração.
object | null
Objeto JSON livre para os seus dados (até 2 KB, 422 INVALID_METADATA). Volta no detalhe.
object | null
{ "keyType": "cpf" | "cnpj" | "email" | "phone" | "random", "key": "..." }: a chave Pix do cliente, conferida na hora (titular e banco) e guardada criptografada. É o destino padrão do saque da subconta quando o pedido não manda destination. Chave de conta WyzeCash: 422 INTERNAL_ACCOUNT.

Regra do nome (vai passar a valer)

Ainda não vale. Hoje a API aceita qualquer nome de 2 a 80 caracteres. A WyzeCash avisa antes de ligar a regra: ajuste a sua integração desde já.
Quando a regra for ligada, o name segue o documento do titular (document): Até 100 caracteres. Nunca o CPF ou CNPJ (inteiro ou mascarado) nem um id entre colchetes no nome, como Ana Souza 123.456.789-00 ou [bot:8812] Ana Souza: o CPF/CNPJ vai em document e o id do seu sistema em externalId. Fora da regra, a API vai responder 422 INVALID_NAME ao criar e ao trocar o nome (mandar de novo o mesmo nome que já está salvo continua passando). As mensagens:

Resposta

string
sacc_ + 32 hex.
string
Nome.
string | null
Seu identificador.
boolean
Se há e-mail guardado.
string | null
O e-mail (só no detalhe: criar, consultar e editar).
string
global (as taxas vêm da Configuração das subcontas) ou custom (as dela).
object
{ percentBps, fixed }: comissão por venda que vale.
object
{ percentBps, fixed }: taxa por saque.
integer
Saldo atribuído à subconta (centavos), nunca negativo.
boolean
Ativa ou desativada.
boolean
Bloqueada pelo bloqueio automático por MED: o saque fica trancado até a pendência acabar.
integer
Pendência do MED (centavos): o que falta reservar dos MED abertos mais o que ficou devendo dos devolvidos. Sai das próximas entradas dela.
object | null
{ keyType, key, holderName, institution }; null sem chave. A chave vem inteira no detalhe (criar, consultar e editar) e mascarada na lista.
object | null
Os seus dados (só no detalhe).
string
Criação.