Webhook and Notifications
A webhook is a lightweight, event-driven communication that allows one application to automatically notify another via HTTP, avoiding constantly polling for updates and enabling real-time data exchange and integration. To implement a webhook, the client gives a unique URL to the server API and specifies which event it wants to know about.
To set up GetNet’s notifications via webhook, you must state 4 URLs at the time of your accreditation on the Digital Platform. Each one will be destined to receive different notifications of the following types:
- Credit transactions,
- Debit transactions,
- Bank payment slip transactions (boleto),
- Recurring transactions (subscription)
Once the webhook is set up, GetNet will automatically send the relevant data to each URL when the specified event occurs. In the event of an error, the information will be resend every 15 minutes up to 4 times.
We always recommend keeping an eye on the certificate expiration date for each URL. In case of renewal or if you need to modify any of the originally stated URLs, please contact our GetNet Integration Support Team.
Notifications structure
In general terms, the HTTP requests have the following structure:
https://YOUR_HOST_EXAMPLE/YOUR_SERVICE_EXAMPLE?query_param_1=valueExample1&query_param_2=valueExample2
Where:
https://YOUR_HOST/YOUR_SERVICErefers to one of the 4 URLs previously stated.?indicates the beginning of the query section.query_param_1=valueExample1is an example of a query parameter.&is used as a connector between multiple query parameters.
The HTTP GET notifications provided by GetNet will include a specific set of query parameters, some of which are shared across different trigger events, while others are unique and specific to a single trigger event.
Credit notifications
Shared query param for all events Below you’ll find the list of the query params shared across all the events related to credit card transactions: Approved, Authorized, Pending, Confirmed, Canceled, Denied and Error.
| Query parameters | Description |
|---|---|
| payment_type | (only possible value:) credit |
| customer_id | (customer Id code) |
| order_id | (order number) |
| payment_id | (transaction Id in UUIDv4 format) |
| amount | (transaction amount) |
| status | (possible values depending on transaction-event type:) APPROVED AUTHORIZED PENDING CONFIRMED CANCELED DENIED ERROR |
| number_installments | (number of installments) |
| terminal_nsu | (authorization code generated by the issuer when a transaction is successfully performed) |
| authorization_code | (authorization code generated by GetNet ecommerce system) |
Below you'll find the additional query parameters for each specific event.
Additional parameters for Approved, Authorized, and Pending transaction events
| Query parameters | Description |
|---|---|
| acquirer_transaction_id | (buyer transaction code) |
| authorization_timestamp | (date and time of the authorization) |
| brand | (card brand) |
Additional parameters for Canceled transaction events
| Query parameters | Description |
|---|---|
| acquirer_transaction_id | (buyer transaction code) |
Additional parameters for Denied and Error transaction events
| Query parameters | Description |
|---|---|
| acquirer_transaction_id | (buyer transaction code) |
| description_detail | (description of the error occurred during the transaction) |
| error_code | (denied or error numeric code) |
Debit notifications
Shared query param for all events
Below you’ll find the list of the query params shared across all the events related to debit card transactions: Approved, Denied and Error.
| Query parameters | Description |
|---|---|
| payment_type | (only possible value:) debit |
| customer_id | (customer Id code) |
| order_id | (order number) |
| payment_id | (transaction Id in UUIDv4 format) |
| amount | (transaction amount) |
| status | (possible values depending on transaction-event type:) APPROVED DENIED ERROR |
| brand | (card brand) |
Below you'll find the additional query parameters for each specific event.
Additional parameters for Approved transaction events
| Query parameters | Description |
|---|---|
| acquirer_transaction_id | (buyer transaction code) |
| authorization_timestamp | (date and time of the authorization) |
| terminal_nsu | (authorization code generated by the issuer when a transaction if successfully performed) |
| authorization_code | (authorization code generated by GetNet ecommerce system) |
Additional parameters for Denied and Error transaction events
| Query parameters | Description |
|---|---|
| description_detail | (description of the error occurred during the transaction) |
| error_code | (denied or error numeric code) |
Bank payment slip (Boleto) notifications
In the case of a bank payment slip notification, it will be sent in two stages. In the first stage, a notification is sent when the bank payment slip registration is finalized, and in the second stage, a notification is sent when the payment slip is downloaded. The service remains the same; however, the response fields will differ between the two stages.
First Stage
Shared query param for all events Below you’ll find the list of the query params shared across all the events related to first stage actions: Pending, Denied and Error.
| Query parameters | Description |
|---|---|
| payment_type | (only possible value:) boleto |
| order_id | (order number) |
| payment_id | (payment identifier) |
| amount | (bank payment slip amount) |
| status | (possible values depending on transaction-event type:) PENDING DENIED ERROR |
| bank | (bank code of the bank payment slip issuer. Only possible value is Banco Santander) |
| our_number | (our number. If you don’t state it, it will be generated by the issuing bank) |
| typefull_line | (typeful line on the bank payment slip returned by the issuing bank) |
| issue_date | (Issue date, format: DDMMYYYY) |
| expiration_date | (Expiration date, format: DDMMYYYY) |
Below you'll find the additional query parameters for each specific event.
Additional parameters for Denied and Error transaction events
| Query parameters | Description |
|---|---|
| id | (bank payment slip identifier, format: UUIDv4. Is used to identify the bank payment slip for the download notification) |
| description_detail | (description of the error occurred during the transaction) |
| error_code | (denied or error numeric code) |
Second Stage
Shared query param for all events Below you’ll find the list of the query params shared across all the events related to second stage actions: Paid and Canceled.
| Query parameters | Description |
|---|---|
| id | (bank payment slip identifier, format: UUIDv4. Is used to identify the bank payment slip for the download notification) |
| amount | (bank payment slip amount) |
| status | (possible values depending on transaction-event type:) PAID CANCELED |
| payment_date | (Date that your customer pays the bank payment slip, format: DDMMYYYY) |
Recurring transactions (subscription) notifications
Shared query param for all events Below you’ll find the list of the query params shared across all the events related to recurring transactions: Authorized, Approved, Confirmed, Canceled, Denied and Error.
| Query parameters | Description |
|---|---|
| payment_type | (only possible value:) credit |
| customer_id | (customer Id code) |
| order_id | (order number) |
| payment_id | (transaction Id in UUIDv4 format) |
| amount | (transaction amount) |
| status | (possible values depending on transaction-event type:) AUTHORIZED APPROVED CONFIRMED CANCELED DENIED ERROR |
| authorization_timestamp | (date and time of the authorization) |
| acquirer_transaction_id | (buyer transaction code) |
| subscription_id | (subscription identifier, format: UUIDv4) |
| plan_id | (identifier of the plan used in the subscription, format: UUIDv4) |
| charge_id | (charge identifier, format: UUIDv4) |
| number_installments | (number of installments) |
| billing_number | (number of processed installment) |
| brand | (card brand) |
| terminal_nsu | (authorization code generated by the issuer when a transaction is successfully performed) |
| authorization_code | (authorization code generated by GetNet ecommerce system) |
| retry_number | (number of retried) |
Below you'll find the additional query parameters for each specific event.
Additional parameters for Denied and Error transaction events
| Query parameters | Description |
|---|---|
| description_detail | (description of the error occurred during the transaction) |
| error_code | (denied or error numeric code) |
Alternative payment method (PIX) notifications
Shared query param for all events
Below you’ll find the list of the query params shared across all the events related to PIX transactions: Approved, Denied and Error.
| Query parameters | Description |
|---|---|
| payment_type | (only possible value:) pix |
| customer_id | (customer Id code) |
| order_id | (order number) |
| payment_id | (transaction Id in UUIDv4 format) |
| amount | (transaction amount) |
| status | (possible values depending on transaction-event type:) APPROVED DENIED ERROR |
| transaction_id | (transaction identifier at the PSP institution after generating the QR Code) |
| transaction_timestamp | (PIX transaction date and time, format: ISO) |
| terminal_nsu | (authorization code generated by the issuer when a transaction is successfully performed) |
Below you'll find the additional query parameters for each specific event.
Additional parameters for Approved transaction events
| Query parameters | Description |
|---|---|
| payer_psp_name | Payer PSP institution name |
| payer_psp_code | Payer PSP institution code |
| payer_name | Payer name |
| payer_cnpj | CNPJ number of payer for legal entity |
| payer_cpf | Payer CPF number for individuals |
| receiver_psp_name | Receiver PSP institution name |
| receiver_psp_code | Receiver PSP institution code |
| receiver_name | Receiver name |
| receiver_cnpj | CNPJ number of receiver for legal entity |
| receiver_cpf | Receiver CPF number for individuals |
Additional parameters for Denied and Error transaction events
| Query parameters | Description |
|---|---|
| description_detail | (description of the error occurred during the transaction) |
On this page