> ## Documentation Index
> Fetch the complete documentation index at: https://docs.eyowallet.ru/llms.txt
> Use this file to discover all available pages before exploring further.
# Criar Pagamento
> Crie uma nova transação PIX e receba um QR Code para pagamento
```bash cURL theme={null}
curl -X POST 'https://api.eyowallet.ru/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
}'
```
```json Success theme={null}
{
"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
Valor da transação em reais. Valor mínimo: `R$ 3,00`. Valor máximo: `R$ 5.000,00` por transação.
Descrição opcional da transação. Se não fornecida, será usado um padrão baseado no nome do usuário.
Se `true`, o valor informado é o valor líquido que você deseja receber. A taxa será adicionada ao valor total do pagamento. Se `false` (padrão), o valor informado é o valor total, e a taxa será deduzida.
Email de outro usuário Eyo Wallet para dividir o pagamento. Quando o pagamento for confirmado, o valor será dividido automaticamente entre você e o usuário especificado.
Porcentagem do valor a ser transferida para o usuário de split. Valor entre 1 e 100. Padrão: 50% (divisão igualitária).
### Campos da Resposta
QR Code em formato base64 (data URI). Pode ser usado diretamente em tags `![]()
` HTML ou convertido para exibição. Formato: `data:image/png;base64,...`
Código PIX para copiar e colar. Pode ser usado para pagamento manual ou para gerar QR Code localmente.
ID da transação na gateway. Usado para rastreamento interno.
Valor total da transação em reais (apenas na resposta de criação).
Valor total da transação em centavos.
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:
| Status | Descrição |
| ----------- | ----------------------------------- |
| `PENDING` | Aguardando pagamento |
| `ACTIVE` | QR Code ativo, aguardando pagamento |
| `COMPLETED` | Pagamento confirmado |
| `FAILED` | Pagamento 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**
## OpenAPI
````yaml POST /api/v1/payment/create
openapi: 3.1.0
info:
title: Eyo Wallet API
description: >-
API para integração com a Eyo Wallet - Plataforma de pagamentos PIX para
desenvolvedores e empresas
version: 1.0.0
contact:
name: Eyo Wallet
url: https://eyowallet.ru
servers:
- url: https://api.eyowallet.ru
description: Servidor de Produção
security:
- apiKeyAuth: []
tags:
- name: Payments
description: Endpoints para criar e gerenciar pagamentos PIX
- name: Withdraws
description: Endpoints para criar e gerenciar saques via PIX
- name: Transfers
description: Endpoints para transferências internas entre contas Eyo Wallet
- name: User
description: Endpoints para informações do usuário e configurações
paths:
/api/v1/payment/create:
post:
tags:
- Payments
summary: Criar Pagamento
description: Cria uma nova transação PIX e retorna um QR Code para pagamento
operationId: createPayment
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePaymentRequest'
responses:
'200':
description: Pagamento criado com sucesso
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePaymentResponse'
'400':
description: Erro de validação
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: API Key inválida ou ausente
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Rate limit excedido
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
CreatePaymentRequest:
type: object
required:
- value
properties:
value:
type: number
description: >-
Valor da transação em reais. Mínimo: R$ 3,00. Máximo: R$ 5.000,00
por transação.
minimum: 3
maximum: 2000
description:
type: string
description: Descrição opcional da transação
coverFee:
type: boolean
default: false
description: >-
Se true, o valor informado é o valor líquido que você deseja
receber. A taxa será adicionada ao valor total.
splitUser:
type: string
description: Email de outro usuário Eyo Wallet para dividir o pagamento
splitTax:
type: number
default: 50
minimum: 1
maximum: 100
description: Porcentagem do valor a ser transferida para o usuário de split
CreatePaymentResponse:
type: object
properties:
success:
type: boolean
message:
type: string
data:
type: object
properties:
id:
type: string
description: ID único do pagamento
transactionId:
type: string
description: ID da transação na gateway
value:
type: integer
description: Valor total em centavos
valueInReais:
type: number
description: Valor total em reais
netValue:
type: integer
description: Valor líquido após dedução da taxa, em centavos
fee:
type: integer
description: Taxa cobrada em centavos
status:
type: string
enum:
- PENDING
- ACTIVE
- COMPLETED
- FAILED
qrcodeUrl:
type: string
description: QR Code em formato base64 (data URI)
copyPaste:
type: string
description: Código PIX para copiar e colar
createdAt:
type: string
format: date-time
Error:
type: object
properties:
success:
type: boolean
const: false
error:
type: string
description: Mensagem de erro
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: X-API-Key
description: API Key obtida no painel da Eyo Wallet
````