Skip to main content
POST
/
api
/
v1
/
pix
/
out
/
pixkey
Enviar transferência PIX
curl --request POST \
  --url https://api.vexybank.com/api/v1/pix/out/pixkey \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "pixKey": "[email protected]",
  "amount": 10000,
  "currency": "BRL",
  "description": "Transfer PIX Exemplo",
  "postbackUrl": "https://exemplo.com.br/webhook/pix-out"
}
'
{
  "success": true,
  "message": "Transferência criada com sucesso",
  "data": {
    "id": "transfer_abc123def456",
    "status": "queued",
    "amount": 10000,
    "netAmount": 10000,
    "fees": 0,
    "pixKey": "[email protected]"
  }
}

Authorizations

​
Authorization
string
header
required

Token JWT no cabeçalho Authorization

Headers

​
x-idempotency-key
string
required

Chave de idempotência para evitar duplicações

Body

application/json
​
pixKey
string
required

Chave PIX de destino (CPF, CNPJ, email, telefone ou chave aleatória)

Example:

"[email protected]"

​
amount
integer
required

Valor da transferência em centavos

Required range: x >= 1
Example:

10000

​
currency
string
default:BRL

Moeda da transferência (apenas BRL aceito)

Example:

"BRL"

​
description
string

Descrição da transferência

Maximum length: 140
Example:

"Transfer PIX Exemplo"

​
postbackUrl
string<uri>

URL para receber notificações de status da transferência

Example:

"https://exemplo.com.br/webhook/pix-out"

Response

Transferência iniciada com sucesso

​
success
boolean

Indica se a operação foi bem-sucedida

Example:

true

​
message
string

Mensagem de retorno

Example:

"Transferência criada com sucesso"

​
data
object