Webhook de Pagamento
POST
/payment/webhook/{paymentCode}
Processa notificações de webhook recebidas por código de pagamento
Descrição
Recebe o payload bruto do webhook e repassa os dados recebidos para a integração de pagamento.
Após a integração responder, a API consulta o pagamento interno pelo transactionId retornado e cria log com origem webhook.
Parâmetros
Parâmetros de URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
paymentCode | string | Sim | Código do pagamento usado para identificar o provedor |
Parâmetros do Corpo
O payload bruto é repassado para a integração e não passa por FormRequest.
Exemplo de Requisição
1curl --request POST \2 --url 'https://sua-loja-uappi.com.br/api/v3/payment/webhook/abc-123' \3 --header 'Content-Type: application/json' \4 --data '{5 "event": "payment.captured",6 "transactionId": "txn-001"7 }'✅ Resposta de Sucesso
1{2 "status": true,3 "data": {4 "id": 1,5 "orderGroupId": 10,6 "orderId": 1001,7 "paymentType": "pix",8 "paymentProof": "",9 "paymentExpirationDate": "2026-04-01 00:00:00",10 "paymentOptionId": 2,11 "parentPaymentOptionId": null,12 "paymentOptionLabel": "Pix",13 "paymentOptionDetail": "Pix - (Pix)",14 "integrationName": "gateway-x",15 "transactionId": "txn-001",16 "currentStatus": "paid",17 "paymentAntiFraudId": null,18 "paymentAntiFraudCredentialId": null,19 "antiFraudStatus": null,20 "pixQrCode": "000201...",21 "pixEmv": "000201...",22 "billetBarCode": null,23 "billetDigitableLine": null,24 "billetUrl": null,25 "cardAutomaticCapture": false,26 "cardMasked": null,27 "cardFlag": null,28 "cardExpiration": null,29 "value": 123.45,30 "installment": null,31 "installmentValue": null,32 "fee": null,33 "orderGroup": null,34 "logs": []35 }36}⚠️ Possíveis erros:
| Código Interno | Código HTTP | Descrição |
|---|---|---|
| UAPPI_STORE_ORDER_PAYMENT_NOT_FOUND | 404 | Não foi encontrado pagamento interno para o transactionId retornado pelo webhook. |