NuPay via dLocal
This feature is a Private Beta release. Contact Chargebee Support to enable NuPay via dLocal for your live and test sites.
NuPay is a digital wallet in Brazil that customers use to pay from a stored wallet balance or a linked funding source. Chargebee supports NuPay as a payment method through the dLocal payment gateway.
When customers select NuPay at checkout, they are redirected to NuPay to approve the payment and authorize an enrollment. The payment is processed asynchronously, and the transaction stays in a pending state until dLocal confirms the final status through a webhook notification. After the initial authorization, Chargebee stores the enrollment returned by dLocal and uses it for merchant-initiated renewal charges.
Supported countries and currencies
NuPay via dLocal supports the following country and currency. Refer to the dLocal NuPay documentation for the latest details.
| Country | Currency |
|---|---|
| Brazil | BRL |
Chargebee always sends Brazil as the payer country for NuPay transactions, and rejects a NuPay payment intent created in any currency other than BRL.
Payment features and workflows
The following table describes the supported features and behavior for NuPay via dLocal:
| Feature | Description | Supported | Default state | Configuration or behavior |
|---|---|---|---|---|
| Integration sync mode | Defines how payment requests are processed and how statuses are updated. | Yes (asynchronous only) | Asynchronous | dLocal processes NuPay payments asynchronously. Chargebee receives the final status through webhooks. |
| Capture settings | Defines when funds are captured after authorization. | Yes | Auto capture | No configuration required. Auto capture is the only supported option. Manual capture is not available for NuPay. |
| Verification modes | Defines how payment methods are validated before payment. | No | Not applicable | Zero-amount verification is not supported. The customer authorizes the enrollment as part of the first payment, or through a standalone enrollment redirect. |
| Regulatory requirements support | Compliance requirements for the payment method. | Not applicable | Not applicable | Not applicable |
| Statement descriptor | Business name shown in the customer's statement. | No | Not applicable | Chargebee does not send a statement descriptor to dLocal for this method. |
| Chargeback management | Handles disputes and chargebacks. | No | Not applicable | Not supported. Wallet payments are approved by the customer in the NuPay app. |
| Fraud management | Identifies high-risk transactions. | No | Not applicable | Not supported by Chargebee for this method. Risk screening is handled by dLocal and NuPay. |
| Transaction initiation type | Indicates whether the transaction is customer-initiated or merchant-initiated. | Yes | Customer-initiated for the first payment | The first payment is customer-initiated and requires a redirect. Renewals are merchant-initiated and run against the stored enrollment without a redirect. |
| Error intelligence | Provides standardized failure categorization. | Yes | Enabled | No configuration required. |
| Gateway transaction details | Provides raw gateway responses. | Yes | Enabled | Available under Error details on the transaction page. |
| Addition of payment methods in the Chargebee Dashboard | Add a payment method outside a checkout. | No | Not applicable | A merchant cannot add this payment method from the customer record in the Chargebee Dashboard. Use the Create a payment source using permanent token API with the dLocal enrollment ID. The enrollment must already be authorized by the customer. |
| Refunds | Returns funds to the customer's wallet. | Yes | Enabled | Full and partial refunds are supported once the payment is settled. A refund against a pending payment fails. |
| Void | Cancels an authorization before capture. | No | Not applicable | Not supported. Use a refund after the payment settles. |
Prerequisites
Ensure the following before configuring NuPay payments via dLocal:
- A dLocal merchant account with NuPay enabled. Contact the dLocal support team to activate NuPay for your account.
- dLocal is added and configured as a payment gateway in your Chargebee site.
- Your Chargebee site is enabled for BRL collections.
Integration options
You can integrate NuPay via dLocal using the following methods:
| Integration method | Supported |
|---|---|
| Chargebee Checkout | In-app layout of Checkout - Supported Full Page Checkout - Supported |
| Chargebee Self-Serve Portal | Supported. Customers can add or update NuPay as a payment method from the customer portal. |
| Custom Checkout | Payment Components - Supported Chargebee.js (without Payment Components) - Supported API (Payment Intent) - Supported dLocal.js - Not supported |
Supported token formats
Use the following token formats when you build a custom checkout or migrate from another provider:
| Token type | Description | Supported | Token field | Token format |
|---|---|---|---|---|
| Chargebee Payment Intent | Recommended for a custom checkout built with Chargebee.js or Payment Components. | Yes | payment_intent[id] | payment_intent_id |
| Chargebee token | Legacy format. Not recommended for new integrations. | No | Not applicable | Not applicable |
| Gateway permanent token | The dLocal enrollment ID. Used for recurring payments and migrations. | Yes | payment_method[reference_id] | dLocal enrollment ID |
| Gateway temporary token | Short-lived token convertible to a permanent token. | No | Not applicable | Not applicable |
Configure NuPay in Chargebee
Follow these steps to enable NuPay in your Chargebee site:
- Log in to the Chargebee app.
- Go to Settings > Configure Chargebee > Payment Gateways.
- Select the relevant dLocal instance from the list.
- On the Configure dLocal page, turn on NuPay in the list of payment methods.
- Click Apply to save your changes.
Configure Smart Routing
When you enable NuPay through dLocal, Chargebee automatically adds a Smart Routing rule that sends BRL transactions to that dLocal instance, as long as BRL is enabled on your site and no NuPay rule exists for BRL yet. If a rule already points to another gateway, Chargebee does not change it. Edit the rule so that NuPay transactions route to dLocal.
Follow these steps to modify the Smart Routing settings:
-
Go to Settings > Configure Chargebee > Payment Gateways.
-
Click Manage Rules under Smart Routing.
-
Go to the NuPay section and click Add a Gateway or Edit for the BRL currency.
-
Select the dLocal instance that has NuPay enabled from the Choose a payment gateway drop-down menu.
-
Click Save.
Configure webhook notifications
NuPay payment statuses are confirmed asynchronously, so webhook notifications from dLocal are mandatory.
Chargebee registers and manages the dLocal webhook endpoint for your site. You do not need to create the endpoint manually in the dLocal dashboard.
dLocal sends notifications for the following updates, which Chargebee applies to the corresponding record:
| Notification | What Chargebee updates |
|---|---|
| Payment status update | Moves the transaction to success or failure based on the final dLocal payment status. |
| Enrollment status update | Activates, rejects, cancels, or expires the stored NuPay payment method. |
| Refund status update | Marks the refund as complete or failed. |
Checkout flow
Your customer completes the following steps at checkout when paying with NuPay via dLocal:
-
The customer reviews the order on the Your cart page and clicks Proceed to Checkout.
-
The customer enters Account Details, Billing Address, and the document number, selects NuPay, and clicks Pay & Subscribe.
-
The customer is redirected to NuPay and approves the payment and the enrollment in the NuPay app.
-
The customer is redirected back to Chargebee.
-
Chargebee marks the transaction as successful or failed when it receives the status from dLocal, and the order confirmation page appears.
Enable for subscriptions
NuPay supports recurring billing through dLocal enrollments.
- First payment (customer-initiated). Chargebee sends the payment and the enrollment request together. The customer approves both in a single redirect. dLocal creates an on-demand enrollment.
- Stored payment method. Chargebee stores the dLocal enrollment ID as the payment method reference for the customer.
- Renewals (merchant-initiated). Chargebee charges the stored enrollment directly. The customer is not redirected again. The enrollment must be active at dLocal before a renewal can succeed. A merchant-initiated payment against an enrollment that is still pending approval fails.
- Adding the method without a payment. Chargebee can create an enrollment on its own, without a payment. The customer still completes a redirect to authorize it.
- Removing the method. Deleting the payment method in Chargebee cancels the enrollment at dLocal.
Testing in sandbox
Use the dLocal sandbox environment to validate the NuPay flow end to end.
Test payer details:
| Field | Value |
|---|---|
| Country | Brazil (BR) |
| Currency | BRL |
| Document number | 11934254096 |
A sandbox transaction stays pending until the customer completes the redirect and dLocal sends the status notification. Treat that transaction as pending until the notification arrives.
Testing in production
Before going live:
- Confirm that NuPay is enabled in your live dLocal account.
- Confirm that NuPay is turned on for the live dLocal gateway instance in Chargebee, and that Smart Routing sends BRL transactions to that instance.
- Run an end-to-end transaction with a real NuPay wallet, because approval requires the NuPay app.
- Verify that the transaction moves from pending to success after the webhook notification arrives.
- Verify that a renewal against the stored enrollment succeeds without a redirect.
Reconciliation
To reconcile transactions between Chargebee and dLocal:
- Retrieve the id_at_gateway value from the Chargebee transaction details.
- Locate the payment with the same ID in your dLocal reports.
- Match the transactions using this reference to ensure financial consistency.
Error codes and troubleshooting
Open the failed NuPay transaction and check Error details for the dLocal response. Error intelligence categorizes the failure. No additional configuration is required.
FAQs
1. Can customers use NuPay for recurring subscriptions?
Yes. The customer approves an enrollment during the first payment, and Chargebee uses that enrollment to collect renewals without redirecting the customer again.
2. Why is my NuPay transaction still pending?
NuPay is asynchronous. The transaction stays pending until the customer completes the redirect and dLocal sends the final status notification. If a transaction stays pending well beyond the redirect window, the customer most likely abandoned the approval.
3. Can I capture a NuPay payment manually?
No. NuPay supports auto capture only. Manual capture and void are not available.
4. Does the billing address country affect NuPay?
No. Chargebee always sends Brazil as the payer country for NuPay, regardless of the billing address on the customer record.
5. Is the document number mandatory?
Chargebee does not enforce it, but dLocal does. Chargebee sends the document number to dLocal only when the customer provides one. dLocal requires the payer's document (CPF or CNPJ) for NuPay in Brazil, so a payment without it can be rejected by dLocal. Collect the document number at checkout.
Limitations and important points
- NuPay is available only for Brazil and only in BRL.
- Manual capture and void are not supported. Use a refund after the payment settles.
- A refund against a payment that is still pending at dLocal fails.
- A renewal fails if the enrollment has not reached the active state at dLocal.