Skip to main content
POST/transfer-pix/create

Corpo da requisição

amountnumberrequired

Valor em reais, com até duas casas decimais. De R$ 5,00 a R$ 1.000,00 por operação.

coverFeeboolean

Padrão true. A taxa é cobrada além do valor enviado; com false, é descontada do valor informado.

pixKeystring

Chave do destinatário. Obrigatória quando não há pixCopyPaste.

CPF, CNPJ, EMAIL, TELEFONE ou ALEATORIA.

Alternativa à chave: conteúdo completo do QR Code PIX.

Descrição que identifica a operação.

Referência do seu sistema, até 120 caracteres. Deve ser única para o tipo da operação.

Headers

Idempotency-Keystringrequired

Identificador único de até 128 caracteres. Preserve a chave e o corpo ao repetir a operação.

Autorização

X-API-Keystringrequired

Chave VibeCash com permissão para esta operação.

Resposta

201 application/json
successbooleanrequired

Indica se a operação foi concluída pela API.

messagestringrequired

Mensagem da operação.

dataobjectrequired

Dados retornados pela operação.

Show child attributes
idstring

Identificador da operação.

statusstring

Situação atual do pagamento ou envio.

amountnumber

Valor bruto ou informado, em reais.

feeAmountnumber

Taxa da operação, em reais.

netAmountnumber

Líquido da entrada ou total debitado de uma saída.

Valor entregue ao destinatário.

Total debitado da carteira.

createdAtstring

Data e hora da criação em formato ISO.

requestIdstring

Identificador da requisição.

netAmount mantém o total debitado da carteira por compatibilidade. Use recipientAmount para o valor recebido pelo destinatário e totalDebit para o custo total.

Erros

As falhas retornam o envelope com success: false. Consulte erros e códigos HTTP para interpretar validação, permissão, conflito e saldo insuficiente.

curl --request POST \
  --url 'https://seu-dominio/v1/transfer-pix/create' \
  --header 'X-API-Key: tp_live_SUA_CHAVE' \
  --header 'Idempotency-Key: operacao-unica-123' \
  --header 'Content-Type: application/json' \
  --data '{"amount":5,"coverFee":true,"pixKey":"[email protected]","pixKeyType":"EMAIL","description":"Transferência"}'
{
  "success": true,
  "message": "Operação concluída",
  "data": {
    "id": "out_exemplo",
    "amount": 5,
    "feeAmount": 0.1,
    "netAmount": 5.1,
    "recipientAmount": 5,
    "totalDebit": 5.1,
    "status": "PROCESSING",
    "createdAt": "2026-11-10T15:00:00.000Z"
  },
  "requestId": "req_exemplo"
}

Pesquisar documentação

POST

Enviar PIX

Transfira saldo para uma chave PIX ou um código copia e cola.

Authorization
Body
Expand 6 optional fields