Skip to main content
POST

Parâmetros

number
required
Valor da transação em reais. Valor mínimo: R$ 3,00. Valor máximo: R$ 5.000,00 por transação.
string
Descrição opcional da transação. Se não fornecida, será usado um padrão baseado no nome do usuário.
boolean
default:"false"
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.
string
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.
number
default:"50"
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

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,...
string
Código PIX para copiar e colar. Pode ser usado para pagamento manual ou para gerar QR Code localmente.
string
ID da transação na gateway. Usado para rastreamento interno.
number
Valor total da transação em reais (apenas na resposta de criação).
integer
Valor total da transação em centavos.
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:
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 obtida no painel da Eyo Wallet

Body

application/json
value
number
required

Valor da transação em reais. Mínimo: R$ 3,00. Máximo: R$ 5.000,00 por transação.

Required range: 3 <= x <= 2000
description
string

Descrição opcional da transação

coverFee
boolean
default:false

Se true, o valor informado é o valor líquido que você deseja receber. A taxa será adicionada ao valor total.

splitUser
string

Email de outro usuário Eyo Wallet para dividir o pagamento

splitTax
number
default:50

Porcentagem do valor a ser transferida para o usuário de split

Required range: 1 <= x <= 100

Response

Pagamento criado com sucesso

success
boolean
message
string
data
object