{
"customer": {
"email": "[email protected]",
"name": "Ana Silva",
"document": "39053344705"
},
"amount": 19.9,
"currency": "BRL",
"metadata": { "order_id": "1001" },
"notification_url": "https://loja.com/webhooks/agitapay"
}
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"store": { "id": "uuid-da-loja", "name": "Padrão" },
"status": "waiting_payment",
"amount": 19.9,
"currency": "BRL",
"qrcode": "data:image/png;base64,...",
"copy_paste": "000201...",
"notification_url": "https://loja.com/webhooks/agitapay",
"paid_at": null
}
PIX
Criar cobrança PIX
Gere um PIX avulso com QR Code e código copia-e-cola.
POST
/
payments
/
pix
{
"customer": {
"email": "[email protected]",
"name": "Ana Silva",
"document": "39053344705"
},
"amount": 19.9,
"currency": "BRL",
"metadata": { "order_id": "1001" },
"notification_url": "https://loja.com/webhooks/agitapay"
}
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"store": { "id": "uuid-da-loja", "name": "Padrão" },
"status": "waiting_payment",
"amount": 19.9,
"currency": "BRL",
"qrcode": "data:image/png;base64,...",
"copy_paste": "000201...",
"notification_url": "https://loja.com/webhooks/agitapay",
"paid_at": null
}
Cria uma cobrança PIX avulsa. Requer a permissão
O valor deve respeitar os limites configurados pela plataforma. Fora da faixa, a API retorna
pix:write.
string
Recomendado. Até 128 caracteres e escopo por loja. Evita cobrança duplicada em retries.
string
required
E-mail válido do pagador.
string
required
Nome completo do pagador.
string
required
CPF ou CNPJ, com ou sem formatação.
string
Telefone do pagador.
number
required
Valor em reais, não em centavos.
string
Use
BRL.object
Metadados livres, como o ID do pedido.
string
URL HTTPS opcional do checkout da sua loja.
string
required
URL HTTPS pública que recebe eventos.
{
"customer": {
"email": "[email protected]",
"name": "Ana Silva",
"document": "39053344705"
},
"amount": 19.9,
"currency": "BRL",
"metadata": { "order_id": "1001" },
"notification_url": "https://loja.com/webhooks/agitapay"
}
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"store": { "id": "uuid-da-loja", "name": "Padrão" },
"status": "waiting_payment",
"amount": 19.9,
"currency": "BRL",
"qrcode": "data:image/png;base64,...",
"copy_paste": "000201...",
"notification_url": "https://loja.com/webhooks/agitapay",
"paid_at": null
}
string
Data URI PNG pronta para usar em
<img src="…">.string
Código PIX EMV copia-e-cola.
string
waiting_payment, paid, expired, cancelled ou failed.422 amount_below_minimum ou 422 amount_above_maximum.
Libere produto somente após receber
payment.paid e confirmar com GET /payments/{id}.