Este é o endpoint principal para cobrar via PIX. Ele retorna o identificador da operação, o status inicial e o copia e cola para o seller apresentar ao pagador.
| Campo | Obrigatorio | Descricao |
|---|---|---|
| amount | Sim | Valor da cobranca em reais. Exemplo: 10.50. |
| external_id | Sim | Identificador unico do seller para a cobranca. |
| clientCallbackUrl | Sim | URL HTTPS que vai receber atualizacoes de status. |
| payer.name | Sim | Nome do pagador. |
| payer.email | Sim | Email do pagador. |
| payer.document | Sim | CPF ou CNPJ do pagador, sem depender de formatacao. |
| payer.phone | Sim | Telefone do pagador com DDD. Exemplo: 5547999999999. |
| description | Nao | Descricao comercial da cobranca. |
curl --request POST 'https://api.xxxpay.online/api/payments/deposit' \
--header 'Authorization: Bearer SEU_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"amount": 25.90,
"external_id": "pedido-1001",
"clientCallbackUrl": "https://seller.exemplo.com/webhooks/xxxpay/deposit",
"description": "Pedido 1001",
"payer": {
"name": "Cliente da Silva",
"email": "cliente@seller.com",
"document": "12345678909",
"phone": "5547999999999"
}
}'
{
"message": "Deposit created successfully.",
"qrCodeResponse": {
"transactionId": "09ed00df-b2a4-4efc-9b86-b0faf9ac3692",
"status": "PENDING",
"qrcode": "0002010102122686...",
"amount": 25.9
}
}
A cobrança nasce como PENDING. Quando o pagamento for confirmado, a XXXPay chama o seu clientCallbackUrl com o status final e os valores de taxa.