Notification callbacks
Besides webhooks, Getnet provides callback-based notifications. The server calls URLs you provide (callbacks) to notify your system about payment events. This mechanism uses HTTP GET requests with data in the query string, and you configure it at accreditation time. It differs from the webhooks in the Global API. Those use HTTP POST, configurable subscriptions, and a different payload format.
To set up Getnet’s notifications via callback, you must state 4 URLs at the time of your accreditation on the Digital Platform. Each URL receives one of the following notification types:
- Credit transactions
- Debit transactions
- Bank payment slip transactions (Boleto)
- Recurring transactions (subscription)
Once you set up the callback URLs, Getnet automatically sends the relevant data to each URL when the specified event occurs. If an error occurs, Getnet resends the information every 15 minutes, up to 4 times.
Keep track of the certificate expiration date for each URL. For a renewal, or to modify any of the URLs you originally stated, contact the Getnet Integration Support Team.
Notification structure
The HTTP requests have the following general 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 callback URLs previously stated.?indicates the beginning of the query section.query_param_1=valueExample1is an example of a query parameter.&connects multiple query parameters.
The HTTP GET notifications from Getnet include a specific set of query parameters. Some parameters are shared across different trigger events. Others are specific to a single trigger event.
Every notification carries a
status query parameter. The value tells you which event triggered the call. Each notification type returns its own set of values:| Notification type | status values returned |
|---|---|
| Credit | APPROVED, AUTHORIZED, PENDING, CONFIRMED, CANCELED, DENIED, ERROR |
| Debit | APPROVED, DENIED, ERROR |
| Bank payment slip (Boleto) — first stage | PENDING, DENIED, ERROR |
| Bank payment slip (Boleto) — second stage | PAID, CANCELED |
| Recurring (subscription) | AUTHORIZED, APPROVED, CONFIRMED, CANCELED, DENIED, ERROR |
| Alternative payment method (Pix) | APPROVED, DENIED, ERROR |
Notifications with
status=DENIED or status=ERROR also carry error_code and description_detail. Branch your handling on error_code, not on the description text. For the full list of codes and what each one means, see Errors.The sections below list the query parameters for each type, followed by example requests. Examples use placeholder values. Replace each
_EXAMPLE placeholder with the value your integration receives.Credit notifications
Shared query parameters for all events
All credit card transaction events share the query parameters below. These events are 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) |
The following tables list 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 that occurred during the transaction) |
| error_code | (denied or error numeric code) |
Credit request examples
An Approved credit notification. The same structure applies to Authorized and Pending, with
status changed accordingly:
Texthttps://YOUR_HOST_EXAMPLE/YOUR_CREDIT_SERVICE_EXAMPLE?payment_type=credit&customer_id=CUSTOMER_ID_EXAMPLE&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=APPROVED&number_installments=NUMBER_INSTALLMENTS_EXAMPLE&terminal_nsu=TERMINAL_NSU_EXAMPLE&authorization_code=AUTHORIZATION_CODE_EXAMPLE&acquirer_transaction_id=ACQUIRER_TRANSACTION_ID_EXAMPLE&authorization_timestamp=AUTHORIZATION_TIMESTAMP_EXAMPLE&brand=BRAND_EXAMPLE
Text1
https://YOUR_HOST_EXAMPLE/YOUR_CREDIT_SERVICE_EXAMPLE?payment_type=credit&customer_id=CUSTOMER_ID_EXAMPLE&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=APPROVED&number_installments=NUMBER_INSTALLMENTS_EXAMPLE&terminal_nsu=TERMINAL_NSU_EXAMPLE&authorization_code=AUTHORIZATION_CODE_EXAMPLE&acquirer_transaction_id=ACQUIRER_TRANSACTION_ID_EXAMPLE&authorization_timestamp=AUTHORIZATION_TIMESTAMP_EXAMPLE&brand=BRAND_EXAMPLE
A Canceled credit notification:
Texthttps://YOUR_HOST_EXAMPLE/YOUR_CREDIT_SERVICE_EXAMPLE?payment_type=credit&customer_id=CUSTOMER_ID_EXAMPLE&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=CANCELED&number_installments=NUMBER_INSTALLMENTS_EXAMPLE&terminal_nsu=TERMINAL_NSU_EXAMPLE&authorization_code=AUTHORIZATION_CODE_EXAMPLE&acquirer_transaction_id=ACQUIRER_TRANSACTION_ID_EXAMPLE
Text1
https://YOUR_HOST_EXAMPLE/YOUR_CREDIT_SERVICE_EXAMPLE?payment_type=credit&customer_id=CUSTOMER_ID_EXAMPLE&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=CANCELED&number_installments=NUMBER_INSTALLMENTS_EXAMPLE&terminal_nsu=TERMINAL_NSU_EXAMPLE&authorization_code=AUTHORIZATION_CODE_EXAMPLE&acquirer_transaction_id=ACQUIRER_TRANSACTION_ID_EXAMPLE
A Denied credit notification. The same structure applies to Error, with
status=ERROR:Texthttps://YOUR_HOST_EXAMPLE/YOUR_CREDIT_SERVICE_EXAMPLE?payment_type=credit&customer_id=CUSTOMER_ID_EXAMPLE&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=DENIED&number_installments=NUMBER_INSTALLMENTS_EXAMPLE&terminal_nsu=TERMINAL_NSU_EXAMPLE&authorization_code=AUTHORIZATION_CODE_EXAMPLE&acquirer_transaction_id=ACQUIRER_TRANSACTION_ID_EXAMPLE&description_detail=DESCRIPTION_DETAIL_EXAMPLE&error_code=ERROR_CODE_EXAMPLE
Text1
https://YOUR_HOST_EXAMPLE/YOUR_CREDIT_SERVICE_EXAMPLE?payment_type=credit&customer_id=CUSTOMER_ID_EXAMPLE&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=DENIED&number_installments=NUMBER_INSTALLMENTS_EXAMPLE&terminal_nsu=TERMINAL_NSU_EXAMPLE&authorization_code=AUTHORIZATION_CODE_EXAMPLE&acquirer_transaction_id=ACQUIRER_TRANSACTION_ID_EXAMPLE&description_detail=DESCRIPTION_DETAIL_EXAMPLE&error_code=ERROR_CODE_EXAMPLE
Debit notifications
Shared query parameters for all events
All debit card transaction events share the query parameters below. These events are 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) |
The following tables list 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 is 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 that occurred during the transaction) |
| error_code | (denied or error numeric code) |
Debit request examples
An Approved debit notification:
Texthttps://YOUR_HOST_EXAMPLE/YOUR_DEBIT_SERVICE_EXAMPLE?payment_type=debit&customer_id=CUSTOMER_ID_EXAMPLE&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=APPROVED&brand=BRAND_EXAMPLE&acquirer_transaction_id=ACQUIRER_TRANSACTION_ID_EXAMPLE&authorization_timestamp=AUTHORIZATION_TIMESTAMP_EXAMPLE&terminal_nsu=TERMINAL_NSU_EXAMPLE&authorization_code=AUTHORIZATION_CODE_EXAMPLE
Text1
https://YOUR_HOST_EXAMPLE/YOUR_DEBIT_SERVICE_EXAMPLE?payment_type=debit&customer_id=CUSTOMER_ID_EXAMPLE&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=APPROVED&brand=BRAND_EXAMPLE&acquirer_transaction_id=ACQUIRER_TRANSACTION_ID_EXAMPLE&authorization_timestamp=AUTHORIZATION_TIMESTAMP_EXAMPLE&terminal_nsu=TERMINAL_NSU_EXAMPLE&authorization_code=AUTHORIZATION_CODE_EXAMPLE
A Denied debit notification. The same structure applies to Error, with
status=ERROR:Texthttps://YOUR_HOST_EXAMPLE/YOUR_DEBIT_SERVICE_EXAMPLE?payment_type=debit&customer_id=CUSTOMER_ID_EXAMPLE&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=DENIED&brand=BRAND_EXAMPLE&description_detail=DESCRIPTION_DETAIL_EXAMPLE&error_code=ERROR_CODE_EXAMPLE
Text1
https://YOUR_HOST_EXAMPLE/YOUR_DEBIT_SERVICE_EXAMPLE?payment_type=debit&customer_id=CUSTOMER_ID_EXAMPLE&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=DENIED&brand=BRAND_EXAMPLE&description_detail=DESCRIPTION_DETAIL_EXAMPLE&error_code=ERROR_CODE_EXAMPLE
Bank payment slip (Boleto) notifications
Getnet sends bank payment slip notifications in two stages. The first-stage notification arrives when the bank payment slip registration is finalized. The second-stage notification arrives when the payment slip is downloaded. Both stages use the same service, but the response fields differ between them.
First stage
Shared query parameters for all events
All first-stage events share the query parameters below. These events are 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, the issuing bank generates it) |
| 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) |
The following tables list 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. Used to identify the bank payment slip for the download notification) |
| description_detail | (description of the error that occurred during the transaction) |
| error_code | (denied or error numeric code) |
First stage request examples
A Pending notification, sent when the bank payment slip registration is finalized:
Texthttps://YOUR_HOST_EXAMPLE/YOUR_BOLETO_SERVICE_EXAMPLE?payment_type=boleto&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=PENDING&bank=BANK_EXAMPLE&our_number=OUR_NUMBER_EXAMPLE&typefull_line=TYPEFULL_LINE_EXAMPLE&issue_date=ISSUE_DATE_EXAMPLE&expiration_date=EXPIRATION_DATE_EXAMPLE
Text1
https://YOUR_HOST_EXAMPLE/YOUR_BOLETO_SERVICE_EXAMPLE?payment_type=boleto&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=PENDING&bank=BANK_EXAMPLE&our_number=OUR_NUMBER_EXAMPLE&typefull_line=TYPEFULL_LINE_EXAMPLE&issue_date=ISSUE_DATE_EXAMPLE&expiration_date=EXPIRATION_DATE_EXAMPLE
A Denied notification. The same structure applies to Error, with
status=ERROR:Texthttps://YOUR_HOST_EXAMPLE/YOUR_BOLETO_SERVICE_EXAMPLE?payment_type=boleto&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=DENIED&bank=BANK_EXAMPLE&our_number=OUR_NUMBER_EXAMPLE&typefull_line=TYPEFULL_LINE_EXAMPLE&issue_date=ISSUE_DATE_EXAMPLE&expiration_date=EXPIRATION_DATE_EXAMPLE&id=ID_EXAMPLE&description_detail=DESCRIPTION_DETAIL_EXAMPLE&error_code=ERROR_CODE_EXAMPLE
Text1
https://YOUR_HOST_EXAMPLE/YOUR_BOLETO_SERVICE_EXAMPLE?payment_type=boleto&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=DENIED&bank=BANK_EXAMPLE&our_number=OUR_NUMBER_EXAMPLE&typefull_line=TYPEFULL_LINE_EXAMPLE&issue_date=ISSUE_DATE_EXAMPLE&expiration_date=EXPIRATION_DATE_EXAMPLE&id=ID_EXAMPLE&description_detail=DESCRIPTION_DETAIL_EXAMPLE&error_code=ERROR_CODE_EXAMPLE
Second stage
Shared query parameters for all events
All second-stage events share the query parameters below. These events are Paid and Canceled.
| Query parameters | Description |
|---|---|
| id | (bank payment slip identifier, format: UUIDv4. 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) |
Second stage request examples
A Paid notification, sent when the payment slip is downloaded:
Texthttps://YOUR_HOST_EXAMPLE/YOUR_BOLETO_SERVICE_EXAMPLE?id=ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=PAID&payment_date=PAYMENT_DATE_EXAMPLE
Text1
https://YOUR_HOST_EXAMPLE/YOUR_BOLETO_SERVICE_EXAMPLE?id=ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=PAID&payment_date=PAYMENT_DATE_EXAMPLE
A Canceled notification:
Texthttps://YOUR_HOST_EXAMPLE/YOUR_BOLETO_SERVICE_EXAMPLE?id=ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=CANCELED&payment_date=PAYMENT_DATE_EXAMPLE
Text1
https://YOUR_HOST_EXAMPLE/YOUR_BOLETO_SERVICE_EXAMPLE?id=ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=CANCELED&payment_date=PAYMENT_DATE_EXAMPLE
Recurring transactions (subscription) notifications
Shared query parameters for all events
All recurring transaction events share the query parameters below. These events are 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 retries) |
The following tables list 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 that occurred during the transaction) |
| error_code | (denied or error numeric code) |
Recurring request examples
An Approved recurring notification. The same structure applies to Authorized, Confirmed, and Canceled, with
status changed accordingly:Texthttps://YOUR_HOST_EXAMPLE/YOUR_RECURRING_SERVICE_EXAMPLE?payment_type=credit&customer_id=CUSTOMER_ID_EXAMPLE&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=APPROVED&authorization_timestamp=AUTHORIZATION_TIMESTAMP_EXAMPLE&acquirer_transaction_id=ACQUIRER_TRANSACTION_ID_EXAMPLE&subscription_id=SUBSCRIPTION_ID_EXAMPLE&plan_id=PLAN_ID_EXAMPLE&charge_id=CHARGE_ID_EXAMPLE&number_installments=NUMBER_INSTALLMENTS_EXAMPLE&billing_number=BILLING_NUMBER_EXAMPLE&brand=BRAND_EXAMPLE&terminal_nsu=TERMINAL_NSU_EXAMPLE&authorization_code=AUTHORIZATION_CODE_EXAMPLE&retry_number=RETRY_NUMBER_EXAMPLE
Text1
https://YOUR_HOST_EXAMPLE/YOUR_RECURRING_SERVICE_EXAMPLE?payment_type=credit&customer_id=CUSTOMER_ID_EXAMPLE&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=APPROVED&authorization_timestamp=AUTHORIZATION_TIMESTAMP_EXAMPLE&acquirer_transaction_id=ACQUIRER_TRANSACTION_ID_EXAMPLE&subscription_id=SUBSCRIPTION_ID_EXAMPLE&plan_id=PLAN_ID_EXAMPLE&charge_id=CHARGE_ID_EXAMPLE&number_installments=NUMBER_INSTALLMENTS_EXAMPLE&billing_number=BILLING_NUMBER_EXAMPLE&brand=BRAND_EXAMPLE&terminal_nsu=TERMINAL_NSU_EXAMPLE&authorization_code=AUTHORIZATION_CODE_EXAMPLE&retry_number=RETRY_NUMBER_EXAMPLE
A Denied recurring notification. The same structure applies to Error, with
status=ERROR:Texthttps://YOUR_HOST_EXAMPLE/YOUR_RECURRING_SERVICE_EXAMPLE?payment_type=credit&customer_id=CUSTOMER_ID_EXAMPLE&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=DENIED&authorization_timestamp=AUTHORIZATION_TIMESTAMP_EXAMPLE&acquirer_transaction_id=ACQUIRER_TRANSACTION_ID_EXAMPLE&subscription_id=SUBSCRIPTION_ID_EXAMPLE&plan_id=PLAN_ID_EXAMPLE&charge_id=CHARGE_ID_EXAMPLE&number_installments=NUMBER_INSTALLMENTS_EXAMPLE&billing_number=BILLING_NUMBER_EXAMPLE&brand=BRAND_EXAMPLE&terminal_nsu=TERMINAL_NSU_EXAMPLE&authorization_code=AUTHORIZATION_CODE_EXAMPLE&retry_number=RETRY_NUMBER_EXAMPLE&description_detail=DESCRIPTION_DETAIL_EXAMPLE&error_code=ERROR_CODE_EXAMPLE
Text1
https://YOUR_HOST_EXAMPLE/YOUR_RECURRING_SERVICE_EXAMPLE?payment_type=credit&customer_id=CUSTOMER_ID_EXAMPLE&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=DENIED&authorization_timestamp=AUTHORIZATION_TIMESTAMP_EXAMPLE&acquirer_transaction_id=ACQUIRER_TRANSACTION_ID_EXAMPLE&subscription_id=SUBSCRIPTION_ID_EXAMPLE&plan_id=PLAN_ID_EXAMPLE&charge_id=CHARGE_ID_EXAMPLE&number_installments=NUMBER_INSTALLMENTS_EXAMPLE&billing_number=BILLING_NUMBER_EXAMPLE&brand=BRAND_EXAMPLE&terminal_nsu=TERMINAL_NSU_EXAMPLE&authorization_code=AUTHORIZATION_CODE_EXAMPLE&retry_number=RETRY_NUMBER_EXAMPLE&description_detail=DESCRIPTION_DETAIL_EXAMPLE&error_code=ERROR_CODE_EXAMPLE
Alternative payment method (Pix) notifications
Shared query parameters for all events
All Pix transaction events share the query parameters below. These events are 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) |
The following tables list 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 |
The payer and receiver identification parameters depend on the account holder type.
payer_cnpj and receiver_cnpj apply to legal entities. payer_cpf and receiver_cpf apply to individuals.Additional parameters for Denied and Error transaction events
| Query parameters | Description |
|---|---|
| description_detail | (description of the error that occurred during the transaction) |
Pix request examples
An Approved Pix notification:
Texthttps://YOUR_HOST_EXAMPLE/YOUR_PIX_SERVICE_EXAMPLE?payment_type=pix&customer_id=CUSTOMER_ID_EXAMPLE&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=APPROVED&transaction_id=TRANSACTION_ID_EXAMPLE&transaction_timestamp=TRANSACTION_TIMESTAMP_EXAMPLE&terminal_nsu=TERMINAL_NSU_EXAMPLE&payer_psp_name=PAYER_PSP_NAME_EXAMPLE&payer_psp_code=PAYER_PSP_CODE_EXAMPLE&payer_name=PAYER_NAME_EXAMPLE&payer_cpf=PAYER_CPF_EXAMPLE&receiver_psp_name=RECEIVER_PSP_NAME_EXAMPLE&receiver_psp_code=RECEIVER_PSP_CODE_EXAMPLE&receiver_name=RECEIVER_NAME_EXAMPLE&receiver_cnpj=RECEIVER_CNPJ_EXAMPLE
Text1
https://YOUR_HOST_EXAMPLE/YOUR_PIX_SERVICE_EXAMPLE?payment_type=pix&customer_id=CUSTOMER_ID_EXAMPLE&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=APPROVED&transaction_id=TRANSACTION_ID_EXAMPLE&transaction_timestamp=TRANSACTION_TIMESTAMP_EXAMPLE&terminal_nsu=TERMINAL_NSU_EXAMPLE&payer_psp_name=PAYER_PSP_NAME_EXAMPLE&payer_psp_code=PAYER_PSP_CODE_EXAMPLE&payer_name=PAYER_NAME_EXAMPLE&payer_cpf=PAYER_CPF_EXAMPLE&receiver_psp_name=RECEIVER_PSP_NAME_EXAMPLE&receiver_psp_code=RECEIVER_PSP_CODE_EXAMPLE&receiver_name=RECEIVER_NAME_EXAMPLE&receiver_cnpj=RECEIVER_CNPJ_EXAMPLE
A Denied Pix notification. The same structure applies to Error, with
status=ERROR:Texthttps://YOUR_HOST_EXAMPLE/YOUR_PIX_SERVICE_EXAMPLE?payment_type=pix&customer_id=CUSTOMER_ID_EXAMPLE&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=DENIED&transaction_id=TRANSACTION_ID_EXAMPLE&transaction_timestamp=TRANSACTION_TIMESTAMP_EXAMPLE&terminal_nsu=TERMINAL_NSU_EXAMPLE&description_detail=DESCRIPTION_DETAIL_EXAMPLE
Text1
https://YOUR_HOST_EXAMPLE/YOUR_PIX_SERVICE_EXAMPLE?payment_type=pix&customer_id=CUSTOMER_ID_EXAMPLE&order_id=ORDER_ID_EXAMPLE&payment_id=PAYMENT_ID_EXAMPLE&amount=AMOUNT_EXAMPLE&status=DENIED&transaction_id=TRANSACTION_ID_EXAMPLE&transaction_timestamp=TRANSACTION_TIMESTAMP_EXAMPLE&terminal_nsu=TERMINAL_NSU_EXAMPLE&description_detail=DESCRIPTION_DETAIL_EXAMPLE
On this page
Notification callbacks