Skip to main content
POST
Os valores aqui são inteiros em centavos: R$ 100,00 se envia como 10000. Decimais são recusados com 422, e o porquê está em Valores em centavos.
Envie Idempotency-Key nesta chamada e você pode repetir com tranquilidade depois de um erro de rede: a mesma chave devolve o recurso que já existe, em vez de criar um segundo. Veja Idempotência.
O tipo da chave é declarado em pix_key_type, e um valor de outro tipo é recusado — nunca reclassificado. Com o saque automático desligado, o saque fica em awaiting_approval até a Vext aprovar. Destino por modelo, tipos de chave e recusas em Saques.

Authorizations

Authorization
string
header
required

Chave secreta do vendedor, criada no painel em Desenvolvedores.

O valor em claro existe uma única vez, na criação. Guardamos só o hash SHA-256 - nem o suporte consegue recuperá-lo, o que é o ponto: um dump do nosso banco não permite cobrar em nome de ninguém.

A chave vai no servidor. Colocá-la no navegador do comprador a entrega a qualquer pessoa que abra a página.

Headers

Idempotency-Key
string

Identificador único da SUA tentativa. Use o mesmo valor ao repetir a requisição depois de um erro de rede.

Opcional, mas recomendado em toda criação de cobrança e estorno. Sem ele, uma repetição cria uma segunda cobrança.

Maximum string length: 255

Body

application/json
amount
integer<int64>
required

O que sai do saldo, em centavos inteiros. A taxa vem de dentro deste valor.

Example:

50000

pix_key_type
enum<string>

Obrigatório junto com pix_key. Só para contas no modelo bolsão.

Available options:
cpf,
cnpj,
email,
phone,
random,
evp
pix_key
string

A chave, do tipo declarado. CPF e CNPJ têm o dígito verificador conferido; telefone aceita com ou sem +55; e-mail é gravado em minúsculas. Obrigatório junto com pix_key_type.

Maximum string length: 77
Example:

"financeiro@fornecedor.com.br"

Response

Saque registrado e saldo debitado.

Um saque. amount, fee e net são centavos inteiros, e sempre net = amount - fee. A chave PIX vem mascarada.

object
string
required
Allowed value: "withdrawal"
id
string
required
Example:

"wd_01k1y8d4h1g2f3e4d5c6b7a8z9"

status
enum<string>
required

O que cada status significa está em Saques.

Available options:
pending,
processing,
awaiting_approval,
approved,
paid,
failed,
canceled,
rejected
method
enum<string>
required

pix no bolsão, ted no split.

Available options:
pix,
ted
amount
integer<int64>
required

O que saiu do saldo.

currency
string
required
Allowed value: "BRL"
fee
integer<int64>
required

A taxa do saque, de dentro de amount.

net
integer<int64>
required

O que chega ao destino.

pix_key_type
enum<string> | null
required

null no saque por TED.

Available options:
cpf,
cnpj,
email,
phone,
random
pix_key
string | null
required

A chave de destino, mascarada. null no saque por TED.

Example:

"fi********@fornecedor.com.br"

failed_reason
string | null
required
created_at
string<date-time>
required
processed_at
string<date-time> | null
required