Skip to main content
POST
/
api
/
v1
/
payment
/
create
curl -X POST 'https://api.visionwallet.com.br/api/v1/payment/create' \
  -H 'X-API-Key: sua_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "value": 100.00,
    "description": "Pagamento de serviço",
    "coverFee": false
  }'

{
  "success": true,
  "message": "Transação criada com sucesso. Aguarde o deposito via PIX.",
  "data": {
    "id": "payment_abc123",
    "transactionId": "mistic_transaction_id",
    "value": 10000,
    "valueInReais": 100.00,
    "netValue": 9950,
    "fee": 50,
    "status": "PENDING",
    "qrcodeUrl": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
    "copyPaste": "00020126580014br.gov.bcb.pix...",
    "createdAt": "2024-01-15T10:30:00Z"
  }
}

​
Criar Pagamento PIX

Cria uma nova transação PIX e retorna um QR Code para pagamento. O QR Code pode ser usado para pagamento via aplicativo bancário ou gerador de QR Code. 
curl -X POST 'https://api.visionwallet.com.br/api/v1/payment/create' \
  -H 'X-API-Key: sua_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "value": 100.00,
    "description": "Pagamento de serviço",
    "coverFee": false
  }'

{
  "success": true,
  "message": "Transação criada com sucesso. Aguarde o deposito via PIX.",
  "data": {
    "id": "payment_abc123",
    "transactionId": "mistic_transaction_id",
    "value": 10000,
    "valueInReais": 100.00,
    "netValue": 9950,
    "fee": 50,
    "status": "PENDING",
    "qrcodeUrl": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==",
    "copyPaste": "00020126580014br.gov.bcb.pix...",
    "createdAt": "2024-01-15T10:30:00Z"
  }
}

​
Parâmetros

​
value
number
required
Valor da transação em reais. Valor mínimo: R1,00.Valormaˊximo:R 1,00. Valor máximo: R 1.000,00 por transação.
​
description
string
Descrição opcional da transação. Se não fornecida, será usado um padrão baseado no nome do usuário.
​
coverFee
boolean
default:"false"
Se true, o valor informado é o valor líquido que você deseja receber. A taxa será adicionada ao valor total do QR Code. Se false (padrão), o valor informado é o valor total, e a taxa será deduzida.

​
Campos da Resposta

​
qrcodeUrl
string
QR Code em formato base64 (data URI). Pode ser usado diretamente em tags <img> HTML ou convertido para exibição. Formato: data:image/png;base64,...
​
copyPaste
string
Código PIX para copiar e colar. Pode ser usado para pagamento manual ou para gerar QR Code localmente.
​
transactionId
string
ID da transação na Mistic Pay. Usado para rastreamento interno.
​
valueInReais
number
Valor total da transação em reais (apenas na resposta de criação).
​
value
integer
Valor total da transação em centavos.
​
netValue
integer
Valor líquido que será recebido após dedução da taxa, em centavos.

​
Status da Transação

As transações podem ter os seguintes status:
StatusDescrição
PENDINGAguardando pagamento
ACTIVEQR Code ativo, aguardando pagamento
COMPLETEDPagamento confirmado
FAILEDPagamento falhou ou foi cancelado
Configure webhooks para receber notificações em tempo real quando o status do pagamento mudar.

​
Permissões Necessárias

Esta rota requer a permissão write:payment:create.

​
Rate Limiting

  • 10 req/s (600 req/min) por API Key

Authorizations

​
X-API-Key
string
header
required

API Key para autenticação. Use o header X-API-Key ou Authorization: Bearer {api_key}

Body

application/json
​
value
number
required

Valor da transação em reais

Required range: 1 <= x <= 1000
Example:

100

​
description
string

Descrição opcional da transação

Example:

"Pagamento de serviço"

​
coverFee
boolean
default:false

Se true, o valor informado é o valor líquido recebido

Response

Transação criada com sucesso

​
success
boolean
​
message
string
​
data
object