In this page you'll find all the information you need to set up a webhook.
Our API is able to send a realtime payment notification (aka webhook or callback) to an URL.
There's a table below that will help you understand the params we send to your URL.
Important:
This notification is only sent if a reference is paid. Currently, there are no communications for expired, canceled and/or refunded transactions.
| Params | Description |
|---|---|
| valor | Payment amount. |
| canal | Channel name where the reference was created. |
| referencia | Reference number. |
| transacao | Transaction ID. |
| identificador | Identifier. |
| mp | Payment Method Code: - PC:PT - Multibanco - PS:PT - Payshop - MW:PT - MB WAY - CC:PT - Credit Card - PF:PT - Paysafecard - DD:PT - Direct Debit - PSC:PT - Paysafecash - CP:PT - CofidisPay |
| chave_api | API Key used to create the reference. |
| data | Payment date and hour (YYYY-MM-DD:hh:mm). |
| entidade | Entity. |
| comissao | Payment Fee |
| local | Payment City |
Here's an example below:
URL Configuration:
Your url that will receive our notification should be inserted on your Eupago's backoffice:
- On your left side, choose the option Channels
- Click on Channel Listing
- Click on the pencil on the right corner of your channel to edit it
- Check the option "Receive notification for a URL" and paste your url on the URL field right below the option.
Check our guide in case you need help around our backoffice.
Should you need more support on this configuration let us know by sending an email ([email protected]) or fill this support form.